MappingMongoEntityInformation (Spring Data MongoDB 2.1.0.RELEASE API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()`

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.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>

Class MappingMongoEntityInformation<T,ID>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

MappingMongoEntityInformation

MappingMongoEntityInformation

MappingMongoEntityInformation

Method Detail

getCollectionName

getIdAttribute

getIdType