BasicMongoPersistentEntity (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mapping.model.BasicPersistentEntity<T,MongoPersistentProperty>
- - org.springframework.data.mongodb.core.mapping.BasicMongoPersistentEntity<T>

All Implemented Interfaces:

Iterable<MongoPersistentProperty>, 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

Property Summary

All Methods Instance Methods Concrete Methods
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(TypeInformation<T> typeInformation)
Creates a new BasicMongoPersistentEntity with the given TypeInformation.

Method Summary

All Methods Instance Methods Concrete Methods
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`	`verify()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- 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(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
  - 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.
  - verify
```
public void verify()
```
    Specified by:
    
    verify in interface MutablePersistentEntity<T,MongoPersistentProperty>
    
    Overrides:
    
    verify 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:

Class BasicMongoPersistentEntity<T>

Property Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Property Detail

hasTextScore

Constructor Detail

BasicMongoPersistentEntity

Method Detail

getCollection

getLanguage

getTextScoreProperty

hasTextScoreProperty

verify

returnPropertyIfBetterIdPropertyCandidateOrNull