Module spring.data.elasticsearch

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

Interface ElasticsearchPersistentEntity<T>

All Superinterfaces:

Iterable<ElasticsearchPersistentProperty>, PersistentEntity<T,ElasticsearchPersistentProperty>

All Known Implementing Classes:

SimpleElasticsearchPersistentEntity

public interface ElasticsearchPersistentEntity<T>
extends PersistentEntity<T,ElasticsearchPersistentProperty>

ElasticsearchPersistentEntity

Author:

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

Method Summary

Modifier and Type	Method	Description
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()
default ElasticsearchPersistentProperty	getRequiredSeqNoPrimaryTermProperty()	Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity or throws an IllegalStateException in case no such property is available on the entity.
ElasticsearchPersistentProperty	getSeqNoPrimaryTermProperty()	Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity.
short	getShards()
ElasticsearchPersistentProperty	getVersionProperty()
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 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

Method Details

getIndexCoordinates

IndexCoordinates getIndexCoordinates()

getAliases

Set<Alias> getAliases()

Retrieves the aliases associated with the current entity.

Returns:

Returns a set of aliases of the PersistentEntity.

Since:

5.4

getShards

short getShards()

getReplicas

short getReplicas()

isUseServerConfiguration

boolean isUseServerConfiguration()

getRefreshInterval

@Nullable
String getRefreshInterval()

getIndexStoreType

@Nullable
String getIndexStoreType()

getVersionProperty

ElasticsearchPersistentProperty getVersionProperty()

Specified by:

getVersionProperty in interface PersistentEntity<T,ElasticsearchPersistentProperty>

settingPath

@Nullable
String settingPath()

getVersionType

@Nullable
Document.VersionType getVersionType()

isCreateIndexAndMapping

boolean isCreateIndexAndMapping()

getPersistentPropertyWithFieldName

@Nullable
ElasticsearchPersistentProperty getPersistentPropertyWithFieldName(String fieldName)

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

Parameters:

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

Returns:

the found property, otherwise null

Since:

4.0

hasSeqNoPrimaryTermProperty

boolean hasSeqNoPrimaryTermProperty()

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

Returns:

false when ElasticsearchPersistentEntity does not define a SeqNoPrimaryTerm property.

Since:

4.0

hasJoinFieldProperty

boolean hasJoinFieldProperty()

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

Returns:

false when ElasticsearchPersistentEntity does not define a JoinField property.

Since:

4.1

getSeqNoPrimaryTermProperty

@Nullable
ElasticsearchPersistentProperty getSeqNoPrimaryTermProperty()

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

Returns:

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

Since:

4.0

getJoinFieldProperty

@Nullable
ElasticsearchPersistentProperty getJoinFieldProperty()

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

Returns:

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

Since:

4.1

getRequiredSeqNoPrimaryTermProperty

default ElasticsearchPersistentProperty getRequiredSeqNoPrimaryTermProperty()

Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity or throws an IllegalStateException in case no such property is available on the entity.

Returns:

the SeqNoPrimaryTerm ElasticsearchPersistentProperty of the PersistentEntity.

Since:

4.0

getIndexedIndexNameProperty

@Nullable
ElasticsearchPersistentProperty getIndexedIndexNameProperty()

Returns:

the property annotated with IndexedIndexName if it exists, otherwise null

Since:

5.1

getDefaultSettings

Settings getDefaultSettings()

returns the default settings for an index.

Returns:

settings

Since:

4.1

resolveRouting

@Nullable
String resolveRouting(T bean)

Resolves the routing for a bean.

Parameters:

bean - the bean to resolve the routing for

Returns:

routing value, may be null

getFieldNamingStrategy

FieldNamingStrategy getFieldNamingStrategy()

Returns:

the FieldNamingStrategy for the entity

Since:

4.3

writeTypeHints

boolean writeTypeHints()

Returns:

true if type hints on this entity should be written.

Since:

4.3

dynamic

Dynamic dynamic()

Returns:

the dynamic mapping parameter value.

Since:

4.3

storeIdInSource

boolean storeIdInSource()

Returns:

the storeIdInSource value from the document annotation

Since:

5.1

storeVersionInSource

boolean storeVersionInSource()

Returns:

the storeVersionInSource value from the document annotation.

Since:

5.1

isAlwaysWriteMapping

boolean isAlwaysWriteMapping()

Returns:

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

Since:

5.2