Module spring.data.mongodb

Package org.springframework.data.mongodb.core.mapping

Class BasicMongoPersistentEntity<T>

java.lang.Object

org.springframework.data.mapping.model.BasicPersistentEntity<T,MongoPersistentProperty>

org.springframework.data.mongodb.core.mapping.BasicMongoPersistentEntity<T>

All Implemented Interfaces:

Iterable<MongoPersistentProperty>, Aware, EnvironmentAware, MutablePersistentEntity<T,MongoPersistentProperty>, PersistentEntity<T,MongoPersistentProperty>, MongoPersistentEntity<T>

public class BasicMongoPersistentEntity<T>
extends BasicPersistentEntity<T,MongoPersistentProperty>
implements MongoPersistentEntity<T>

MongoDB specific MongoPersistentEntity implementation that adds Mongo specific meta-data such as the collection name and the like.

Author:

Jon Brisbin, Oliver Gierke, Thomas Darimont, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
BasicMongoPersistentEntity(TypeInformation<T> typeInformation)	Creates a new BasicMongoPersistentEntity with the given TypeInformation.

Method Summary

Modifier and Type	Method	Description
Collation	getCollation()	Returns the collation of the entity evaluating a potential SpEL expression within the current context.
String	getCollection()	Returns the collection the entity shall be persisted to.
Collection<Object>	getEncryptionKeyIds()
EvaluationContext	getEvaluationContext(Object rootObject)
EvaluationContext	getEvaluationContext(Object rootObject, ExpressionDependencies dependencies)
String	getLanguage()	Returns the default language to be used for this entity.
ShardKey	getShardKey()	Get the entities shard key if defined.
MongoPersistentProperty	getTextScoreProperty()	Returns the property holding text score value.
ValueEvaluationContext	getValueEvaluationContext(Object rootObject)
ValueEvaluationContext	getValueEvaluationContext(Object rootObject, ExpressionDependencies dependencies)
boolean	hasTextScoreProperty()	Returns whether the entity has a TextScore property.
protected MongoPersistentProperty	returnPropertyIfBetterIdPropertyCandidateOrNull(MongoPersistentProperty property)	As a general note: An implicit id property has a name that matches "id" or "_id".
void	verify()

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

addAssociation, addPersistentProperty, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getFallbackIsNewStrategy, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, iterator, requiresPropertyPopulation, setEnvironment, setEvaluationContextProvider, setPersistentPropertyAccessorFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.EnvironmentAware

setEnvironment

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.springframework.data.mongodb.core.mapping.MongoPersistentEntity

hasCollation, isSharded, isUnwrapped

Methods inherited from interface org.springframework.data.mapping.model.MutablePersistentEntity

addAssociation, addPersistentProperty, setEvaluationContextProvider, setPersistentPropertyAccessorFactory

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

doWithAll, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

Constructor Details

BasicMongoPersistentEntity

public BasicMongoPersistentEntity(TypeInformation<T> typeInformation)

Creates a new BasicMongoPersistentEntity with the given TypeInformation. Will default the collection name to the entities simple type name.

Parameters:

typeInformation - must not be null.

Method Details

getCollection

public String getCollection()

Description copied from interface: MongoPersistentEntity

Returns the collection the entity shall be persisted to.

Specified by:

getCollection in interface MongoPersistentEntity<T>

Returns:

getLanguage

public String getLanguage()

Description copied from interface: MongoPersistentEntity

Returns the default language to be used for this entity.

Specified by:

getLanguage in interface MongoPersistentEntity<T>

Returns:

getTextScoreProperty

@Nullable
public MongoPersistentProperty getTextScoreProperty()

Description copied from interface: MongoPersistentEntity

Returns the property holding text score value.

Specified by:

getTextScoreProperty in interface MongoPersistentEntity<T>

Returns:

null if not present.

See Also:

• MongoPersistentEntity.hasTextScoreProperty()

hasTextScoreProperty

public boolean hasTextScoreProperty()

Description copied from interface: MongoPersistentEntity

Returns whether the entity has a TextScore property.

Specified by:

hasTextScoreProperty in interface MongoPersistentEntity<T>

Returns:

true if property annotated with TextScore is present.

getCollation

public Collation getCollation()

Description copied from interface: MongoPersistentEntity

Returns the collation of the entity evaluating a potential SpEL expression within the current context.

Specified by:

getCollation in interface MongoPersistentEntity<T>

Returns:

null if not set.

getShardKey

public ShardKey getShardKey()

Description copied from interface: MongoPersistentEntity

Get the entities shard key if defined.

Specified by:

getShardKey in interface MongoPersistentEntity<T>

Returns:

ShardKey.none() if not not set.

verify

public void verify()

Specified by:

verify in interface MutablePersistentEntity<T,MongoPersistentProperty>

Overrides:

verify in class BasicPersistentEntity<T,MongoPersistentProperty>

getEvaluationContext

public EvaluationContext getEvaluationContext(Object rootObject)

Overrides:

getEvaluationContext in class BasicPersistentEntity<T,MongoPersistentProperty>

getEvaluationContext

public EvaluationContext getEvaluationContext(Object rootObject,
 ExpressionDependencies dependencies)

Overrides:

getEvaluationContext in class BasicPersistentEntity<T,MongoPersistentProperty>

getValueEvaluationContext

public ValueEvaluationContext getValueEvaluationContext(Object rootObject)

Overrides:

getValueEvaluationContext in class BasicPersistentEntity<T,MongoPersistentProperty>

getValueEvaluationContext

public ValueEvaluationContext getValueEvaluationContext(Object rootObject,
 ExpressionDependencies dependencies)

Overrides:

getValueEvaluationContext in class BasicPersistentEntity<T,MongoPersistentProperty>

returnPropertyIfBetterIdPropertyCandidateOrNull

protected MongoPersistentProperty returnPropertyIfBetterIdPropertyCandidateOrNull(MongoPersistentProperty property)

As a general note: An implicit id property has a name that matches "id" or "_id". An explicit id property is one that is annotated with @see Id. The property id is updated according to the following rules: 1) An id property which is defined explicitly takes precedence over an implicitly defined id property. 2) In case of any ambiguity a @see MappingException is thrown.

Overrides:

returnPropertyIfBetterIdPropertyCandidateOrNull in class BasicPersistentEntity<T,MongoPersistentProperty>

Parameters:

property - - the new id property candidate

Returns:

can be null.

getEncryptionKeyIds

public Collection<Object> getEncryptionKeyIds()

Specified by:

getEncryptionKeyIds in interface MongoPersistentEntity<T>

Returns:

the resolved encryption keyIds if applicable. An empty Collection if no keyIds specified. null no Encrypted annotation found.