at.molindo.esi4j.mapping

Class TypeMapping

java.lang.Object

at.molindo.esi4j.mapping.TypeMapping

Direct Known Subclasses:

GenericTypeMapping

public abstract class TypeMapping
extends Object

base class for mappings from type to elasticsearch representation

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_ID
static String	FIELD_INDEX
static String	FIELD_TYPE
static String	FIELD_VERSION

Constructor Summary

Constructors

Constructor and Description
TypeMapping(String typeAlias) creates a TypeMapping for given alias and class.

Method Summary

Methods

Modifier and Type	Method and Description
org.elasticsearch.action.delete.DeleteRequestBuilder	deleteRequest(org.elasticsearch.client.Client client, String indexName, Object o)
org.elasticsearch.action.delete.DeleteRequestBuilder	deleteRequest(org.elasticsearch.client.Client client, String indexName, String id, Long version)
org.elasticsearch.action.delete.DeleteRequest	deleteRequest(String indexName, Object o)
org.elasticsearch.action.delete.DeleteRequest	deleteRequest(String indexName, String id, Long version)
abstract Object	getId(Object o)
abstract Class<?>	getIdClass()
String	getIdString(Object o)
abstract MappingSource	getMappingSource()
abstract ObjectSource	getObjectSource(Object o)
String	getTypeAlias()
abstract Class<?>	getTypeClass()
abstract Long	getVersion(Object o) gets version from object or null if not versioned
org.elasticsearch.action.index.IndexRequestBuilder	indexRequest(org.elasticsearch.client.Client client, String indexName, Object o)
org.elasticsearch.action.index.IndexRequest	indexRequest(String indexName, Object o)
boolean	isFiltered(Object o) Simple filtering of entities.
abstract boolean	isVersioned()
abstract Object	read(org.elasticsearch.action.get.GetResponse response)
abstract Object	read(org.elasticsearch.search.SearchHit hit)
abstract Object	toId(String id)
abstract String	toIdString(Object id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_INDEX

public static final String FIELD_INDEX

See Also:

Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_VERSION

public static final String FIELD_VERSION

See Also:

Constant Field Values

Constructor Detail

TypeMapping

public TypeMapping(String typeAlias)

creates a TypeMapping for given alias and class. Both, alias and class must be unique per index.

Method Detail

getTypeAlias

public String getTypeAlias()

Returns:

the mapping's alias which translates directly to an elasticsearch type

getTypeClass

public abstract Class<?> getTypeClass()

getIdClass

public abstract Class<?> getIdClass()

isFiltered

public boolean isFiltered(@Nonnull
                 Object o)

Simple filtering of entities. esi4j core library will always respect this filtering when working with mapped objects. Users are still free to persist entities anyway.

Returns:

true if entity must not be persisted to index

isVersioned

public abstract boolean isVersioned()

Returns:

true if all object's of mapped type are supposed to be versioned. Note that it isn't required to call this method before getVersion(Object)

getId

public abstract Object getId(@Nonnull
           Object o)

Returns:

the object's id

See Also:

#setId(Object, Object)

getIdString

public final String getIdString(@Nonnull
                 Object o)

Returns:

the object's id as a string suitable for elasticsearch

See Also:

getId(Object), toIdString(Object)

toIdString

public abstract String toIdString(@Nonnull
                Object id)

Returns:

convert id to a string representation suitable for elasticsearch. never null if id is not null

See Also:

toId(String)

toId

public abstract Object toId(@Nonnull
          String id)

Returns:

convert string representation suitable for elasticsearch to id

See Also:

toIdString(Object)

getVersion

public abstract Long getVersion(Object o)

gets version from object or null if not versioned

getMappingSource

public abstract MappingSource getMappingSource()

Returns:

a new MappingSource for this type

getObjectSource

public abstract ObjectSource getObjectSource(Object o)

Returns:

a new ObjectSource for this object

read

@CheckForNull
public abstract Object read(org.elasticsearch.action.get.GetResponse response)

Returns:

the object returned by a GetResponse or null if not applicable or doc doesn't exist

read

@CheckForNull
public abstract Object read(org.elasticsearch.search.SearchHit hit)

Returns:

the object returned by a SearchHit or null if not applicable

indexRequest

@CheckForNull
public final org.elasticsearch.action.index.IndexRequestBuilder indexRequest(org.elasticsearch.client.Client client,
                                                                           String indexName,
                                                                           Object o)

Returns:

null if object is filtered

indexRequest

@CheckForNull
public final org.elasticsearch.action.index.IndexRequest indexRequest(String indexName,
                                                                    Object o)

Returns:

null if object is filtered

deleteRequest

@CheckForNull
public final org.elasticsearch.action.delete.DeleteRequest deleteRequest(String indexName,
                                                                       Object o)

Returns:

null if object doesn't have an id

deleteRequest

@CheckForNull
public final org.elasticsearch.action.delete.DeleteRequest deleteRequest(String indexName,
                                                                       String id,
                                                                       Long version)

Returns:

null if object doesn't have an id

deleteRequest

@CheckForNull
public final org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequest(org.elasticsearch.client.Client client,
                                                                              String indexName,
                                                                              Object o)

Returns:

null if object doesn't have an id

deleteRequest

@CheckForNull
public final org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequest(org.elasticsearch.client.Client client,
                                                                              String indexName,
                                                                              String id,
                                                                              Long version)

Returns:

null if object doesn't have an id