SpannerCompositeKeyProperty (Spring Cloud GCP Documentation 1.0.0.M4 API)

java.lang.Object
- org.springframework.cloud.gcp.data.spanner.core.mapping.SpannerCompositeKeyProperty

All Implemented Interfaces:

SpannerPersistentProperty, org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
```
public class SpannerCompositeKeyProperty
extends Object
implements SpannerPersistentProperty
```
Represents an persistent property just to represent Spanner primary keys, and does not correspond to actual properties of POJOs, as it might even be a composite, multi-column key.

Author:

Chengyuan Zhao

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`boolean`	`isId` Gets the value of the property idProperty.
`boolean`	`isVersion` Gets the value of the property versionProperty.

Constructor Summary

Constructors
Constructor and Description
`SpannerCompositeKeyProperty(SpannerPersistentEntity spannerPersistentEntity, SpannerPersistentProperty[] primaryKeyColumns)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<A extends Annotation> A`	`findAnnotation(Class<A> annotationType)`
`<A extends Annotation> A`	`findPropertyOrOwnerAnnotation(Class<A> annotationType)`
`Class<?>`	`getActualType()`
`org.springframework.data.mapping.Association<SpannerPersistentProperty>`	`getAssociation()`
`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 Cloud Spanner table mapped to this property.
`Class<?>`	`getComponentType()`
`Field`	`getField()`
`Method`	`getGetter()`
`Class<?>`	`getMapValueType()`
`OptionalLong`	`getMaxColumnLength()` Gets the maximum data length of the column if provided.
`String`	`getName()`
`org.springframework.data.mapping.PersistentEntity<?,SpannerPersistentProperty>`	`getOwner()`
`Iterable<? extends org.springframework.data.util.TypeInformation<?>>`	`getPersistentEntityType()` Deprecated.
`OptionalInt`	`getPrimaryKeyOrder()` Gets the order of this column if it is part of the table's primary key.
`Class<?>`	`getRawType()`
`Method`	`getSetter()`
`String`	`getSpelExpression()`
`Class<?>`	`getType()`
`org.springframework.data.util.TypeInformation<?>`	`getTypeInformation()`
`boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationType)`
`boolean`	`isArray()`
`boolean`	`isAssociation()`
`boolean`	`isCollectionLike()`
`boolean`	`isEntity()`
`boolean`	`isIdProperty()` Gets the value of the property idProperty.
`boolean`	`isMap()`
`boolean`	`isMapped()` True if property corresponds to a column a Cloud Spanner table or child entities stored in Cloud Spanner.
`boolean`	`isTransient()`
`boolean`	`isVersionProperty()` Gets the value of the property versionProperty.
`boolean`	`isWritable()`
`boolean`	`usePropertyAccess()`

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.PersistentProperty
getPersistentEntityTypes, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter

- Property Detail
  - isId
```
public boolean isIdProperty
```
    Gets the value of the property idProperty.
    
    Specified by:
    
    isIdProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isVersion
```
public boolean isVersionProperty
```
    Gets the value of the property versionProperty.
    
    Specified by:
    
    isVersionProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
- Constructor Detail
  - SpannerCompositeKeyProperty
```
public SpannerCompositeKeyProperty(SpannerPersistentEntity spannerPersistentEntity,
                                   SpannerPersistentProperty[] primaryKeyColumns)
```
- Method Detail
  - getColumnName
```
public String getColumnName()
```
    Description copied from interface: SpannerPersistentProperty
    
    Gets the name of the column in the Google Cloud Spanner table mapped to this property.
    
    Specified by:
    
    getColumnName in interface SpannerPersistentProperty
    
    Returns:
    
    the name of the column.
  - 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.
  - getOwner
```
public org.springframework.data.mapping.PersistentEntity<?,SpannerPersistentProperty> getOwner()
```
    Specified by:
    
    getOwner in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getType
```
public Class<?> getType()
```
    Specified by:
    
    getType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getTypeInformation
```
public org.springframework.data.util.TypeInformation<?> getTypeInformation()
```
    Specified by:
    
    getTypeInformation in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getPersistentEntityType
```
@Deprecated
public Iterable<? extends org.springframework.data.util.TypeInformation<?>> getPersistentEntityType()
```
    Deprecated.
    
    Specified by:
    
    getPersistentEntityType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getGetter
```
@Nullable
public Method getGetter()
```
    Specified by:
    
    getGetter in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getSetter
```
@Nullable
public Method getSetter()
```
    Specified by:
    
    getSetter in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getField
```
@Nullable
public Field getField()
```
    Specified by:
    
    getField in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getSpelExpression
```
@Nullable
public String getSpelExpression()
```
    Specified by:
    
    getSpelExpression in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getAssociation
```
@Nullable
public org.springframework.data.mapping.Association<SpannerPersistentProperty> getAssociation()
```
    Specified by:
    
    getAssociation in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isEntity
```
public boolean isEntity()
```
    Specified by:
    
    isEntity in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isIdProperty
```
public boolean isIdProperty()
```
    Gets the value of the property idProperty.
    
    Specified by:
    
    isIdProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isVersionProperty
```
public boolean isVersionProperty()
```
    Gets the value of the property versionProperty.
    
    Specified by:
    
    isVersionProperty in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isCollectionLike
```
public boolean isCollectionLike()
```
    Specified by:
    
    isCollectionLike in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isMap
```
public boolean isMap()
```
    Specified by:
    
    isMap in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isArray
```
public boolean isArray()
```
    Specified by:
    
    isArray in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isTransient
```
public boolean isTransient()
```
    Specified by:
    
    isTransient in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isWritable
```
public boolean isWritable()
```
    Specified by:
    
    isWritable in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isAssociation
```
public boolean isAssociation()
```
    Specified by:
    
    isAssociation in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getComponentType
```
@Nullable
public Class<?> getComponentType()
```
    Specified by:
    
    getComponentType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getRawType
```
public Class<?> getRawType()
```
    Specified by:
    
    getRawType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getMapValueType
```
@Nullable
public Class<?> getMapValueType()
```
    Specified by:
    
    getMapValueType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - getActualType
```
public Class<?> getActualType()
```
    Specified by:
    
    getActualType in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - findAnnotation
```
@Nullable
public <A extends Annotation> A findAnnotation(Class<A> annotationType)
```
    Specified by:
    
    findAnnotation in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - findPropertyOrOwnerAnnotation
```
@Nullable
public <A extends Annotation> A findPropertyOrOwnerAnnotation(Class<A> annotationType)
```
    Specified by:
    
    findPropertyOrOwnerAnnotation in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - isAnnotationPresent
```
public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
```
    Specified by:
    
    isAnnotationPresent in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>
  - usePropertyAccess
```
public boolean usePropertyAccess()
```
    Specified by:
    
    usePropertyAccess in interface org.springframework.data.mapping.PersistentProperty<SpannerPersistentProperty>

Class SpannerCompositeKeyProperty

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Property Detail

isId

isVersion

Constructor Detail

SpannerCompositeKeyProperty

Method Detail

getColumnName

getColumnInnerType

getPrimaryKeyOrder

isMapped

getMaxColumnLength

getOwner

getName

getType

getTypeInformation

getPersistentEntityType

getGetter

getSetter

getField

getSpelExpression

getAssociation

isEntity

isIdProperty

isVersionProperty

isCollectionLike

isMap

isArray

isTransient

isWritable

isAssociation

getComponentType

getRawType

getMapValueType

getActualType

findAnnotation

findPropertyOrOwnerAnnotation

isAnnotationPresent

usePropertyAccess