org.springframework.cloud.gcp.data.datastore.core.mapping

Class DatastorePersistentEntityImpl<T>

java.lang.Object

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

org.springframework.cloud.gcp.data.datastore.core.mapping.DatastorePersistentEntityImpl<T>

Type Parameters:

T - the type of the persistent entity

All Implemented Interfaces:

Iterable<DatastorePersistentProperty>, org.springframework.beans.factory.Aware, DatastorePersistentEntity<T>, org.springframework.context.ApplicationContextAware, org.springframework.data.mapping.model.MutablePersistentEntity<T,DatastorePersistentProperty>, org.springframework.data.mapping.PersistentEntity<T,DatastorePersistentProperty>

public class DatastorePersistentEntityImpl<T>
extends org.springframework.data.mapping.model.BasicPersistentEntity<T,DatastorePersistentProperty>
implements DatastorePersistentEntity<T>

Metadata class for entities stored in Datastore.

Since:

1.1

Author:

Chengyuan Zhao

Constructor Summary

Constructors

Constructor and Description
DatastorePersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information, DatastoreMappingContext datastoreMappingContext) Constructor.

Method Summary

Modifier and Type	Method and Description
void	doWithColumnBackedProperties(org.springframework.data.mapping.PropertyHandler<DatastorePersistentProperty> handler) Applies the given PropertyHandler to all DatastorePersistentProperty contained in this DatastorePersistentEntity that are stored as columns in the table for this entity.
void	doWithDescendantProperties(org.springframework.data.mapping.PropertyHandler<DatastorePersistentProperty> handler) Applies the given PropertyHandler to all DatastorePersistentProperty contained in this DatastorePersistentEntity that are properties backed by descendants.
List<String>	getCompatibleDiscriminationValues() Get the discrimination values corresponding to this persistent entity ad its supertypes.
String	getDiscriminationFieldName() Get the name of the field for subtype discrimination if there is one.
String	getDiscriminatorValue() Get the discrimination value corresponding to this persistent entity type.
DatastorePersistentProperty	getIdPropertyOrFail() Gets the ID property, and will throw DatastoreDataException if the entity does not have an ID property.
protected boolean	hasTableName()
String	kindName() Gets the name of the Datastore Kind.
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, getEvaluationContext, getFallbackIsNewStrategy, getIdentifierAccessor, getIdProperty, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, iterator, requiresPropertyPopulation, returnPropertyIfBetterIdPropertyCandidateOrNull, 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.data.mapping.model.MutablePersistentEntity

addAssociation, addPersistentProperty, setEvaluationContextProvider, setPersistentPropertyAccessorFactory

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

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

DatastorePersistentEntityImpl

public DatastorePersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information,
                                     DatastoreMappingContext datastoreMappingContext)

Constructor.

Parameters:

information - type information about the underlying entity type.

datastoreMappingContext - a mapping context used to get metadata for related persistent entities.

Method Detail

hasTableName

protected boolean hasTableName()

kindName

public String kindName()

Description copied from interface: DatastorePersistentEntity

Gets the name of the Datastore Kind.

Specified by:

kindName in interface DatastorePersistentEntity<T>

Returns:

the name of the Datastore Kind that stores these entities.

getIdPropertyOrFail

public DatastorePersistentProperty getIdPropertyOrFail()

Description copied from interface: DatastorePersistentEntity

Gets the ID property, and will throw DatastoreDataException if the entity does not have an ID property.

Specified by:

getIdPropertyOrFail in interface DatastorePersistentEntity<T>

Returns:

the ID property.

verify

public void verify()

Specified by:

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

Overrides:

verify in class org.springframework.data.mapping.model.BasicPersistentEntity<T,DatastorePersistentProperty>

getDiscriminationFieldName

public String getDiscriminationFieldName()

Description copied from interface: DatastorePersistentEntity

Get the name of the field for subtype discrimination if there is one.

Specified by:

getDiscriminationFieldName in interface DatastorePersistentEntity<T>

Returns:

the name of the discrimination field. null if this persistent entity doesn't have one.

getCompatibleDiscriminationValues

public List<String> getCompatibleDiscriminationValues()

Description copied from interface: DatastorePersistentEntity

Get the discrimination values corresponding to this persistent entity ad its supertypes.

Specified by:

getCompatibleDiscriminationValues in interface DatastorePersistentEntity<T>

Returns:

the list of values where the first item is this entity's discrimination value

getDiscriminatorValue

public String getDiscriminatorValue()

Description copied from interface: DatastorePersistentEntity

Get the discrimination value corresponding to this persistent entity type.

Specified by:

getDiscriminatorValue in interface DatastorePersistentEntity<T>

Returns:

the value or null if there is no value for this type.

doWithColumnBackedProperties

public void doWithColumnBackedProperties(org.springframework.data.mapping.PropertyHandler<DatastorePersistentProperty> handler)

Description copied from interface: DatastorePersistentEntity

Applies the given PropertyHandler to all DatastorePersistentProperty contained in this DatastorePersistentEntity that are stored as columns in the table for this entity. This means properties backed by descendants or references to entities of other Kinds are not provided to the handler.

Specified by:

doWithColumnBackedProperties in interface DatastorePersistentEntity<T>

Parameters:

handler - must not be null.

doWithDescendantProperties

public void doWithDescendantProperties(org.springframework.data.mapping.PropertyHandler<DatastorePersistentProperty> handler)

Description copied from interface: DatastorePersistentEntity

Applies the given PropertyHandler to all DatastorePersistentProperty contained in this DatastorePersistentEntity that are properties backed by descendants.

Specified by:

doWithDescendantProperties in interface DatastorePersistentEntity<T>

Parameters:

handler - must not be null.

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