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

Class SpannerPersistentEntityImpl<T>

java.lang.Object

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

org.springframework.cloud.gcp.data.spanner.core.mapping.SpannerPersistentEntityImpl<T>

Type Parameters:

T - the type of the persistent entity

All Implemented Interfaces:

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

public class SpannerPersistentEntityImpl<T>
extends org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>
implements SpannerPersistentEntity<T>

Represents a Cloud Spanner table and its columns' mapping to fields within an entity type.

Since:

1.1

Author:

Ray Tsang, Chengyuan Zhao, Roman Solodovnichenko

Property Summary

Type	Property and Description
boolean	hasId

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

hasVersionProperty

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

hasVersionProperty

Constructor Summary

Constructors

Constructor and Description
SpannerPersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information) Creates a SpannerPersistentEntityImpl.
SpannerPersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information, SpannerMappingContext spannerMappingContext, SpannerEntityProcessor spannerEntityProcessor) Creates a SpannerPersistentEntityImpl.

Method Summary

Modifier and Type	Method and Description
void	addPersistentProperty(SpannerPersistentProperty property)
Set<String>	columns() Gets the column names stored for this entity.
void	doWithColumnBackedProperties(org.springframework.data.mapping.PropertyHandler<SpannerPersistentProperty> handler) Applies the given PropertyHandler to all SpannerPersistentPropertys contained in this SpannerPersistentProperty that are stored as columns in the table for this entity.
void	doWithInterleavedProperties(org.springframework.data.mapping.PropertyHandler<SpannerPersistentProperty> handler) Applies the given PropertyHandler to all SpannerPersistentPropertys contained in this SpannerPersistentProperty that are collections of child entities.
List<SpannerPersistentProperty>	getFlattenedPrimaryKeyProperties() Gets the primary key properties in order.
SpannerCompositeKeyProperty	getIdProperty()
String	getPrimaryKeyColumnName() Returns a primary key column name; if there are multiple primary key columns, returns first one.
SpannerPersistentProperty[]	getPrimaryKeyProperties() Gets the primary key properties in order.
<B> org.springframework.data.mapping.PersistentPropertyAccessor<B>	getPropertyAccessor(B object)
SpannerEntityWriter	getSpannerEntityProcessor() Gets a SpannerEntityProcessor that can be used to create Cloud Spanner keys from one or more persistent properties.
SpannerMappingContext	getSpannerMappingContext() Gets the SpannerMappingContext that can be used to create persistent entities of types that appear as properties of this entity.
String	getWhere() Returns the value of the Where annotation from the entity's class or inherited from parents or an empty string when no annotation found.
protected boolean	hasAnnotatedTableName()
boolean	hasEagerlyLoadedProperties() Returns true if the entity has at least one eagerly load interleaved property.
boolean	hasIdProperty()
boolean	hasMultiFieldKey() Returns true if the entity has a muti-field key.
boolean	hasWhere() Returns true when the entity has an annotation Where with a non-empty value.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
String	tableName() Gets the name of the Cloud Spanner table.
void	verify()

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

addAssociation, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getEvaluationContext, getFallbackIsNewStrategy, getIdentifierAccessor, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyPathAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, 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, setEvaluationContextProvider, setPersistentPropertyAccessorFactory

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

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Property Detail

hasId

public boolean hasIdProperty

Specified by:

hasIdProperty in interface org.springframework.data.mapping.PersistentEntity<T,SpannerPersistentProperty>

Overrides:

hasIdProperty in class org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>

Constructor Detail

SpannerPersistentEntityImpl

public SpannerPersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information)

Creates a SpannerPersistentEntityImpl.

Parameters:

information - type information about the underlying entity type.

SpannerPersistentEntityImpl

public SpannerPersistentEntityImpl(org.springframework.data.util.TypeInformation<T> information,
                                   SpannerMappingContext spannerMappingContext,
                                   SpannerEntityProcessor spannerEntityProcessor)

Creates a SpannerPersistentEntityImpl.

Parameters:

information - type information about the underlying entity type.

spannerMappingContext - a mapping context that can be used to create persistent entities from properties of this entity

spannerEntityProcessor - an entity processor used to create keys by converting and combining id properties, as well as to convert keys to property values

Method Detail

hasAnnotatedTableName

protected boolean hasAnnotatedTableName()

addPersistentProperty

public void addPersistentProperty(SpannerPersistentProperty property)

Specified by:

addPersistentProperty in interface org.springframework.data.mapping.model.MutablePersistentEntity<T,SpannerPersistentProperty>

Overrides:

addPersistentProperty in class org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>

getIdProperty

public SpannerCompositeKeyProperty getIdProperty()

Specified by:

getIdProperty in interface SpannerPersistentEntity<T>

Specified by:

getIdProperty in interface org.springframework.data.mapping.PersistentEntity<T,SpannerPersistentProperty>

Overrides:

getIdProperty in class org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>

doWithInterleavedProperties

public void doWithInterleavedProperties(org.springframework.data.mapping.PropertyHandler<SpannerPersistentProperty> handler)

Description copied from interface: SpannerPersistentEntity

Applies the given PropertyHandler to all SpannerPersistentPropertys contained in this SpannerPersistentProperty that are collections of child entities.

Specified by:

doWithInterleavedProperties in interface SpannerPersistentEntity<T>

Parameters:

handler - must not be null.

doWithColumnBackedProperties

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

Description copied from interface: SpannerPersistentEntity

Applies the given PropertyHandler to all SpannerPersistentPropertys contained in this SpannerPersistentProperty that are stored as columns in the table for this entity.

Specified by:

doWithColumnBackedProperties in interface SpannerPersistentEntity<T>

Parameters:

handler - must not be null.

hasIdProperty

public boolean hasIdProperty()

Specified by:

hasIdProperty in interface org.springframework.data.mapping.PersistentEntity<T,SpannerPersistentProperty>

Overrides:

hasIdProperty in class org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>

verify

public void verify()

Specified by:

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

Overrides:

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

getPrimaryKeyProperties

public SpannerPersistentProperty[] getPrimaryKeyProperties()

Description copied from interface: SpannerPersistentEntity

Gets the primary key properties in order. Embedded object properties containing key parts are represented as a single property.

Specified by:

getPrimaryKeyProperties in interface SpannerPersistentEntity<T>

Returns:

an array of the properties comprising the primary key in order.

getFlattenedPrimaryKeyProperties

public List<SpannerPersistentProperty> getFlattenedPrimaryKeyProperties()

Description copied from interface: SpannerPersistentEntity

Gets the primary key properties in order. Embedded object properties containing key parts are flattened into their multiple primary key properties.

Specified by:

getFlattenedPrimaryKeyProperties in interface SpannerPersistentEntity<T>

Returns:

an array of the properties comprising the primary key in order.

getSpannerMappingContext

public SpannerMappingContext getSpannerMappingContext()

Description copied from interface: SpannerPersistentEntity

Gets the SpannerMappingContext that can be used to create persistent entities of types that appear as properties of this entity.

Specified by:

getSpannerMappingContext in interface SpannerPersistentEntity<T>

Returns:

the SpannerMappingContext instance

getSpannerEntityProcessor

public SpannerEntityWriter getSpannerEntityProcessor()

Description copied from interface: SpannerPersistentEntity

Gets a SpannerEntityProcessor that can be used to create Cloud Spanner keys from one or more persistent properties.

Specified by:

getSpannerEntityProcessor in interface SpannerPersistentEntity<T>

Returns:

a SpannerEntityProcessor.

tableName

public String tableName()

Description copied from interface: SpannerPersistentEntity

Gets the name of the Cloud Spanner table.

Specified by:

tableName in interface SpannerPersistentEntity<T>

Returns:

the name of the table.

hasMultiFieldKey

public boolean hasMultiFieldKey()

Description copied from interface: SpannerPersistentEntity

Returns true if the entity has a muti-field key.

Specified by:

hasMultiFieldKey in interface SpannerPersistentEntity<T>

Returns:

true if the entity has a muti-field key

hasEagerlyLoadedProperties

public boolean hasEagerlyLoadedProperties()

Description copied from interface: SpannerPersistentEntity

Returns true if the entity has at least one eagerly load interleaved property.

Specified by:

hasEagerlyLoadedProperties in interface SpannerPersistentEntity<T>

Returns:

true if the entity has at least one eagerly load interleaved property

See Also:

Interleaved.lazy()

getWhere

public String getWhere()

Description copied from interface: SpannerPersistentEntity

Returns the value of the Where annotation from the entity's class or inherited from parents or an empty string when no annotation found.

Specified by:

getWhere in interface SpannerPersistentEntity<T>

Returns:

the value of the Where from the entity's class or inherited from parents or an empty string when no annotation found.

See Also:

SpannerPersistentEntity.hasWhere()

hasWhere

public boolean hasWhere()

Description copied from interface: SpannerPersistentEntity

Returns true when the entity has an annotation Where with a non-empty value.

Specified by:

hasWhere in interface SpannerPersistentEntity<T>

Returns:

true when the entity has an annotation Where with a non-empty value.

See Also:

SpannerPersistentEntity.getWhere()

columns

public Set<String> columns()

Description copied from interface: SpannerPersistentEntity

Gets the column names stored for this entity.

Specified by:

columns in interface SpannerPersistentEntity<T>

Returns:

the column names.

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

getPropertyAccessor

public <B> org.springframework.data.mapping.PersistentPropertyAccessor<B> getPropertyAccessor(B object)

Specified by:

getPropertyAccessor in interface org.springframework.data.mapping.PersistentEntity<T,SpannerPersistentProperty>

Overrides:

getPropertyAccessor in class org.springframework.data.mapping.model.BasicPersistentEntity<T,SpannerPersistentProperty>

getPrimaryKeyColumnName

public String getPrimaryKeyColumnName()

Description copied from interface: SpannerPersistentEntity

Returns a primary key column name; if there are multiple primary key columns, returns first one. In case of embedded keys it works recursively.

Specified by:

getPrimaryKeyColumnName in interface SpannerPersistentEntity<T>

Returns:

a primary key column name