at.molindo.esi4j.core

Interface Esi4J

All Known Implementing Classes:

DefaultEsi4J

public interface Esi4J

Facade for elasticsearch integration. Usually only one instance per application.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLIENT default client name used in settings (prefix "esi4j.client." + "default")
static String	DEFAULT_INDEX default index name used for getIndex()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close this instance an all its indexes, stores, modules, clients, ...
Esi4JIndex	findIndex(Class<?> type)
Esi4JManagedIndex	findMultiIndex(Class<?>... types)
Esi4JManagedIndex	findMultiIndex(List<Class<? extends Object>> types)
Esi4JIndex	getIndex()
Esi4JIndex	getIndex(String name)
Esi4JManagedIndex	getMultiIndex(List<String> names)
Esi4JManagedIndex	getMultiIndex(String... names)
void	registerIndexManger(Esi4JIndexManager indexManager)

Field Detail

DEFAULT_INDEX

static final String DEFAULT_INDEX

default index name used for getIndex()

See Also:

Constant Field Values

DEFAULT_CLIENT

static final String DEFAULT_CLIENT

default client name used in settings (prefix "esi4j.client." + "default")

See Also:

Constant Field Values

Method Detail

getIndex

Esi4JIndex getIndex()

Returns:

the default index

Throws:

IllegalStateException - if default index isn't configured

See Also:

DEFAULT_INDEX

getIndex

Esi4JIndex getIndex(String name)

Returns:

the index with given name

Throws:

IllegalStateException - if index with given name isn't configured

findIndex

Esi4JIndex findIndex(Class<?> type)

Throws:

ClassCastException - if type is mapped to multiple indexes

See Also:

findMultiIndex(Class...)

getMultiIndex

Esi4JManagedIndex getMultiIndex(String... names)

See Also:

getMultiIndex(List)

getMultiIndex

Esi4JManagedIndex getMultiIndex(List<String> names)

Parameters:

names -

Returns:

Esi4JSearchIndex spanning all named indexes

findMultiIndex

Esi4JManagedIndex findMultiIndex(Class<?>... types)

See Also:

findMultiIndex(List)

findMultiIndex

Esi4JManagedIndex findMultiIndex(List<Class<? extends Object>> types)

Parameters:

types -

Returns:

an Esi4JSearchIndex spanning all indexes with given types

registerIndexManger

void registerIndexManger(Esi4JIndexManager indexManager)

close

void close()

close this instance an all its indexes, stores, modules, clients, ...