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:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.data.mapping.model.MutablePersistentEntity<T,MongoPersistentProperty>, org.springframework.data.mapping.PersistentEntity<T,MongoPersistentProperty>, MongoPersistentEntity<T>

public class BasicMongoPersistentEntity<T>
extends org.springframework.data.mapping.model.BasicPersistentEntity<T,MongoPersistentProperty>
implements MongoPersistentEntity<T>, org.springframework.context.ApplicationContextAware

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

Property Summary

Type	Property and Description
boolean	hasTextScore Returns whether the entity has a TextScore property.

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

hasIdProperty, hasVersionProperty

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

hasIdProperty, hasVersionProperty

Constructor Summary

Constructors

Constructor and Description
BasicMongoPersistentEntity(org.springframework.data.util.TypeInformation<T> typeInformation) Creates a new BasicMongoPersistentEntity with the given TypeInformation.

Method Summary

Modifier and Type	Method and Description
String	getCollection() Returns the collection the entity shall be persisted to.
String	getLanguage() Returns the default language to be used for this entity.
MongoPersistentProperty	getTextScoreProperty() Returns the property holding text score value.
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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	verify()

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

addAssociation, addPersistentProperty, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getName, getPersistenceConstructor, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isConstructorArgument, isIdProperty, isVersionProperty, 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.data.mapping.PersistentEntity

doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getName, getPersistenceConstructor, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isConstructorArgument, isIdProperty, isVersionProperty

Property Detail

hasTextScore

public boolean hasTextScoreProperty

Specified by:

hasTextScoreProperty in interface MongoPersistentEntity<T>

Returns:

true if property annotated with TextScore is present.

Constructor Detail

BasicMongoPersistentEntity

public BasicMongoPersistentEntity(org.springframework.data.util.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 Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

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

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.

verify

public void verify()

Specified by:

verify in interface org.springframework.data.mapping.model.MutablePersistentEntity<T,MongoPersistentProperty>

Overrides:

verify in class org.springframework.data.mapping.model.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 org.springframework.data.mapping.model.BasicPersistentEntity<T,MongoPersistentProperty>

Parameters:

property - - the new id property candidate

Returns: