Package org.springframework.data.cassandra.core.mapping

Class BasicCassandraPersistentTupleProperty

java.lang.Object

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

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

org.springframework.data.cassandra.core.mapping.BasicCassandraPersistentProperty

org.springframework.data.cassandra.core.mapping.BasicCassandraPersistentTupleProperty

All Implemented Interfaces:

Aware, ApplicationContextAware, CassandraPersistentProperty, PersistentProperty<CassandraPersistentProperty>

public class BasicCassandraPersistentTupleProperty
extends BasicCassandraPersistentProperty

Cassandra Tuple specific CassandraPersistentProperty implementation.

Since:

2.1

Author:

Mark Paluch, Frank Spitulski, Aleksei Zotov

See Also:

• Element

Constructor Summary

Constructors

Constructor	Description
BasicCassandraPersistentTupleProperty(Property property, CassandraPersistentEntity<?> owner, SimpleTypeHolder simpleTypeHolder)	Create a new BasicCassandraPersistentTupleProperty.

Method Summary

Modifier and Type	Method	Description
com.datastax.oss.driver.api.core.CqlIdentifier	getColumnName()	The name of the single column to which the property is persisted.
Integer	getOrdinal()	The name of the element ordinal to which the property is persisted when the owning type is a mapped tuple.
Ordering	getPrimaryKeyOrdering()	The ordering (ascending or descending) for the column.
boolean	isClusterKeyColumn()	Whether the property is a cluster key column.
boolean	isCompositePrimaryKey()	Whether the property is a composite primary key.
boolean	isEmbedded()
boolean	isPartitionKeyColumn()	Whether the property is a partition key column.
boolean	isPrimaryKeyColumn()	Whether the property is a partition key column or a cluster key column
boolean	isStaticColumn()	Whether the property maps to a static column.
void	setColumnName(com.datastax.oss.driver.api.core.CqlIdentifier columnName)	If this property is mapped with a single column, set the column name to the given CqlIdentifier.

Methods inherited from class org.springframework.data.cassandra.core.mapping.BasicCassandraPersistentProperty

createAssociation, findAnnotatedType, getAssociation, getOwner, hasExplicitColumnName, isMapLike, setApplicationContext, setForceQuote, setNamingStrategy

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

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

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

equals, getActualType, getActualTypeInformation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityTypeInformation, getProperty, getRawType, getSetter, getType, getTypeInformation, getWither, hashCode, isArray, isCollectionLike, isEntity, isImmutable, isMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.cassandra.core.mapping.CassandraPersistentProperty

getRequiredColumnName, getRequiredOrdinal, hasOrdinal, setColumnName

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

findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityTypeInformation, 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

Constructor Details

BasicCassandraPersistentTupleProperty

public BasicCassandraPersistentTupleProperty(Property property,
 CassandraPersistentEntity<?> owner,
 SimpleTypeHolder simpleTypeHolder)

Create a new BasicCassandraPersistentTupleProperty.

Parameters:

property - the actual Property in the domain entity corresponding to this persistent entity.

owner - the containing object or CassandraPersistentEntity of this persistent property.

simpleTypeHolder - mapping of Java [simple|wrapper] types to Cassandra data types.

Method Details

getColumnName

public com.datastax.oss.driver.api.core.CqlIdentifier getColumnName()

Description copied from interface: CassandraPersistentProperty

The name of the single column to which the property is persisted.

Specified by:

getColumnName in interface CassandraPersistentProperty

Overrides:

getColumnName in class BasicCassandraPersistentProperty

getOrdinal

@Nullable
public Integer getOrdinal()

Description copied from interface: CassandraPersistentProperty

The name of the element ordinal to which the property is persisted when the owning type is a mapped tuple.

Specified by:

getOrdinal in interface CassandraPersistentProperty

Overrides:

getOrdinal in class BasicCassandraPersistentProperty

getPrimaryKeyOrdering

@Nullable
public Ordering getPrimaryKeyOrdering()

Description copied from interface: CassandraPersistentProperty

The ordering (ascending or descending) for the column. Valid only for primary key columns; returns null for non-primary key columns.

Specified by:

getPrimaryKeyOrdering in interface CassandraPersistentProperty

Overrides:

getPrimaryKeyOrdering in class BasicCassandraPersistentProperty

isClusterKeyColumn

public boolean isClusterKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a cluster key column.

Specified by:

isClusterKeyColumn in interface CassandraPersistentProperty

Overrides:

isClusterKeyColumn in class BasicCassandraPersistentProperty

isCompositePrimaryKey

public boolean isCompositePrimaryKey()

Description copied from interface: CassandraPersistentProperty

Whether the property is a composite primary key.

Specified by:

isCompositePrimaryKey in interface CassandraPersistentProperty

Overrides:

isCompositePrimaryKey in class BasicCassandraPersistentProperty

isPartitionKeyColumn

public boolean isPartitionKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a partition key column.

Specified by:

isPartitionKeyColumn in interface CassandraPersistentProperty

Overrides:

isPartitionKeyColumn in class BasicCassandraPersistentProperty

isPrimaryKeyColumn

public boolean isPrimaryKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a partition key column or a cluster key column

Specified by:

isPrimaryKeyColumn in interface CassandraPersistentProperty

Overrides:

isPrimaryKeyColumn in class BasicCassandraPersistentProperty

See Also:

• CassandraPersistentProperty.isPartitionKeyColumn()
• CassandraPersistentProperty.isClusterKeyColumn()

isStaticColumn

public boolean isStaticColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property maps to a static column.

Specified by:

isStaticColumn in interface CassandraPersistentProperty

Overrides:

isStaticColumn in class BasicCassandraPersistentProperty

isEmbedded

public boolean isEmbedded()

Returns:

true if the property should be embedded.

setColumnName

public void setColumnName(com.datastax.oss.driver.api.core.CqlIdentifier columnName)

Description copied from interface: CassandraPersistentProperty

If this property is mapped with a single column, set the column name to the given CqlIdentifier. If this property is not mapped by a single column, throws IllegalStateException. If the given column name is null, IllegalArgumentException is thrown.

Specified by:

setColumnName in interface CassandraPersistentProperty

Overrides:

setColumnName in class BasicCassandraPersistentProperty

Parameters:

columnName - must not be null.