Module spring.data.elasticsearch

Package org.springframework.data.elasticsearch.core.mapping

Class SimpleElasticsearchPersistentEntity<T>

java.lang.Object

org.springframework.data.mapping.model.BasicPersistentEntity<T,ElasticsearchPersistentProperty>

org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchPersistentEntity<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<ElasticsearchPersistentProperty>, Aware, EnvironmentAware, ElasticsearchPersistentEntity<T>, MutablePersistentEntity<T,ElasticsearchPersistentProperty>, PersistentEntity<T,ElasticsearchPersistentProperty>

public class SimpleElasticsearchPersistentEntity<T>
extends BasicPersistentEntity<T,ElasticsearchPersistentProperty>
implements ElasticsearchPersistentEntity<T>

Elasticsearch specific PersistentEntity implementation holding

Author:

Rizwan Idrees, Mohsin Husen, Mark Paluch, Sascha Woo, Ivan Greene, Peter-Josef Meisch, Roman Puchkovskiy, Subhobrata Dey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleElasticsearchPersistentEntity.ContextConfiguration	Configuration settings passed in from the creating SimpleElasticsearchMappingContext.

Constructor Summary

Constructors

Constructor	Description
SimpleElasticsearchPersistentEntity(TypeInformation<T> typeInformation, SimpleElasticsearchPersistentEntity.ContextConfiguration contextConfiguration)

Method Summary

Modifier and Type	Method	Description
void	addPersistentProperty(ElasticsearchPersistentProperty property)
Dynamic	dynamic()
Set<Alias>	getAliases()	Retrieves the aliases associated with the current entity.
Settings	getDefaultSettings()	returns the default settings for an index.
FieldNamingStrategy	getFieldNamingStrategy()
IndexCoordinates	getIndexCoordinates()
ElasticsearchPersistentProperty	getIndexedIndexNameProperty()
String	getIndexStoreType()
ElasticsearchPersistentProperty	getJoinFieldProperty()	Returns the JoinField property of the ElasticsearchPersistentEntity.
ElasticsearchPersistentProperty	getPersistentPropertyWithFieldName(String fieldName)	returns the ElasticsearchPersistentProperty with the given fieldName (can be set by the Field) annotation.
String	getRefreshInterval()
short	getReplicas()
ElasticsearchPersistentProperty	getSeqNoPrimaryTermProperty()	Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity.
short	getShards()
Document.VersionType	getVersionType()
boolean	hasJoinFieldProperty()	Returns whether the ElasticsearchPersistentEntity has a JoinField property.
boolean	hasSeqNoPrimaryTermProperty()	Returns whether the ElasticsearchPersistentEntity has a SeqNoPrimaryTerm property.
boolean	isAlwaysWriteMapping()
boolean	isCreateIndexAndMapping()
boolean	isUseServerConfiguration()
String	resolveRouting(T bean)	Resolves the routing for a bean.
String	settingPath()
boolean	storeIdInSource()
boolean	storeVersionInSource()
boolean	writeTypeHints()

Methods inherited from class org.springframework.data.mapping.model.BasicPersistentEntity

addAssociation, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getEvaluationContext, getEvaluationContext, getFallbackIsNewStrategy, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getType, getTypeAlias, getTypeInformation, getValueEvaluationContext, getValueEvaluationContext, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, iterator, requiresPropertyPopulation, returnPropertyIfBetterIdPropertyCandidateOrNull, setEnvironment, setEvaluationContextProvider, setPersistentPropertyAccessorFactory, verify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity

getRequiredSeqNoPrimaryTermProperty, getVersionProperty

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.springframework.data.mapping.PersistentEntity

doWithAll, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

Constructor Details

SimpleElasticsearchPersistentEntity

public SimpleElasticsearchPersistentEntity(TypeInformation<T> typeInformation,
 SimpleElasticsearchPersistentEntity.ContextConfiguration contextConfiguration)

Method Details

getIndexCoordinates

public IndexCoordinates getIndexCoordinates()

Specified by:

getIndexCoordinates in interface ElasticsearchPersistentEntity<T>

getAliases

public Set<Alias> getAliases()

Description copied from interface: ElasticsearchPersistentEntity

Retrieves the aliases associated with the current entity.

Specified by:

getAliases in interface ElasticsearchPersistentEntity<T>

Returns:

Returns a set of aliases of the PersistentEntity.

getIndexStoreType

@Nullable
public String getIndexStoreType()

Specified by:

getIndexStoreType in interface ElasticsearchPersistentEntity<T>

getShards

public short getShards()

Specified by:

getShards in interface ElasticsearchPersistentEntity<T>

getReplicas

public short getReplicas()

Specified by:

getReplicas in interface ElasticsearchPersistentEntity<T>

isUseServerConfiguration

public boolean isUseServerConfiguration()

Specified by:

isUseServerConfiguration in interface ElasticsearchPersistentEntity<T>

getRefreshInterval

@Nullable
public String getRefreshInterval()

Specified by:

getRefreshInterval in interface ElasticsearchPersistentEntity<T>

getVersionType

@Nullable
public Document.VersionType getVersionType()

Specified by:

getVersionType in interface ElasticsearchPersistentEntity<T>

isCreateIndexAndMapping

public boolean isCreateIndexAndMapping()

Specified by:

isCreateIndexAndMapping in interface ElasticsearchPersistentEntity<T>

isAlwaysWriteMapping

public boolean isAlwaysWriteMapping()

Specified by:

isAlwaysWriteMapping in interface ElasticsearchPersistentEntity<T>

Returns:

if the mapping should be written to the index on repository bootstrap even if the index already exists.

getFieldNamingStrategy

public FieldNamingStrategy getFieldNamingStrategy()

Specified by:

getFieldNamingStrategy in interface ElasticsearchPersistentEntity<T>

Returns:

the FieldNamingStrategy for the entity

writeTypeHints

public boolean writeTypeHints()

Specified by:

writeTypeHints in interface ElasticsearchPersistentEntity<T>

Returns:

true if type hints on this entity should be written.

storeIdInSource

public boolean storeIdInSource()

Specified by:

storeIdInSource in interface ElasticsearchPersistentEntity<T>

Returns:

the storeIdInSource value from the document annotation

storeVersionInSource

public boolean storeVersionInSource()

Specified by:

storeVersionInSource in interface ElasticsearchPersistentEntity<T>

Returns:

the storeVersionInSource value from the document annotation.

addPersistentProperty

public void addPersistentProperty(ElasticsearchPersistentProperty property)

Specified by:

addPersistentProperty in interface MutablePersistentEntity<T,ElasticsearchPersistentProperty>

Overrides:

addPersistentProperty in class BasicPersistentEntity<T,ElasticsearchPersistentProperty>

getPersistentPropertyWithFieldName

@Nullable
public ElasticsearchPersistentProperty getPersistentPropertyWithFieldName(String fieldName)

Description copied from interface: ElasticsearchPersistentEntity

returns the ElasticsearchPersistentProperty with the given fieldName (can be set by the Field) annotation.

Specified by:

getPersistentPropertyWithFieldName in interface ElasticsearchPersistentEntity<T>

Parameters:

fieldName - to field name for the search, must not be null

Returns:

the found property, otherwise null

hasSeqNoPrimaryTermProperty

public boolean hasSeqNoPrimaryTermProperty()

Description copied from interface: ElasticsearchPersistentEntity

Returns whether the ElasticsearchPersistentEntity has a SeqNoPrimaryTerm property. If this call returns true, ElasticsearchPersistentEntity.getSeqNoPrimaryTermProperty() will return a non-null value.

Specified by:

hasSeqNoPrimaryTermProperty in interface ElasticsearchPersistentEntity<T>

Returns:

false when ElasticsearchPersistentEntity does not define a SeqNoPrimaryTerm property.

hasJoinFieldProperty

public boolean hasJoinFieldProperty()

Description copied from interface: ElasticsearchPersistentEntity

Returns whether the ElasticsearchPersistentEntity has a JoinField property. If this call returns true, ElasticsearchPersistentEntity.getJoinFieldProperty() will return a non-null value.

Specified by:

hasJoinFieldProperty in interface ElasticsearchPersistentEntity<T>

Returns:

false when ElasticsearchPersistentEntity does not define a JoinField property.

getSeqNoPrimaryTermProperty

@Nullable
public ElasticsearchPersistentProperty getSeqNoPrimaryTermProperty()

Description copied from interface: ElasticsearchPersistentEntity

Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity. Can be null in case no such property is available on the entity.

Specified by:

getSeqNoPrimaryTermProperty in interface ElasticsearchPersistentEntity<T>

Returns:

the SeqNoPrimaryTerm ElasticsearchPersistentProperty of the PersistentEntity or null if not defined.

getJoinFieldProperty

@Nullable
public ElasticsearchPersistentProperty getJoinFieldProperty()

Description copied from interface: ElasticsearchPersistentEntity

Returns the JoinField property of the ElasticsearchPersistentEntity. Can be null in case no such property is available on the entity.

Specified by:

getJoinFieldProperty in interface ElasticsearchPersistentEntity<T>

Returns:

the JoinField ElasticsearchPersistentProperty of the PersistentEntity or null if not defined.

getIndexedIndexNameProperty

@Nullable
public ElasticsearchPersistentProperty getIndexedIndexNameProperty()

Specified by:

getIndexedIndexNameProperty in interface ElasticsearchPersistentEntity<T>

Returns:

the property annotated with IndexedIndexName if it exists, otherwise null

resolveRouting

@Nullable
public String resolveRouting(T bean)

Description copied from interface: ElasticsearchPersistentEntity

Resolves the routing for a bean.

Specified by:

resolveRouting in interface ElasticsearchPersistentEntity<T>

Parameters:

bean - the bean to resolve the routing for

Returns:

routing value, may be null

settingPath

public String settingPath()

Specified by:

settingPath in interface ElasticsearchPersistentEntity<T>

getDefaultSettings

public Settings getDefaultSettings()

Description copied from interface: ElasticsearchPersistentEntity

returns the default settings for an index.

Specified by:

getDefaultSettings in interface ElasticsearchPersistentEntity<T>

Returns:

settings

dynamic

public Dynamic dynamic()

Specified by:

dynamic in interface ElasticsearchPersistentEntity<T>

Returns:

the dynamic mapping parameter value.