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:

PersistentProperty<MongoPersistentProperty>, MongoPersistentProperty

Direct Known Subclasses:

CachingMongoPersistentProperty

public class BasicMongoPersistentProperty
extends AnnotationBasedPersistentProperty<MongoPersistentProperty>
implements MongoPersistentProperty

MongoDB specific PersistentProperty implementation.

Author:

Oliver Gierke, Patryk Wasik, Thomas Darimont, Christoph Strobl, Mark Paluch

Nested Class Summary

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

MongoPersistentProperty.PropertyToFieldNameConverter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Association<MongoPersistentProperty>	createAssociation()
DBRef	getDBRef() Returns the DBRef 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.
int	getFieldOrder() Returns the order of the field if defined.
protected boolean	hasExplicitFieldName()
boolean	isDbReference() Returns whether the property is a DBRef.
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.

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

findAnnotation, findPropertyOrOwnerAnnotation, getAssociationTargetType, getSpelExpression, isAnnotationPresent, isAssociation, isTransient, isVersionProperty, isWritable, toString, usePropertyAccess

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

equals, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypes, 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

usePropertyAccess

Methods inherited from interface org.springframework.data.mapping.PersistentProperty

findAnnotation, findPropertyOrOwnerAnnotation, getActualType, getAssociation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypes, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isImmutable, isMap, isTransient, isVersionProperty, isWritable

Constructor Detail

BasicMongoPersistentProperty

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

Creates a new BasicMongoPersistentProperty.

Parameters:

field -

propertyDescriptor -

owner -

simpleTypeHolder -

fieldNamingStrategy -

Method Detail

isIdProperty

public boolean isIdProperty()

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

Specified by:

isIdProperty in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

See Also:

SUPPORTED_ID_PROPERTY_NAMES, SUPPORTED_ID_TYPES

isExplicitIdProperty

public boolean isExplicitIdProperty()

Description copied from interface: MongoPersistentProperty

Returns whether the property is explicitly marked as an identifier property of the owning PersistentEntity. A property is an explicit id property if it is annotated with @see Id.

Specified by:

isExplicitIdProperty in interface MongoPersistentProperty

Returns:

getFieldName

public String getFieldName()

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

Specified by:

getFieldName in interface MongoPersistentProperty

Returns:

hasExplicitFieldName

protected boolean hasExplicitFieldName()

Returns:

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

Since:

1.7

getFieldOrder

public int getFieldOrder()

Description copied from interface: MongoPersistentProperty

Returns the order of the field if defined. Will return -1 if undefined.

Specified by:

getFieldOrder in interface MongoPersistentProperty

Returns:

createAssociation

protected Association<MongoPersistentProperty> createAssociation()

Specified by:

createAssociation in class AbstractPersistentProperty<MongoPersistentProperty>

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

Returns:

getDBRef

@Nullable
public DBRef getDBRef()

Description copied from interface: MongoPersistentProperty

Returns the DBRef if the property is a reference.

Specified by:

getDBRef in interface MongoPersistentProperty

Returns:

See Also:

MongoPersistentProperty.isDbReference()

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

Returns:

isExplicitLanguageProperty

public boolean isExplicitLanguageProperty()

Description copied from interface: MongoPersistentProperty

Returns true when property being annotated with Language.

Specified by:

isExplicitLanguageProperty in interface MongoPersistentProperty

Returns:

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

Returns: