org.springframework.data.mongodb.core.mapping

Interface MongoPersistentProperty

All Superinterfaces:

PersistentProperty<MongoPersistentProperty>

All Known Implementing Classes:

BasicMongoPersistentProperty, CachingMongoPersistentProperty

public interface MongoPersistentProperty
extends PersistentProperty<MongoPersistentProperty>

MongoDB specific PersistentProperty extension.

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	isLanguage Gets the value of the property languageProperty.
boolean	isTextScore Gets the value of the property textScoreProperty.

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

isIdProperty, isVersionProperty

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 property is a DBRef.
boolean	isExplicitIdProperty() Gets the value of the property explicitIdProperty.
boolean	isExplicitLanguageProperty() Gets the value of the property explicitLanguageProperty.
boolean	isLanguageProperty() Gets the value of the property languageProperty.
boolean	isTextScoreProperty() Gets the value of the property textScoreProperty.
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, 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, isIdProperty, isImmutable, isMap, isTransient, isVersionProperty, isWritable

Property Detail

isExplicitId

boolean isExplicitIdProperty

Gets the value of the property explicitIdProperty.

isLanguage

boolean isLanguageProperty

Gets the value of the property languageProperty.

Since:

1.6

isExplicitLanguage

boolean isExplicitLanguageProperty

Gets the value of the property explicitLanguageProperty.

Since:

1.6.1

isTextScore

boolean isTextScoreProperty

Gets the value of the property textScoreProperty.

Since:

1.6

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 property is a DBRef. If this returns true you can expect getDBRef() to return an non-null value.

Returns:

isExplicitIdProperty

boolean isExplicitIdProperty()

Gets the value of the property explicitIdProperty.

isLanguageProperty

boolean isLanguageProperty()

Gets the value of the property languageProperty.

Since:

1.6

isExplicitLanguageProperty

boolean isExplicitLanguageProperty()

Gets the value of the property explicitLanguageProperty.

Since:

1.6.1

isTextScoreProperty

boolean isTextScoreProperty()

Gets the value of the property textScoreProperty.

Since:

1.6

getDBRef

@Nullable
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 PersistentProperty<MongoPersistentProperty>

Returns: