org.springframework.data.elasticsearch.core.mapping

Interface ElasticsearchPersistentProperty

All Superinterfaces:

PersistentProperty<ElasticsearchPersistentProperty>

All Known Implementing Classes:

SimpleElasticsearchPersistentProperty

public interface ElasticsearchPersistentProperty
extends PersistentProperty<ElasticsearchPersistentProperty>

ElasticsearchPersistentProperty

Author:

Rizwan Idrees, Mohsin Husen, Sascha Woo, Oliver Gierke, Peter-Josef Meisch, Roman Puchkovskiy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ElasticsearchPersistentProperty.PropertyToFieldNameConverter
static class	ElasticsearchPersistentProperty.QueryPropertyToFieldNameConverter when building CriteriaQueries use the name; the fieldname is set later with ElasticsearchConverter.

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Returns the name to be used to store the property in the document.
ElasticsearchPersistentPropertyConverter	getPropertyConverter()
boolean	hasPropertyConverter()
boolean	isParentProperty() Returns whether the current property is a potential parent property of the owning ElasticsearchPersistentEntity.
boolean	isReadable() Returns true if the property may be read.
boolean	isScoreProperty() Deprecated. since 4.0, use SearchHit.getScore() instead
boolean	isSeqNoPrimaryTermProperty() Returns whether the current property is a SeqNoPrimaryTerm property.

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

findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypes, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isImmutable, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess

Method Detail

getFieldName

String getFieldName()

Returns the name to be used to store the property in the document.

Returns:

isScoreProperty

@Deprecated
boolean isScoreProperty()

Deprecated. since 4.0, use SearchHit.getScore() instead

Returns whether the current property is a potential score property of the owning ElasticsearchPersistentEntity. This method is mainly used by ElasticsearchPersistentEntity implementation to discover score property candidates on ElasticsearchPersistentEntity creation you should rather call ElasticsearchPersistentEntity.getScoreProperty() to determine whether the current property is the score property of that ElasticsearchPersistentEntity under consideration.

Returns:

Since:

3.1

isParentProperty

boolean isParentProperty()

Returns whether the current property is a potential parent property of the owning ElasticsearchPersistentEntity. This method is mainly used by ElasticsearchPersistentEntity implementation to discover parent property candidates on ElasticsearchPersistentEntity creation you should rather call ElasticsearchPersistentEntity.getScoreProperty() to determine whether the current property is the parent property of that ElasticsearchPersistentEntity under consideration.

Returns:

Since:

3.1

isSeqNoPrimaryTermProperty

boolean isSeqNoPrimaryTermProperty()

Returns whether the current property is a SeqNoPrimaryTerm property.

Returns:

true if the type is SeqNoPrimaryTerm

Since:

4.0

hasPropertyConverter

boolean hasPropertyConverter()

Returns:

true if an ElasticsearchPersistentPropertyConverter is available for this instance.

Since:

4.0

getPropertyConverter

@Nullable
ElasticsearchPersistentPropertyConverter getPropertyConverter()

Returns:

the ElasticsearchPersistentPropertyConverter for this instance.

Since:

4.0

isReadable

boolean isReadable()

Returns true if the property may be read.

Returns:

true if readable, false otherwise

Since:

4.0