Module spring.data.mongodb

Package org.springframework.data.mongodb.core.mapping

Class CachingMongoPersistentProperty

java.lang.Object

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

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

org.springframework.data.mongodb.core.mapping.BasicMongoPersistentProperty

org.springframework.data.mongodb.core.mapping.CachingMongoPersistentProperty

All Implemented Interfaces:

PersistentProperty<MongoPersistentProperty>, MongoPersistentProperty

public class CachingMongoPersistentProperty
extends BasicMongoPersistentProperty

MongoPersistentProperty caching access to isIdProperty() and getFieldName().

Author:

Oliver Gierke, Mark Paluch, Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.mapping.MongoPersistentProperty

MongoPersistentProperty.PropertyToFieldNameConverter

Field Summary

Fields inherited from class org.springframework.data.mongodb.core.mapping.BasicMongoPersistentProperty

ID_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
CachingMongoPersistentProperty(Property property, MongoPersistentEntity<?> owner, SimpleTypeHolder simpleTypeHolder, FieldNamingStrategy fieldNamingStrategy)	Creates a new CachingMongoPersistentProperty.

Method Summary

Modifier and Type	Method	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 key to be used to store the value of the property inside a Mongo Document.
Class<?>	getFieldType()	Returns the Java FieldType of the field a property is persisted to.
MongoField	getMongoField()
boolean	hasExplicitFieldName()	Returns whether the property uses an annotated field name through Field.
boolean	isAssociation()
boolean	isDbReference()	Returns whether the property is a DBRef.
boolean	isExplicitLanguageProperty()	Returns true when property being annotated with Language.
boolean	isIdProperty()	Also considers fields as id that are of supported id type and name.
boolean	isLanguageProperty()	Returns true whether the property indicates the documents language either by having a MongoPersistentProperty.getFieldName() equal to language or being annotated with Language.
boolean	isTextScoreProperty()	Returns whether the property holds the documents score calculated by text search.
boolean	isTransient()
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.

Methods inherited from class org.springframework.data.mongodb.core.mapping.BasicMongoPersistentProperty

createAssociation, doGetMongoField, getEncryptionKeyIds, getEvaluationContext, getFieldOrder, getValueEvaluationContext, isDocumentReference, isExplicitIdProperty, validate

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

findAnnotation, findPropertyOrOwnerAnnotation, getAssociationTargetTypeInformation, getSpelExpression, isAnnotationPresent, isVersionProperty, isWritable, toString

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, isReadable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.mapping.MongoPersistentProperty

hasExplicitWriteTarget, isUnwrapped

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, isCollectionLike, isEntity, isImmutable, isMap, isReadable, isVersionProperty, isWritable

Constructor Details

CachingMongoPersistentProperty

public CachingMongoPersistentProperty(Property property,
 MongoPersistentEntity<?> owner,
 SimpleTypeHolder simpleTypeHolder,
 @Nullable
 FieldNamingStrategy fieldNamingStrategy)

Creates a new CachingMongoPersistentProperty.

Parameters:

property - must not be null.

owner - must not be null.

simpleTypeHolder - must not be null.

fieldNamingStrategy - can be null.

Method Details

isIdProperty

public boolean isIdProperty()

Description copied from class: BasicMongoPersistentProperty

Also considers fields as id that are of supported id type and name.

Specified by:

isIdProperty in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class BasicMongoPersistentProperty

See Also:

• BasicMongoPersistentProperty.SUPPORTED_ID_PROPERTY_NAMES

isAssociation

public boolean isAssociation()

Specified by:

isAssociation in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isAssociation in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

hasExplicitFieldName

public boolean hasExplicitFieldName()

Description copied from interface: MongoPersistentProperty

Returns whether the property uses an annotated field name through Field.

Specified by:

hasExplicitFieldName in interface MongoPersistentProperty

Overrides:

hasExplicitFieldName in class BasicMongoPersistentProperty

Returns:

true if Field having non blank Field.value() present.

getFieldName

public String getFieldName()

Description copied from class: BasicMongoPersistentProperty

Returns the key to be used to store the value of the property inside a Mongo Document.

Specified by:

getFieldName in interface MongoPersistentProperty

Overrides:

getFieldName in class BasicMongoPersistentProperty

Returns:

writeNullValues

public boolean writeNullValues()

Description copied from interface: MongoPersistentProperty

Returns whether the property should be written to the database if its value is null.

Specified by:

writeNullValues in interface MongoPersistentProperty

Overrides:

writeNullValues in class BasicMongoPersistentProperty

Returns:

See Also:

• Field.Write

getFieldType

public Class<?> getFieldType()

Description copied from interface: MongoPersistentProperty

Returns the Java FieldType of the field a property is persisted to.

Specified by:

getFieldType in interface MongoPersistentProperty

Overrides:

getFieldType in class BasicMongoPersistentProperty

Returns:

See Also:

• FieldType

usePropertyAccess

public boolean usePropertyAccess()

Description copied from interface: MongoPersistentProperty

Returns whether property access shall be used for reading the property value. This means it will use the getter instead of field access.

Specified by:

usePropertyAccess in interface MongoPersistentProperty

Specified by:

usePropertyAccess in interface PersistentProperty<MongoPersistentProperty>

Overrides:

usePropertyAccess in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

isTransient

public boolean isTransient()

Specified by:

isTransient in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isTransient in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

isTextScoreProperty

public boolean isTextScoreProperty()

Description copied from interface: MongoPersistentProperty

Returns whether the property holds the documents score calculated by text search.
It's marked with TextScore.

Specified by:

isTextScoreProperty in interface MongoPersistentProperty

Overrides:

isTextScoreProperty in class BasicMongoPersistentProperty

Returns:

isDbReference

public boolean isDbReference()

Description copied from interface: MongoPersistentProperty

Returns whether the property is a DBRef. If this returns true you can expect MongoPersistentProperty.getDBRef() to return an non-null value.

Specified by:

isDbReference in interface MongoPersistentProperty

Overrides:

isDbReference in class BasicMongoPersistentProperty

Returns:

getDBRef

public DBRef getDBRef()

Description copied from interface: MongoPersistentProperty

Returns the DBRef if the property is a reference.

Specified by:

getDBRef in interface MongoPersistentProperty

Overrides:

getDBRef in class BasicMongoPersistentProperty

Returns:

See Also:

• MongoPersistentProperty.isDbReference()

getDocumentReference

public DocumentReference getDocumentReference()

Description copied from interface: MongoPersistentProperty

Returns the DocumentReference if the property is a reference.

Specified by:

getDocumentReference in interface MongoPersistentProperty

Overrides:

getDocumentReference in class BasicMongoPersistentProperty

Returns:

null if not present.

See Also:

• MongoPersistentProperty.isDocumentReference()

isLanguageProperty

public boolean isLanguageProperty()

Description copied from interface: MongoPersistentProperty

Returns true whether the property indicates the documents language either by having a MongoPersistentProperty.getFieldName() equal to language or being annotated with Language.

Specified by:

isLanguageProperty in interface MongoPersistentProperty

Overrides:

isLanguageProperty in class BasicMongoPersistentProperty

Returns:

isExplicitLanguageProperty

public boolean isExplicitLanguageProperty()

Description copied from interface: MongoPersistentProperty

Returns true when property being annotated with Language.

Specified by:

isExplicitLanguageProperty in interface MongoPersistentProperty

Overrides:

isExplicitLanguageProperty in class BasicMongoPersistentProperty

Returns:

getMongoField

public MongoField getMongoField()

Specified by:

getMongoField in interface MongoPersistentProperty

Overrides:

getMongoField in class BasicMongoPersistentProperty

Returns:

the MongoField representing the raw field to read/write in a MongoDB document.