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 MongoPersistentProperty implementation.

Author:

Oliver Gierke, Patryk Wasik, Thomas Darimont, Christoph Strobl

Property Summary

Type	Property and Description
boolean	isExplicitId Gets the value of the property explicitIdProperty.
boolean	isExplicitLanguage Gets the value of the property explicitLanguageProperty.
boolean	isId Gets the value of the property idProperty.
boolean	isLanguage Gets the value of the property languageProperty.
boolean	isTextScore Gets the value of the property textScoreProperty.

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

isVersionProperty

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

isVersionProperty

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.mapping.model.AbstractPersistentProperty

association, field, information, name, owner, propertyDescriptor, rawType

Constructor Summary

Constructors

Constructor and Description
BasicMongoPersistentProperty(Field field, PropertyDescriptor propertyDescriptor, 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 DBObject.
int	getFieldOrder() Returns the order of the field if defined.
boolean	isDbReference() Returns whether the propert is a DBRef.
boolean	isExplicitIdProperty() Gets the value of the property explicitIdProperty.
boolean	isExplicitLanguageProperty() Gets the value of the property explicitLanguageProperty.
boolean	isIdProperty() Gets the value of the property idProperty.
boolean	isLanguageProperty() Gets the value of the property languageProperty.
boolean	isTextScoreProperty() Gets the value of the property textScoreProperty.

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

findAnnotation, findPropertyOrOwnerAnnotation, 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, getPersistentEntityType, getRawType, getSetter, getType, getTypeInformation, hashCode, isArray, isCollectionLike, isEntity, 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, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityType, getRawType, getSetter, getSpelExpression, getType, getTypeInformation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isMap, isTransient, isVersionProperty, isWritable

Property Detail

isId

public boolean isIdProperty

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

isExplicitId

public boolean isExplicitIdProperty

Gets the value of the property explicitIdProperty.

Specified by:

isExplicitIdProperty in interface MongoPersistentProperty

Returns:

isLanguage

public boolean isLanguageProperty

Gets the value of the property languageProperty.

Specified by:

isLanguageProperty in interface MongoPersistentProperty

Returns:

isExplicitLanguage

public boolean isExplicitLanguageProperty

Gets the value of the property explicitLanguageProperty.

Specified by:

isExplicitLanguageProperty in interface MongoPersistentProperty

Returns:

isTextScore

public boolean isTextScoreProperty

Gets the value of the property textScoreProperty.

Specified by:

isTextScoreProperty in interface MongoPersistentProperty

Returns:

Constructor Detail

BasicMongoPersistentProperty

public BasicMongoPersistentProperty(Field field,
                                    PropertyDescriptor propertyDescriptor,
                                    MongoPersistentEntity<?> owner,
                                    SimpleTypeHolder simpleTypeHolder,
                                    FieldNamingStrategy fieldNamingStrategy)

Creates a new BasicMongoPersistentProperty.

Parameters:

field -

propertyDescriptor -

owner -

simpleTypeHolder -

fieldNamingStrategy -

Method Detail

isIdProperty

public boolean isIdProperty()

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<MongoPersistentProperty>

isExplicitIdProperty

public boolean isExplicitIdProperty()

Gets the value of the property explicitIdProperty.

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 DBObject.

Specified by:

getFieldName in interface MongoPersistentProperty

Returns:

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 propert 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

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()

Gets the value of the property languageProperty.

Specified by:

isLanguageProperty in interface MongoPersistentProperty

Returns:

isExplicitLanguageProperty

public boolean isExplicitLanguageProperty()

Gets the value of the property explicitLanguageProperty.

Specified by:

isExplicitLanguageProperty in interface MongoPersistentProperty

Returns:

isTextScoreProperty

public boolean isTextScoreProperty()

Gets the value of the property textScoreProperty.

Specified by:

isTextScoreProperty in interface MongoPersistentProperty

Returns: