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

Class SpannerPersistentPropertyImpl

java.lang.Object

org.springframework.data.mapping.model.AbstractPersistentProperty<P>

org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<SpannerPersistentProperty>

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

All Implemented Interfaces:

SpannerPersistentProperty, org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>

public class SpannerPersistentPropertyImpl
extends org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<SpannerPersistentProperty>
implements SpannerPersistentProperty

Represents an implementation for SpannerPersistentProperty, which is a property of a SpannerPersistentEntity stored in a Google Spanner table.

Author:

Ray Tsang, Chengyuan Zhao

Property Summary

Type	Property and Description
boolean	isId Gets the value of the property idProperty.

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

isVersionProperty

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

isVersionProperty

Method Summary

Modifier and Type	Method and Description
protected org.springframework.data.mapping.Association<SpannerPersistentProperty>	createAssociation()
Class<?>	getColumnInnerType() Gets the inner type of the column, which is meaningful for columns of type ARRAY in Google Cloud Spanner.
String	getColumnName() Gets the name of the column in the Google Spanner table mapped to this property.
OptionalLong	getMaxColumnLength() Gets the maximum data length of the column if provided.
Iterable<? extends org.springframework.data.util.TypeInformation<?>>	getPersistentEntityTypes() Only provides types that are also annotated with Table.
OptionalInt	getPrimaryKeyOrder() Gets the order of this column if it is part of the table's primary key.
boolean	isIdProperty() Gets the value of the property idProperty.
boolean	isMapped() True if property corresponds to a column a Cloud Spanner table or child entities stored in Cloud Spanner.

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

findAnnotation, findPropertyOrOwnerAnnotation, getSpelExpression, isAnnotationPresent, isAssociation, isTransient, isVersionProperty, isWritable, toString, usePropertyAccess

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

equals, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityType, getProperty, getRawType, getSetter, getType, getTypeInformation, hashCode, isArray, isCollectionLike, isEntity, isMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

findAnnotation, findPropertyOrOwnerAnnotation, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityType, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getSetter, getSpelExpression, getType, getTypeInformation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess

Property Detail

isId

public boolean isIdProperty

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>

Overrides:

isIdProperty in class org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<SpannerPersistentProperty>

Method Detail

getPersistentEntityTypes

public Iterable<? extends org.springframework.data.util.TypeInformation<?>> getPersistentEntityTypes()

Only provides types that are also annotated with Table.

Specified by:

getPersistentEntityTypes in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>

createAssociation

protected org.springframework.data.mapping.Association<SpannerPersistentProperty> createAssociation()

Specified by:

createAssociation in class org.springframework.data.mapping.model.AbstractPersistentProperty<SpannerPersistentProperty>

getColumnName

public String getColumnName()

Gets the name of the column in the Google Spanner table mapped to this property. The column name is resolved using the FieldNamingStrategy passed in to the SpannerPersistentPropertyImpl(Property, PersistentEntity, SimpleTypeHolder, FieldNamingStrategy) constructor. This is by default the by default

Specified by:

getColumnName in interface SpannerPersistentProperty

Returns:

the name of the column.

Throws:

org.springframework.data.mapping.MappingException - if the resolution fails

getColumnInnerType

public Class<?> getColumnInnerType()

Description copied from interface: SpannerPersistentProperty

Gets the inner type of the column, which is meaningful for columns of type ARRAY in Google Cloud Spanner.

Specified by:

getColumnInnerType in interface SpannerPersistentProperty

Returns:

the inner type of the column.

getPrimaryKeyOrder

public OptionalInt getPrimaryKeyOrder()

Description copied from interface: SpannerPersistentProperty

Gets the order of this column if it is part of the table's primary key. Will be empty or null if this column is not part of the primary key.

Specified by:

getPrimaryKeyOrder in interface SpannerPersistentProperty

Returns:

An optional that is empty if no primary key order exists for the property.

isMapped

public boolean isMapped()

Description copied from interface: SpannerPersistentProperty

True if property corresponds to a column a Cloud Spanner table or child entities stored in Cloud Spanner. False otherwise.

Specified by:

isMapped in interface SpannerPersistentProperty

Returns:

True if this property will be mapped to and from Cloud Spanner. False otherwise.

getMaxColumnLength

public OptionalLong getMaxColumnLength()

Description copied from interface: SpannerPersistentProperty

Gets the maximum data length of the column if provided.

Specified by:

getMaxColumnLength in interface SpannerPersistentProperty

Returns:

An optional that is empty if no maximum length was provided.

isIdProperty

public boolean isIdProperty()

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>

Overrides:

isIdProperty in class org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<SpannerPersistentProperty>