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

Interface DatastorePersistentProperty

All Superinterfaces:

org.springframework.data.mapping.PersistentProperty<DatastorePersistentProperty>

All Known Implementing Classes:

DatastorePersistentPropertyImpl

public interface DatastorePersistentProperty
extends org.springframework.data.mapping.PersistentProperty<DatastorePersistentProperty>

Persistent property for Google Cloud Datastore.

Since:

1.1

Author:

Chengyuan Zhao

Property Summary

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

isIdProperty, isVersionProperty

Method Summary

Modifier and Type	Method and Description
EmbeddedType	getEmbeddedType() Get the EmbeddedType of the property indicating what what type of embedding pathway will be used to store the property.
String	getFieldName() Get the name of the field to store this property in Datastore.
boolean	isColumnBacked() True if the property is stored within Datastore entity.
boolean	isDescendants() Whether the property contains entities that are related to this entity via the Cloud Datastore Ancestor relationship and have this entity as their ancestor.
boolean	isReference() True if the property is a POJO and is to be stored in Datastore as a Key of the POJO, which is a separate entity in Datastore.
boolean	isUnindexed() True if the property should be excluded from indexes.

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

findAnnotation, findPropertyOrOwnerAnnotation, getActualType, getAssociation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypes, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isImmutable, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess

Method Detail

getFieldName

String getFieldName()

Get the name of the field to store this property in Datastore.

Returns:

the string name of the field.

isReference

boolean isReference()

True if the property is a POJO and is to be stored in Datastore as a Key of the POJO, which is a separate entity in Datastore.

Returns:

true if the property is stored in Datastore as a Key.

isDescendants

boolean isDescendants()

Whether the property contains entities that are related to this entity via the Cloud Datastore Ancestor relationship and have this entity as their ancestor.

Returns:

true if the property contains child entities. false otherwise.

isUnindexed

boolean isUnindexed()

True if the property should be excluded from indexes.

Returns:

true if the property should be indexed

getEmbeddedType

EmbeddedType getEmbeddedType()

Get the EmbeddedType of the property indicating what what type of embedding pathway will be used to store the property.

Returns:

the embedded type.

isColumnBacked

boolean isColumnBacked()

True if the property is stored within Datastore entity.

Returns:

true if the property is stored within Datastore entity