org.springframework.data.mongodb.core.mapping

Interface MongoPersistentProperty

All Superinterfaces:

org.springframework.data.mapping.PersistentProperty<MongoPersistentProperty>

All Known Implementing Classes:

BasicMongoPersistentProperty, CachingMongoPersistentProperty

public interface MongoPersistentProperty
extends org.springframework.data.mapping.PersistentProperty<MongoPersistentProperty>

MongoDB specific PersistentProperty extension.

Author:

Oliver Gierke, Patryk Wasik, Thomas Darimont

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MongoPersistentProperty.PropertyToFieldNameConverter Simple Converter implementation to transform a MongoPersistentProperty into its field name.

Method Summary

Modifier and Type	Method and Description
DBRef	getDBRef() Returns the DBRef if the property is a reference.
String	getFieldName() Returns the name of the field a property is persisted to.
int	getFieldOrder() Returns the order of the field if defined.
boolean	isDbReference() Returns whether the propert is a DBRef.
boolean	isExplicitIdProperty() Returns whether the property is explicitly marked as an identifier property of the owning PersistentEntity.
boolean	usePropertyAccess() Returns whether property access shall be used for reading the property value.

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, isIdProperty, isMap, isTransient, isVersionProperty, shallBePersisted

Method Detail

getFieldName

String getFieldName()

Returns the name of the field a property is persisted to.

Returns:

getFieldOrder

int getFieldOrder()

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

Returns:

isDbReference

boolean isDbReference()

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

Returns:

isExplicitIdProperty

boolean isExplicitIdProperty()

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.

Returns:

getDBRef

DBRef getDBRef()

Returns the DBRef if the property is a reference.

Returns:

See Also:

isDbReference()

usePropertyAccess

boolean usePropertyAccess()

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

Returns: