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

Class BasicCassandraPersistentProperty

java.lang.Object

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

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

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

All Implemented Interfaces:

Aware, ApplicationContextAware, CassandraPersistentProperty, PersistentProperty<CassandraPersistentProperty>

Direct Known Subclasses:

BasicCassandraPersistentTupleProperty, CachingCassandraPersistentProperty

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

Cassandra specific AnnotationBasedPersistentProperty implementation.

Author:

Alex Shvid, Matthew T. Adams, Antoine Toulme, Mark Paluch, John Blum, Aleksei Zotov

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Association<CassandraPersistentProperty>	createAssociation()
AnnotatedType	findAnnotatedType(Class<? extends Annotation> annotationType)	Find an AnnotatedType by annotationType derived from the property type.
Association<CassandraPersistentProperty>	getAssociation()
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.
CassandraPersistentEntity<?>	getOwner()
Ordering	getPrimaryKeyOrdering()	The ordering (ascending or descending) for the column.
boolean	hasExplicitColumnName()	Return whether the property has an explicitly configured column name.
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
boolean	isStaticColumn()	Whether the property maps to a static column.
void	setApplicationContext(ApplicationContext context)
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.
void	setForceQuote(boolean forceQuote)	Whether to force-quote the column names of this property.
void	setNamingStrategy(NamingStrategy namingStrategy)	Set the NamingStrategy to use.

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, isReadable

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, isEmbedded, 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, isReadable, isTransient, isVersionProperty, isWritable, usePropertyAccess

Constructor Details

BasicCassandraPersistentProperty

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

Create a new BasicCassandraPersistentProperty.

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

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

getOwner

public CassandraPersistentEntity<?> getOwner()

Specified by:

getOwner in interface PersistentProperty<CassandraPersistentProperty>

Overrides:

getOwner in class AbstractPersistentProperty<CassandraPersistentProperty>

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

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

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

isCompositePrimaryKey

public boolean isCompositePrimaryKey()

Description copied from interface: CassandraPersistentProperty

Whether the property is a composite primary key.

Specified by:

isCompositePrimaryKey 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

isPartitionKeyColumn

public boolean isPartitionKeyColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property is a partition key column.

Specified by:

isPartitionKeyColumn 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()

isStaticColumn

public boolean isStaticColumn()

Description copied from interface: CassandraPersistentProperty

Whether the property maps to a static column.

Specified by:

isStaticColumn in interface CassandraPersistentProperty

hasExplicitColumnName

public boolean hasExplicitColumnName()

Description copied from interface: CassandraPersistentProperty

Return whether the property has an explicitly configured column name. Eg. via Column.value(), PrimaryKey.value() or PrimaryKeyColumn.name()

Specified by:

hasExplicitColumnName in interface CassandraPersistentProperty

Returns:

true if a configured column name is present and non empty.

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

Parameters:

columnName - must not be null.

setNamingStrategy

public void setNamingStrategy(NamingStrategy namingStrategy)

Set the NamingStrategy to use.

Parameters:

namingStrategy - must not be null.

Since:

3.0

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

Parameters:

forceQuote - true to enforce quoting.

See Also:

• CassandraPersistentProperty.getColumnName()
• CqlIdentifier.fromInternal(String)

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>

isMapLike

public boolean isMapLike()

Description copied from interface: CassandraPersistentProperty

Returns whether the property is a Map.

Specified by:

isMapLike in interface CassandraPersistentProperty

Returns:

a boolean indicating whether this property type is a Map.

findAnnotatedType

public AnnotatedType findAnnotatedType(Class<? extends Annotation> annotationType)

Description copied from interface: CassandraPersistentProperty

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.

Specified by:

findAnnotatedType in interface CassandraPersistentProperty

Parameters:

annotationType - must not be null.

Returns:

the annotated type or null.