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 org.springframework.data.mapping.MongoPersistentProperty implementation.

Author:

Oliver Gierke, Patryk Wasik, Thomas Darimont

Property Summary

Type	Property and Description
boolean	isExplicitId Gets the value of the property explicitIdProperty.
boolean	isId Gets the value of the property idProperty.

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, org.springframework.data.mapping.model.SimpleTypeHolder simpleTypeHolder, FieldNamingStrategy fieldNamingStrategy) Creates a new BasicMongoPersistentProperty.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.data.mapping.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	isIdProperty() Gets the value of the property idProperty.

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

findAnnotation, findPropertyOrOwnerAnnotation, getSpelExpression, isAnnotationPresent, isAssociation, isTransient, isVersionProperty, 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, shallBePersisted

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

Property Detail

isId

public boolean isIdProperty

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface org.springframework.data.mapping.PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<MongoPersistentProperty>

isExplicitId

public boolean isExplicitIdProperty

Gets the value of the property explicitIdProperty.

Specified by:

isExplicitIdProperty in interface MongoPersistentProperty

Returns:

Constructor Detail

BasicMongoPersistentProperty

public BasicMongoPersistentProperty(Field field,
                                    PropertyDescriptor propertyDescriptor,
                                    MongoPersistentEntity<?> owner,
                                    org.springframework.data.mapping.model.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 org.springframework.data.mapping.PersistentProperty<MongoPersistentProperty>

Overrides:

isIdProperty in class org.springframework.data.mapping.model.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 org.springframework.data.mapping.Association<MongoPersistentProperty> createAssociation()

Specified by:

createAssociation in class org.springframework.data.mapping.model.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()