org.springframework.data.mongodb.repository.support

Class MappingMongoEntityInformation<T,ID>

java.lang.Object

org.springframework.data.repository.core.support.PersistentEntityInformation<T,ID>

org.springframework.data.mongodb.repository.support.MappingMongoEntityInformation<T,ID>

All Implemented Interfaces:

MongoEntityInformation<T,ID>, EntityInformation<T,ID>, EntityMetadata<T>

public class MappingMongoEntityInformation<T,ID>
extends PersistentEntityInformation<T,ID>
implements MongoEntityInformation<T,ID>

MongoEntityInformation implementation using a MongoPersistentEntity instance to lookup the necessary information. Can be configured with a custom collection to be returned which will trump the one returned by the MongoPersistentEntity if given.

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
MappingMongoEntityInformation(MongoPersistentEntity<T> entity) Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity.
MappingMongoEntityInformation(MongoPersistentEntity<T> entity, Class<ID> fallbackIdType) Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity and fallback identifier type.
MappingMongoEntityInformation(MongoPersistentEntity<T> entity, String customCollectionName) Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity and custom collection name.

Method Summary

Modifier and Type	Method and Description
Collation	getCollation() Return the collation for the entity or null if not defined.
String	getCollectionName() Returns the name of the collection the entity shall be persisted to.
String	getIdAttribute() Returns the attribute that the id will be persisted to.
Class<ID>	getIdType()
Object	getVersion(T entity) Returns the version value for the entity or null if the entity is not versioned.
boolean	isVersioned() Returns whether the entity uses optimistic locking.

Methods inherited from class org.springframework.data.repository.core.support.PersistentEntityInformation

getId, getJavaType, isNew

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.mongodb.repository.query.MongoEntityInformation

hasCollation

Methods inherited from interface org.springframework.data.repository.core.EntityInformation

getId, getRequiredId, isNew

Methods inherited from interface org.springframework.data.repository.core.EntityMetadata

getJavaType

Constructor Detail

MappingMongoEntityInformation

public MappingMongoEntityInformation(MongoPersistentEntity<T> entity)

Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity.

Parameters:

entity - must not be null.

MappingMongoEntityInformation

public MappingMongoEntityInformation(MongoPersistentEntity<T> entity,
                                     @Nullable
                                     Class<ID> fallbackIdType)

Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity and fallback identifier type.

Parameters:

entity - must not be null.

fallbackIdType - can be null.

MappingMongoEntityInformation

public MappingMongoEntityInformation(MongoPersistentEntity<T> entity,
                                     String customCollectionName)

Creates a new MappingMongoEntityInformation for the given MongoPersistentEntity and custom collection name.

Parameters:

entity - must not be null.

customCollectionName - can be null.

Method Detail

getCollectionName

public String getCollectionName()

Description copied from interface: MongoEntityInformation

Returns the name of the collection the entity shall be persisted to.

Specified by:

getCollectionName in interface MongoEntityInformation<T,ID>

Returns:

getIdAttribute

public String getIdAttribute()

Description copied from interface: MongoEntityInformation

Returns the attribute that the id will be persisted to.

Specified by:

getIdAttribute in interface MongoEntityInformation<T,ID>

Returns:

getIdType

public Class<ID> getIdType()

Specified by:

getIdType in interface EntityInformation<T,ID>

Overrides:

getIdType in class PersistentEntityInformation<T,ID>

isVersioned

public boolean isVersioned()

Description copied from interface: MongoEntityInformation

Returns whether the entity uses optimistic locking.

Specified by:

isVersioned in interface MongoEntityInformation<T,ID>

Returns:

true if the entity defines a Version property.

getVersion

public Object getVersion(T entity)

Description copied from interface: MongoEntityInformation

Returns the version value for the entity or null if the entity is not versioned.

Specified by:

getVersion in interface MongoEntityInformation<T,ID>

Parameters:

entity - must not be null

Returns:

can be null.

getCollation

@Nullable
public Collation getCollation()

Description copied from interface: MongoEntityInformation

Return the collation for the entity or null if not defined.

Specified by:

getCollation in interface MongoEntityInformation<T,ID>

Returns:

can be null.