org.springframework.data.cassandra.mapping

Interface CassandraPersistentProperty

All Superinterfaces:

ApplicationContextAware, Aware, PersistentProperty<CassandraPersistentProperty>

All Known Implementing Classes:

BasicCassandraPersistentProperty

public interface CassandraPersistentProperty
extends PersistentProperty<CassandraPersistentProperty>, ApplicationContextAware

Cassandra specific PersistentProperty extension.

Author:

Alex Shvid, Matthew T. Adams, David T. Webb

Property Summary

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

isIdProperty, isVersionProperty

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CassandraPersistentProperty.PropertyToFieldNameConverter

Method Summary

Modifier and Type	Method and Description
CqlIdentifier	getColumnName() The name of the single column to which the property is persisted.
List<CqlIdentifier>	getColumnNames() The names of the columns to which the property is persisted if this is a composite primary key property.
CassandraPersistentEntity<?>	getCompositePrimaryKeyEntity() Returns a CassandraPersistentEntity representing the composite primary key class of this entity, or null if this class does not use a composite primary key.
List<CassandraPersistentProperty>	getCompositePrimaryKeyProperties() Gets the list of composite primary key properties that this composite primary key field is a placeholder for.
TypeInformation<?>	getCompositePrimaryKeyTypeInformation() Returns a TypeInformation representing the type of the composite primary key class of this entity, or null if this class does not use a composite primary key.
com.datastax.driver.core.DataType	getDataType() The column's data type.
CassandraPersistentEntity<?>	getOwner()
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	isIndexed() Whether the property has a secondary index on this column.
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
void	setColumnName(CqlIdentifier columnName) If this property is mapped with a single column, set the column name to the given CqlIdentifier.
void	setColumnNames(List<CqlIdentifier> columnNames) Sets this property's column names to the collection given.
void	setForceQuote(boolean forceQuote) Whether to force-quote the column names of this property.

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

findAnnotation, findPropertyOrOwnerAnnotation, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityType, getRawType, getSetter, getSpelExpression, getType, getTypeInformation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Method Detail

isCompositePrimaryKey

boolean isCompositePrimaryKey()

Whether the property is a composite primary key.

getCompositePrimaryKeyEntity

CassandraPersistentEntity<?> getCompositePrimaryKeyEntity()

Returns a CassandraPersistentEntity representing the composite primary key class of this entity, or null if this class does not use a composite primary key.

getCompositePrimaryKeyTypeInformation

TypeInformation<?> getCompositePrimaryKeyTypeInformation()

Returns a TypeInformation representing the type of the composite primary key class of this entity, or null if this class does not use a composite primary key.

getCompositePrimaryKeyProperties

List<CassandraPersistentProperty> getCompositePrimaryKeyProperties()

Gets the list of composite primary key properties that this composite primary key field is a placeholder for.

getColumnName

CqlIdentifier getColumnName()

The name of the single column to which the property is persisted. This is a convenience method when the caller knows that the property is mapped to a single column. Throws IllegalStateException if this property is mapped to multiple columns.

getColumnNames

List<CqlIdentifier> getColumnNames()

The names of the columns to which the property is persisted if this is a composite primary key property. Never returns null.

getPrimaryKeyOrdering

Ordering getPrimaryKeyOrdering()

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

getDataType

com.datastax.driver.core.DataType getDataType()

The column's data type. Not valid for a composite primary key, in which case this method returns null.

isIndexed

boolean isIndexed()

Whether the property has a secondary index on this column.

isPartitionKeyColumn

boolean isPartitionKeyColumn()

Whether the property is a partition key column.

isClusterKeyColumn

boolean isClusterKeyColumn()

Whether the property is a cluster key column.

isPrimaryKeyColumn

boolean isPrimaryKeyColumn()

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

See Also:

isPartitionKeyColumn(), isClusterKeyColumn()

getOwner

CassandraPersistentEntity<?> getOwner()

Specified by:

getOwner in interface PersistentProperty<CassandraPersistentProperty>

setForceQuote

void setForceQuote(boolean forceQuote)

Whether to force-quote the column names of this property.

Parameters:

forceQuote -

See Also:

getColumnNames()

setColumnName

void setColumnName(CqlIdentifier columnName)

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.

Parameters:

columnName -

setColumnNames

void setColumnNames(List<CqlIdentifier> columnNames)

Sets this property's column names to the collection given. The given collection must have the same size as this property's current list of column names, and must contain no null elements.

Parameters:

columnName -