sirius.db.es

Class ElasticEntity

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<String>

sirius.db.es.ElasticEntity

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

public abstract class ElasticEntity
extends BaseEntity<String>

Represents the base class for all entities which are managed via Elastic and stored in Elasticsearch.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Elastic	elastic
static Mapping	ID Contains the ID which is auto-generated when inserting a new entity into Elasticsearch.

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

mango, oma

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
ElasticEntity()

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the id of the entity.
<E extends BaseEntity<?>,C extends Constraint,Q extends Query<Q,E,C>> BaseMapper<E,C,Q>	getMapper() Provides the mapper which is used to actually manage the entity.
protected boolean	isUnique(Mapping field, Object value, Mapping... within) Determines if the given value in the given field is unique within the given side constraints.
protected void	setId(String id) Note that only the framework must use this to specify the ID of the entity.

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, equals, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, hashCode, isAnyMappingChanged, isChanged, isNew, setVersion, toString

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

elastic

protected static Elastic elastic

ID

public static final Mapping ID

Contains the ID which is auto-generated when inserting a new entity into Elasticsearch.

It is NullAllowed as it is filled during the update but after the save checkes have completed.

Constructor Detail

ElasticEntity

public ElasticEntity()

Method Detail

isUnique

protected boolean isUnique(Mapping field,
                           Object value,
                           Mapping... within)

Description copied from class: BaseEntity

Determines if the given value in the given field is unique within the given side constraints.

Specified by:

isUnique in class BaseEntity<String>

Parameters:

field - the field to check

value - the value to be unique

within - the side constraints within the value must be unique

Returns:

true if the given field is unique, false otherwise

getMapper

public <E extends BaseEntity<?>,C extends Constraint,Q extends Query<Q,E,C>> BaseMapper<E,C,Q> getMapper()

Description copied from class: BaseEntity

Provides the mapper which is used to actually manage the entity.

Specified by:

getMapper in class BaseEntity<String>

Type Parameters:

E - the entity type of the mapper

Q - the query type of the mapper

Returns:

the mapper which is in charge of this entity.

getId

public String getId()

Description copied from class: BaseEntity

Returns the id of the entity.

Specified by:

getId in class BaseEntity<String>

Returns:

the id of the entity

setId

protected void setId(String id)

Note that only the framework must use this to specify the ID of the entity.

Parameters:

id - the id of this entity