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

Class BasicMongoPersistentProperty

java.lang.Object
org.springframework.data.mapping.model.AbstractPersistentProperty<P>
org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<MongoPersistentProperty>
org.springframework.data.mongodb.core.mapping.BasicMongoPersistentProperty
All Implemented Interfaces:
org.springframework.data.mapping.PersistentProperty<MongoPersistentProperty>, MongoPersistentProperty
Direct Known Subclasses:
CachingMongoPersistentProperty
public class BasicMongoPersistentProperty extends org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<MongoPersistentProperty> implements MongoPersistentProperty
MongoDB specific PersistentProperty implementation.
Author:
Oliver Gierke, Patryk Wasik, Thomas Darimont, Christoph Strobl, Mark Paluch, Divya Srivastava

  • Nested Class Summary

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

    MongoPersistentProperty.PropertyToFieldNameConverter

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID_FIELD_NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicMongoPersistentProperty(org.springframework.data.mapping.model.Property property, MongoPersistentEntity<?> owner, org.springframework.data.mapping.model.SimpleTypeHolder simpleTypeHolder, org.springframework.data.mapping.model.FieldNamingStrategy fieldNamingStrategy)
    Creates a new BasicMongoPersistentProperty.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.springframework.data.mapping.Association<MongoPersistentProperty>
    createAssociation()
     
    DBRef
    getDBRef()
    Returns the DBRef if the property is a reference.
    DocumentReference
    getDocumentReference()
    Returns the DocumentReference if the property is a reference.
    Collection<Object>
    getEncryptionKeyIds()
     
    org.springframework.expression.EvaluationContext
    getEvaluationContext(Object rootObject)
    Obtain the EvaluationContext for a specific root object.
    String
    getFieldName()
    Returns the key to be used to store the value of the property inside a Mongo Document.
    int
    getFieldOrder()
    Returns the order of the field if defined.
    Class<?>
    getFieldType()
    Returns the Java FieldType of the field a property is persisted to.
    boolean
    hasExplicitFieldName()
    Returns whether the property uses an annotated field name through Field.
    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
    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
    writeNullValues()
    Returns whether the property should be written to the database if its value is null.

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

    findAnnotation, findPropertyOrOwnerAnnotation, getAssociationTargetTypeInformation, getSpelExpression, isAnnotationPresent, isAssociation, isTransient, isVersionProperty, isWritable, 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.mongodb.core.mapping.MongoPersistentProperty

    hasExplicitWriteTarget, isUnwrapped, usePropertyAccess

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