at.molindo.esi4j.mapping.impl

Class GenericTypeMapping<Type,Id>

java.lang.Object

at.molindo.esi4j.mapping.TypeMapping

at.molindo.esi4j.mapping.impl.GenericTypeMapping<Type,Id>

Type Parameters:

Type - class of mapped type

Id - class of mapped type's ID

Direct Known Subclasses:

AbstractTypeMapping

public abstract class GenericTypeMapping<Type,Id>
extends TypeMapping

generic version of TypeMapping. All subclasses should extend this class instead of TypeMapping while it's generally better to use TypeMapping where the exact type of mapping is not known or not relevant

Field Summary

Fields inherited from class at.molindo.esi4j.mapping.TypeMapping

FIELD_ID, FIELD_INDEX, FIELD_TYPE, FIELD_VERSION

Constructor Summary

Constructors

Constructor and Description
GenericTypeMapping(String typeAlias, Class<Type> typeClass, Class<Id> idClass)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	buildMapping(org.elasticsearch.index.mapper.object.RootObjectMapper.Builder mapperBuilder)
protected Type	cast(Object o)
protected Id	castId(Object o)
protected boolean	filter(Type o)
org.elasticsearch.common.xcontent.XContentBuilder	getContentBuilder(Object o) public for testing.
Id	getId(Object o)
Class<Id>	getIdClass()
MappingSource	getMappingSource(org.elasticsearch.common.settings.Settings settings)
ObjectWriteSource	getObjectSource(Object o)
Class<Type>	getTypeClass()
Long	getVersion(Object o) gets version from object or null if not versioned
protected abstract Id	id(Type o) get Id from object
boolean	isDynamicMapping()
boolean	isFiltered(Object entity) Simple filtering of entities.
com.google.common.collect.ImmutableMap<String,Object>	meta()
abstract Type	read(Map<String,Object> source) read object from source.
Object	read(ObjectReadSource source)
abstract Id	toId(String id)
String	toIdString(Object id)
abstract String	toString(Id id)
protected abstract Long	version(Type o) get version from object
void	write(org.elasticsearch.common.xcontent.XContentBuilder contentBuilder, Object o)
protected abstract void	writeObject(org.elasticsearch.common.xcontent.XContentBuilder contentBuilder, Type o)

Methods inherited from class at.molindo.esi4j.mapping.TypeMapping

deleteBuilderRequest, deleteBuilderRequest, deleteRequest, deleteRequest, getIdString, getTypeAlias, indexBuilderRequest, indexRequest, isVersioned

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTypeMapping

public GenericTypeMapping(String typeAlias,
                  Class<Type> typeClass,
                  Class<Id> idClass)

Method Detail

getMappingSource

public final MappingSource getMappingSource(org.elasticsearch.common.settings.Settings settings)

Specified by:

getMappingSource in class TypeMapping

Returns:

a new MappingSource for this type

isDynamicMapping

public boolean isDynamicMapping()

Returns:

true if mapping must not be cached

meta

public com.google.common.collect.ImmutableMap<String,Object> meta()

getObjectSource

public ObjectWriteSource getObjectSource(Object o)

Specified by:

getObjectSource in class TypeMapping

Returns:

a new ObjectWriteSource for this object

getContentBuilder

public final org.elasticsearch.common.xcontent.XContentBuilder getContentBuilder(Object o)
                                                                          throws IOException

public for testing.

Returns:

a JsonXContent builder

Throws:

IOException

write

public final void write(org.elasticsearch.common.xcontent.XContentBuilder contentBuilder,
         Object o)
                 throws IOException

Throws:

IOException

getTypeClass

public Class<Type> getTypeClass()

Specified by:

getTypeClass in class TypeMapping

getIdClass

public Class<Id> getIdClass()

Specified by:

getIdClass in class TypeMapping

cast

protected Type cast(Object o)

castId

protected Id castId(Object o)

isFiltered

public final boolean isFiltered(Object entity)

Description copied from class: TypeMapping

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.

Overrides:

isFiltered in class TypeMapping

Returns:

true if entity must not be persisted to index

getId

public final Id getId(Object o)

Specified by:

getId in class TypeMapping

Returns:

the object's id

See Also:

#setId(Object, Object)

getVersion

public Long getVersion(Object o)

Description copied from class: TypeMapping

gets version from object or null if not versioned

Specified by:

getVersion in class TypeMapping

filter

protected boolean filter(Type o)

toIdString

public final String toIdString(Object id)

Specified by:

toIdString in class TypeMapping

Returns:

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

See Also:

TypeMapping.toId(String)

toString

public abstract String toString(Id id)

toId

public abstract Id toId(String id)

Specified by:

toId in class TypeMapping

Returns:

convert string representation suitable for elasticsearch to id

See Also:

TypeMapping.toIdString(Object)

id

protected abstract Id id(Type o)

get Id from object

See Also:

getId(Object)

version

protected abstract Long version(Type o)

get version from object

See Also:

getVersion(Object)

buildMapping

protected abstract void buildMapping(org.elasticsearch.index.mapper.object.RootObjectMapper.Builder mapperBuilder)
                              throws IOException

Throws:

IOException

writeObject

protected abstract void writeObject(org.elasticsearch.common.xcontent.XContentBuilder contentBuilder,
               Type o)
                             throws IOException

Throws:

IOException

read

public Object read(ObjectReadSource source)

Specified by:

read in class TypeMapping

Returns:

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

read

public abstract Type read(Map<String,Object> source)

read object from source. Publicly accessible for testing