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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ElasticsearchPersistentProperty.PropertyToFieldNameConverter

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Returns the name to be used to store the property in the document.
boolean	isParentProperty() Returns whether the current property is a potential parent property of the owning ElasticsearchPersistentEntity.
boolean	isScoreProperty() Returns whether the current property is a potential score property of the owning ElasticsearchPersistentEntity.

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

findAnnotation, findPropertyOrOwnerAnnotation, 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

boolean isScoreProperty()

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#isScoreProperty(PersistentProperty) 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#isParentProperty() to determine whether the current property is the parent property of that ElasticsearchPersistentEntity under consideration.

Returns:

Since:

3.1