public interface MongoPersistentProperty extends PersistentProperty<MongoPersistentProperty>
PersistentProperty
extension.Modifier and Type | Interface and Description |
---|---|
static class |
MongoPersistentProperty.PropertyToFieldNameConverter
Simple
Converter implementation to transform a MongoPersistentProperty into its field name. |
Modifier and Type | Method and Description |
---|---|
DBRef |
getDBRef()
Returns the
DBRef if the property is a reference. |
DocumentReference |
getDocumentReference()
Returns the
DocumentReference if the property is a reference. |
String |
getFieldName()
Returns the name of the field a property is persisted to.
|
int |
getFieldOrder()
Returns the order of the field if defined.
|
Class<?> |
getFieldType()
Returns the
Java FieldType of the field a property is persisted to. |
default boolean |
hasExplicitWriteTarget() |
boolean |
isDbReference()
Returns whether the property is a
DBRef . |
boolean |
isDocumentReference()
Returns whether the property is a
DocumentReference . |
boolean |
isExplicitIdProperty()
Returns whether the property is explicitly marked as an identifier property of the owning
PersistentEntity . |
boolean |
isExplicitLanguageProperty()
Returns true when property being annotated with
Language . |
boolean |
isLanguageProperty()
Returns true whether the property indicates the documents language either by having a
getFieldName() equal
to language or being annotated with Language . |
boolean |
isTextScoreProperty()
Returns whether the property holds the documents score calculated by text search.
|
default boolean |
isUnwrapped() |
boolean |
usePropertyAccess()
Returns whether property access shall be used for reading the property value.
|
boolean |
writeNullValues()
Returns whether the property should be written to the database if its value is null.
|
findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, 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
String getFieldName()
Class<?> getFieldType()
Java FieldType
of the field a property is persisted to.FieldType
int getFieldOrder()
boolean writeNullValues()
Field.Write
boolean isDbReference()
DBRef
. If this returns true you can expect
getDBRef()
to return an non-null value.boolean isDocumentReference()
DocumentReference
. If this returns true you can expect
getDocumentReference()
to return an non-null value.boolean isExplicitIdProperty()
PersistentEntity
.
A property is an explicit id property if it is annotated with @see Id
.boolean isLanguageProperty()
getFieldName()
equal
to language or being annotated with Language
.boolean isExplicitLanguageProperty()
Language
.boolean isTextScoreProperty()
TextScore
.@Nullable DBRef getDBRef()
DBRef
if the property is a reference.isDbReference()
@Nullable DocumentReference getDocumentReference()
DocumentReference
if the property is a reference.isDocumentReference()
boolean usePropertyAccess()
usePropertyAccess
in interface PersistentProperty<MongoPersistentProperty>
default boolean hasExplicitWriteTarget()
target type
.default boolean isUnwrapped()
Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.