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 ClassesModifier and TypeInterfaceDescriptionstatic enum
static enum
when building CriteriaQueries use the name; the fieldname is set later withElasticsearchConverter
. -
Method Summary
Modifier and TypeMethodDescriptiondefault Class<?>
callsPersistentProperty.getActualType()
but returns null when an exception is thrownReturns the name to be used to store the property in the document.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
Returns true if the property may be read from the store into the entity.boolean
Returns whether the current property is aSeqNoPrimaryTerm
property.boolean
boolean
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, isIdProperty, isImmutable, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess
-
Method Details
-
getFieldName
String getFieldName()Returns the name to be used to store the property in the document.- Returns:
-
hasExplicitFieldName
boolean hasExplicitFieldName()- Returns:
- true if the field name comes from an explicit value in the field annotation
- Since:
- 5.1
-
isSeqNoPrimaryTermProperty
boolean isSeqNoPrimaryTermProperty()Returns whether the current property is aSeqNoPrimaryTerm
property.- Returns:
- true if the type is
SeqNoPrimaryTerm
- Since:
- 4.0
-
hasPropertyValueConverter
boolean hasPropertyValueConverter()- Returns:
- true if an
PropertyValueConverter
is available for this instance. - Since:
- 4.0
-
getPropertyValueConverter
- Returns:
- the
PropertyValueConverter
for this instance. - Since:
- 4.0
-
isReadable
boolean isReadable()Returns true if the property may be read from the store into the entity.- Returns:
- true if readable, false otherwise
- Since:
- 4.0
-
storeNullValue
boolean storeNullValue()- Returns:
- true if null values should be stored in Elasticsearch
- Since:
- 4.1
-
storeEmptyValue
boolean storeEmptyValue()- Returns:
- true if empty values ({
String
}, or {Collection
} or {Map
}) should be store in Elasticsearch. - Since:
- 5.1
-
isGeoPointProperty
boolean isGeoPointProperty()- Returns:
- true if this is a GeoPoint property
- Since:
- 4.1
-
isGeoShapeProperty
boolean isGeoShapeProperty()- Returns:
- true if this is a GeoShape property
- Since:
- 4.1
-
isJoinFieldProperty
boolean isJoinFieldProperty()- Returns:
- true if this is a JoinField property
- Since:
- 4.1
-
isCompletionProperty
boolean isCompletionProperty()- Returns:
- true if this is a Completion property
- Since:
- 4.1
-
isIndexedIndexNameProperty
boolean isIndexedIndexNameProperty()- Returns:
- true if this is a property annotated with
IndexedIndexName
. - Since:
- 5.1
-
getActualTypeOrNull
callsPersistentProperty.getActualType()
but returns null when an exception is thrown- Since:
- 4.1
-