org.springframework.data.cassandra.core.mapping

Interface CassandraPersistentProperty

All Superinterfaces:

ApplicationContextAware, Aware, PersistentProperty<CassandraPersistentProperty>

All Known Implementing Classes:

BasicCassandraPersistentProperty, BasicCassandraPersistentTupleProperty

public interface CassandraPersistentProperty
extends PersistentProperty<CassandraPersistentProperty>, ApplicationContextAware

Cassandra specific PersistentProperty extension.

Author:

Alex Shvid, Matthew T. Adams, David T. Webb, Mark Paluch, John Blum

Property Summary

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

isIdProperty, isVersionProperty

Method Summary

Modifier and Type	Method and Description
AnnotatedType	findAnnotatedType(Class<? extends Annotation> annotationType) Find an AnnotatedType by annotationType derived from the property type.
CqlIdentifier	getColumnName() The name of the single column to which the property is persisted.
com.datastax.driver.core.DataType	getDataType() The column's data type.
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.
default CqlIdentifier	getRequiredColumnName() The name of the single column to which the property is persisted.
default int	getRequiredOrdinal() The required element ordinal to which the property is persisted when the owning type is a mapped tuple.
boolean	isClusterKeyColumn() Whether the property is a cluster key column.
boolean	isCompositePrimaryKey() Whether the property is a composite primary key.
boolean	isMapLike() Returns whether the property is a Map.
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	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, 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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Method Detail

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 - must not be null.

getColumnName

@Nullable
CqlIdentifier getColumnName()

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

getRequiredColumnName

default CqlIdentifier getRequiredColumnName()

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

Throws:

IllegalStateException - if the required column name is not available.

Since:

2.1

getDataType

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

The column's data type. Not valid for a composite primary key.

Returns:

the Cassandra DataType

Throws:

InvalidDataAccessApiUsageException - if the DataType cannot be resolved

See Also:

CassandraType

setForceQuote

void setForceQuote(boolean forceQuote)

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

Parameters:

forceQuote - true to enforce quoting.

See Also:

getColumnName()

getOrdinal

@Nullable
Integer getOrdinal()

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

getRequiredOrdinal

default int getRequiredOrdinal()

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

Throws:

IllegalStateException - if the required ordinal is not available.

Since:

2.1

getPrimaryKeyOrdering

@Nullable
Ordering getPrimaryKeyOrdering()

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

isClusterKeyColumn

boolean isClusterKeyColumn()

Whether the property is a cluster key column.

isCompositePrimaryKey

boolean isCompositePrimaryKey()

Whether the property is a composite primary key.

isMapLike

boolean isMapLike()

Returns whether the property is a Map.

Returns:

a boolean indicating whether this property type is a Map.

isPartitionKeyColumn

boolean isPartitionKeyColumn()

Whether the property is a partition key column.

isPrimaryKeyColumn

boolean isPrimaryKeyColumn()

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

See Also:

isPartitionKeyColumn(), isClusterKeyColumn()

findAnnotatedType

@Nullable
AnnotatedType findAnnotatedType(Class<? extends Annotation> annotationType)

Find an AnnotatedType by annotationType derived from the property type. Annotated type is looked up by introspecting property field/accessors. Collection/Map-like types are introspected for type annotations within type arguments.

Parameters:

annotationType - must not be null.

Returns:

the annotated type or null.

Since:

2.0