Package 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	Description
SimpleElasticsearchPersistentProperty(Property property, PersistentEntity<?,ElasticsearchPersistentProperty> owner, SimpleTypeHolder simpleTypeHolder)

Method Summary

Modifier and Type	Method	Description
protected Association<ElasticsearchPersistentProperty>	createAssociation()
String	getFieldName()	Returns the name to be used to store the property in the document.
PropertyValueConverter	getPropertyValueConverter()
boolean	hasExplicitFieldName()
boolean	hasPropertyValueConverter()
boolean	isCompletionProperty()
boolean	isGeoPointProperty()
boolean	isGeoShapeProperty()
boolean	isIdProperty()
boolean	isIndexedIndexNameProperty()
boolean	isJoinFieldProperty()
boolean	isReadable()	Returns true if the property may be read from the store into the entity.
boolean	isSeqNoPrimaryTermProperty()	Returns whether the current property is a SeqNoPrimaryTerm property.
boolean	isWritable()
boolean	storeEmptyValue()
boolean	storeNullValue()

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

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

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

equals, getActualType, getActualTypeInformation, getAssociation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, getProperty, getRawType, getSetter, getType, getTypeInformation, getWither, hashCode, isArray, isCollectionLike, isEntity, isImmutable, 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, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isImmutable, isMap, isTransient, isVersionProperty, usePropertyAccess

Constructor Details

SimpleElasticsearchPersistentProperty

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

Method Details

hasPropertyValueConverter

public boolean hasPropertyValueConverter()

Specified by:

hasPropertyValueConverter in interface ElasticsearchPersistentProperty

Returns:

true if an PropertyValueConverter is available for this instance.

getPropertyValueConverter

@Nullable
public PropertyValueConverter getPropertyValueConverter()

Specified by:

getPropertyValueConverter in interface ElasticsearchPersistentProperty

Returns:

the PropertyValueConverter 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 from the store into the entity.

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

storeEmptyValue

public boolean storeEmptyValue()

Specified by:

storeEmptyValue in interface ElasticsearchPersistentProperty

Returns:

true if empty values ({String}, or {Collection} or {Map}) should be store in Elasticsearch.

hasExplicitFieldName

public boolean hasExplicitFieldName()

Specified by:

hasExplicitFieldName in interface ElasticsearchPersistentProperty

Returns:

true if the field name comes from an explicit value in the field annotation

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>

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

isIndexedIndexNameProperty

public boolean isIndexedIndexNameProperty()

Specified by:

isIndexedIndexNameProperty in interface ElasticsearchPersistentProperty

Returns:

true if this is a property annotated with IndexedIndexName.