org.springframework.data.elasticsearch.core.mapping

Class SimpleElasticsearchPersistentProperty

java.lang.Object

org.springframework.data.mapping.model.AbstractPersistentProperty<P>

org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<ElasticsearchPersistentProperty>

org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchPersistentProperty

All Implemented Interfaces:

ElasticsearchPersistentProperty, PersistentProperty<ElasticsearchPersistentProperty>

public class SimpleElasticsearchPersistentProperty
extends AnnotationBasedPersistentProperty<ElasticsearchPersistentProperty>
implements ElasticsearchPersistentProperty

Elasticsearch specific PersistentProperty implementation processing

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty

ElasticsearchPersistentProperty.PropertyToFieldNameConverter, ElasticsearchPersistentProperty.QueryPropertyToFieldNameConverter

Constructor Summary

Constructors

Constructor and Description
SimpleElasticsearchPersistentProperty(Property property, PersistentEntity<?,ElasticsearchPersistentProperty> owner, SimpleTypeHolder simpleTypeHolder)

Method Summary

Modifier and Type	Method and Description
protected Association<ElasticsearchPersistentProperty>	createAssociation()
String	getFieldName() Returns the name to be used to store the property in the document.
ElasticsearchPersistentPropertyConverter	getPropertyConverter()
boolean	hasPropertyConverter()
boolean	isCompletionProperty()
boolean	isGeoPointProperty()
boolean	isGeoShapeProperty()
boolean	isIdProperty()
boolean	isImmutable()
boolean	isJoinFieldProperty()
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() Returns whether the current property is a potential score property of the owning ElasticsearchPersistentEntity.
boolean	isSeqNoPrimaryTermProperty() Returns whether the current property is a SeqNoPrimaryTerm property.
boolean	isWritable()
boolean	storeNullValue()

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

findAnnotation, findPropertyOrOwnerAnnotation, getAssociationTargetType, getSpelExpression, isAnnotationPresent, isAssociation, isTransient, isVersionProperty, toString, usePropertyAccess

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

equals, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypes, getProperty, getRawType, getSetter, getType, getTypeInformation, getWither, hashCode, isArray, isCollectionLike, isEntity, isMap

Methods inherited from class java.lang.Object

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

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

getActualTypeOrNull

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, isMap, isTransient, isVersionProperty, usePropertyAccess

Constructor Detail

SimpleElasticsearchPersistentProperty

public SimpleElasticsearchPersistentProperty(Property property,
                                             PersistentEntity<?,ElasticsearchPersistentProperty> owner,
                                             SimpleTypeHolder simpleTypeHolder)

Method Detail

hasPropertyConverter

public boolean hasPropertyConverter()

Specified by:

hasPropertyConverter in interface ElasticsearchPersistentProperty

Returns:

true if an ElasticsearchPersistentPropertyConverter is available for this instance.

getPropertyConverter

@Nullable
public ElasticsearchPersistentPropertyConverter getPropertyConverter()

Specified by:

getPropertyConverter in interface ElasticsearchPersistentProperty

Returns:

the ElasticsearchPersistentPropertyConverter for this instance.

isWritable

public boolean isWritable()

Specified by:

isWritable in interface PersistentProperty<ElasticsearchPersistentProperty>

Overrides:

isWritable in class AnnotationBasedPersistentProperty<ElasticsearchPersistentProperty>

isReadable

public boolean isReadable()

Description copied from interface: ElasticsearchPersistentProperty

Returns true if the property may be read.

Specified by:

isReadable in interface ElasticsearchPersistentProperty

Returns:

true if readable, false otherwise

storeNullValue

public boolean storeNullValue()

Specified by:

storeNullValue in interface ElasticsearchPersistentProperty

Returns:

true if null values should be stored in Elasticsearch

getFieldName

public String getFieldName()

Description copied from interface: ElasticsearchPersistentProperty

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

Specified by:

getFieldName in interface ElasticsearchPersistentProperty

Returns:

isIdProperty

public boolean isIdProperty()

Specified by:

isIdProperty in interface PersistentProperty<ElasticsearchPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<ElasticsearchPersistentProperty>

createAssociation

protected Association<ElasticsearchPersistentProperty> createAssociation()

Specified by:

createAssociation in class AbstractPersistentProperty<ElasticsearchPersistentProperty>

isScoreProperty

public boolean isScoreProperty()

Description copied from interface: ElasticsearchPersistentProperty

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.

Specified by:

isScoreProperty in interface ElasticsearchPersistentProperty

Returns:

isImmutable

public boolean isImmutable()

Specified by:

isImmutable in interface PersistentProperty<ElasticsearchPersistentProperty>

Overrides:

isImmutable in class AbstractPersistentProperty<ElasticsearchPersistentProperty>

isParentProperty

public boolean isParentProperty()

Description copied from interface: ElasticsearchPersistentProperty

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.

Specified by:

isParentProperty in interface ElasticsearchPersistentProperty

Returns:

isSeqNoPrimaryTermProperty

public boolean isSeqNoPrimaryTermProperty()

Description copied from interface: ElasticsearchPersistentProperty

Returns whether the current property is a SeqNoPrimaryTerm property.

Specified by:

isSeqNoPrimaryTermProperty in interface ElasticsearchPersistentProperty

Returns:

true if the type is SeqNoPrimaryTerm

isGeoPointProperty

public boolean isGeoPointProperty()

Specified by:

isGeoPointProperty in interface ElasticsearchPersistentProperty

Returns:

true if this is a GeoPoint property

isGeoShapeProperty

public boolean isGeoShapeProperty()

Specified by:

isGeoShapeProperty in interface ElasticsearchPersistentProperty

Returns:

true if this is a GeoShape property

isJoinFieldProperty

public boolean isJoinFieldProperty()

Specified by:

isJoinFieldProperty in interface ElasticsearchPersistentProperty

Returns:

true if this is a JoinField property

isCompletionProperty

public boolean isCompletionProperty()

Specified by:

isCompletionProperty in interface ElasticsearchPersistentProperty

Returns:

true if this is a Completion property