org.springframework.data.cassandra.mapping

Class BasicCassandraPersistentProperty

java.lang.Object

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

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

org.springframework.data.cassandra.mapping.BasicCassandraPersistentProperty

All Implemented Interfaces:

Aware, ApplicationContextAware, CassandraPersistentProperty, PersistentProperty<CassandraPersistentProperty>

public class BasicCassandraPersistentProperty
extends AnnotationBasedPersistentProperty<CassandraPersistentProperty>
implements CassandraPersistentProperty, ApplicationContextAware

Cassandra specific AnnotationBasedPersistentProperty implementation.

Author:

Alex Shvid, Matthew T. Adams

Property Summary

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

isIdProperty, isVersionProperty

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

isIdProperty, isVersionProperty

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.mapping.CassandraPersistentProperty

CassandraPersistentProperty.PropertyToFieldNameConverter

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CqlIdentifier>	columnNames An unmodifiable list of this property's column names.
protected ApplicationContext	context
protected List<CqlIdentifier>	explicitColumnNames An unmodifiable list of this property's explicitly set column names.
protected Boolean	forceQuote Whether this property has been explicitly instructed to force quote column names.
protected StandardEvaluationContext	spelContext

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

association, field, information, name, owner, propertyDescriptor, rawType

Constructor Summary

Constructors

Constructor and Description
BasicCassandraPersistentProperty(Field field, PropertyDescriptor propertyDescriptor, CassandraPersistentEntity<?> owner, CassandraSimpleTypeHolder simpleTypeHolder) Creates a new BasicCassandraPersistentProperty.

Method Summary

Modifier and Type	Method and Description
protected void	addCompositePrimaryKeyColumnNames(CassandraPersistentEntity<?> compositePrimaryKeyEntity, List<CqlIdentifier> columnNames)
protected Association<CassandraPersistentProperty>	createAssociation()
protected CqlIdentifier	createColumnName(String defaultName, String overriddenName, boolean forceQuote)
protected List<CqlIdentifier>	determineColumnNames()
protected void	ensureTypeArguments(int args, int expected)
Association<CassandraPersistentProperty>	getAssociation()
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.
Class<?>	getCompositePrimaryKeyType()
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.
protected com.datastax.driver.core.DataType	getDataTypeFor(Class<?> javaType)
protected com.datastax.driver.core.DataType	getDataTypeFor(com.datastax.driver.core.DataType.Name typeName)
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	setApplicationContext(ApplicationContext context)
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 class org.springframework.data.mapping.model.AnnotationBasedPersistentProperty

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

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

equals, getActualType, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityType, getRawType, getSetter, getType, getTypeInformation, hashCode, isArray, isCollectionLike, isEntity, isMap

Methods inherited from class java.lang.Object

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

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

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

Field Detail

context

protected ApplicationContext context

spelContext

protected StandardEvaluationContext spelContext

columnNames

protected List<CqlIdentifier> columnNames

An unmodifiable list of this property's column names.

explicitColumnNames

protected List<CqlIdentifier> explicitColumnNames

An unmodifiable list of this property's explicitly set column names.

forceQuote

protected Boolean forceQuote

Whether this property has been explicitly instructed to force quote column names.

Constructor Detail

BasicCassandraPersistentProperty

public BasicCassandraPersistentProperty(Field field,
                                        PropertyDescriptor propertyDescriptor,
                                        CassandraPersistentEntity<?> owner,
                                        CassandraSimpleTypeHolder simpleTypeHolder)

Creates a new BasicCassandraPersistentProperty.

Parameters:

field - the actual Field in the domain entity corresponding to this persistent entity.

propertyDescriptor - a PropertyDescriptor for the corresponding property in the domain entity.

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

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

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

getOwner

public CassandraPersistentEntity<?> getOwner()

Specified by:

getOwner in interface CassandraPersistentProperty

Specified by:

getOwner in interface PersistentProperty<CassandraPersistentProperty>

Overrides:

getOwner in class AbstractPersistentProperty<CassandraPersistentProperty>

isCompositePrimaryKey

public boolean isCompositePrimaryKey()

Description copied from interface: CassandraPersistentProperty

Whether the property is a composite primary key.

Specified by:

isCompositePrimaryKey in interface CassandraPersistentProperty

getCompositePrimaryKeyType

public Class<?> getCompositePrimaryKeyType()

getCompositePrimaryKeyTypeInformation

public TypeInformation<?> getCompositePrimaryKeyTypeInformation()

Description copied from interface: CassandraPersistentProperty

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.

Specified by:

getCompositePrimaryKeyTypeInformation in interface CassandraPersistentProperty

getColumnName

public CqlIdentifier getColumnName()

Description copied from interface: CassandraPersistentProperty

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.

Specified by:

getColumnName in interface CassandraPersistentProperty

getPrimaryKeyOrdering

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

getDataType

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

Description copied from interface: CassandraPersistentProperty

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

Specified by:

getDataType in interface CassandraPersistentProperty

isIndexed

public boolean isIndexed()

Description copied from interface: CassandraPersistentProperty

Whether the property has a secondary index on this column.

Specified by:

isIndexed in interface CassandraPersistentProperty

isPartitionKeyColumn

public boolean isPartitionKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a partition key column.

Specified by:

isPartitionKeyColumn in interface CassandraPersistentProperty

isClusterKeyColumn

public boolean isClusterKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a cluster key column.

Specified by:

isClusterKeyColumn in interface CassandraPersistentProperty

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

See Also:

CassandraPersistentProperty.isPartitionKeyColumn(), CassandraPersistentProperty.isClusterKeyColumn()

getDataTypeFor

protected com.datastax.driver.core.DataType getDataTypeFor(com.datastax.driver.core.DataType.Name typeName)

getDataTypeFor

protected com.datastax.driver.core.DataType getDataTypeFor(Class<?> javaType)

ensureTypeArguments

protected void ensureTypeArguments(int args,
                                   int expected)

getColumnNames

public List<CqlIdentifier> getColumnNames()

Description copied from interface: CassandraPersistentProperty

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

Specified by:

getColumnNames in interface CassandraPersistentProperty

determineColumnNames

protected List<CqlIdentifier> determineColumnNames()

createColumnName

protected CqlIdentifier createColumnName(String defaultName,
                                         String overriddenName,
                                         boolean forceQuote)

addCompositePrimaryKeyColumnNames

protected void addCompositePrimaryKeyColumnNames(CassandraPersistentEntity<?> compositePrimaryKeyEntity,
                                                 List<CqlIdentifier> columnNames)

setColumnName

public void setColumnName(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

setColumnNames

public void setColumnNames(List<CqlIdentifier> columnNames)

Description copied from interface: CassandraPersistentProperty

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.

Specified by:

setColumnNames in interface CassandraPersistentProperty

setForceQuote

public void setForceQuote(boolean forceQuote)

Description copied from interface: CassandraPersistentProperty

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

Specified by:

setForceQuote in interface CassandraPersistentProperty

See Also:

CassandraPersistentProperty.getColumnNames()

getCompositePrimaryKeyProperties

public List<CassandraPersistentProperty> getCompositePrimaryKeyProperties()

Description copied from interface: CassandraPersistentProperty

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

Specified by:

getCompositePrimaryKeyProperties in interface CassandraPersistentProperty

getCompositePrimaryKeyEntity

public CassandraPersistentEntity<?> getCompositePrimaryKeyEntity()

Description copied from interface: CassandraPersistentProperty

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

Specified by:

getCompositePrimaryKeyEntity in interface CassandraPersistentProperty

getAssociation

public Association<CassandraPersistentProperty> getAssociation()

Specified by:

getAssociation in interface PersistentProperty<CassandraPersistentProperty>

Overrides:

getAssociation in class AbstractPersistentProperty<CassandraPersistentProperty>

createAssociation

protected Association<CassandraPersistentProperty> createAssociation()

Specified by:

createAssociation in class AbstractPersistentProperty<CassandraPersistentProperty>