Module spring.data.cassandra

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

Class BasicCassandraPersistentEntity<T>

java.lang.Object

org.springframework.data.mapping.model.BasicPersistentEntity<T,CassandraPersistentProperty>

org.springframework.data.cassandra.core.mapping.BasicCassandraPersistentEntity<T>

All Implemented Interfaces:

Iterable<CassandraPersistentProperty>, Aware, ApplicationContextAware, EnvironmentAware, CassandraPersistentEntity<T>, MutablePersistentEntity<T,CassandraPersistentProperty>, PersistentEntity<T,CassandraPersistentProperty>

Direct Known Subclasses:

BasicCassandraPersistentTupleEntity, CassandraUserTypePersistentEntity

public class BasicCassandraPersistentEntity<T>
extends BasicPersistentEntity<T,CassandraPersistentProperty>
implements CassandraPersistentEntity<T>, ApplicationContextAware

Cassandra specific BasicPersistentEntity implementation that adds Cassandra specific metadata.

Author:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	BasicCassandraPersistentEntity(TypeInformation<T> typeInformation)	Create a new BasicCassandraPersistentEntity given TypeInformation.
	BasicCassandraPersistentEntity(TypeInformation<T> typeInformation, CassandraPersistentEntityMetadataVerifier verifier)	Create a new BasicCassandraPersistentEntity with the given TypeInformation.
protected	BasicCassandraPersistentEntity(TypeInformation<T> typeInformation, CassandraPersistentEntityMetadataVerifier verifier, Comparator<CassandraPersistentProperty> comparator)	Create a new BasicCassandraPersistentEntity with the given TypeInformation.

Method Summary

Modifier and Type	Method	Description
void	addAssociation(Association<CassandraPersistentProperty> association)
protected com.datastax.oss.driver.api.core.CqlIdentifier	determineKeyspace()
protected com.datastax.oss.driver.api.core.CqlIdentifier	determineTableName()
void	doWithAssociations(AssociationHandler<CassandraPersistentProperty> handler)
protected EvaluationContext	getEvaluationContext(Object rootObject)
protected EvaluationContext	getEvaluationContext(Object rootObject, ExpressionDependencies dependencies)
com.datastax.oss.driver.api.core.CqlIdentifier	getKeyspace()	Returns a specific keyspace to which the entity shall be persisted.
CassandraPersistentProperty	getProperty(Parameter<?,CassandraPersistentProperty> parameter)	Retrieve a CassandraPersistentProperty from a persistence creator (constructor/factory method) parameter.
com.datastax.oss.driver.api.core.CqlIdentifier	getTableName()	Returns the table name to which the entity shall be persisted.
protected ValueEvaluationContext	getValueEvaluationContext(Object rootObject)
protected ValueEvaluationContext	getValueEvaluationContext(Object rootObject, ExpressionDependencies dependencies)
CassandraPersistentEntityMetadataVerifier	getVerifier()
boolean	isCompositePrimaryKey()	Returns whether this entity represents a composite primary key.
boolean	isTupleType()
boolean	isUserDefinedType()
void	setApplicationContext(ApplicationContext context)
void	setForceQuote(boolean forceQuote)	Sets whether to enforce quoting when using the CassandraPersistentEntity.getTableName() in CQL.
void	setKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)	Sets the CQL keyspace.
void	setNamingStrategy(NamingStrategy namingStrategy)	Set the NamingStrategy to use.
void	setTableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Sets the CQL table name.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier)
String	toString()
void	verify()

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

addPersistentProperty, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getFallbackIsNewStrategy, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, iterator, requiresPropertyPopulation, returnPropertyIfBetterIdPropertyCandidateOrNull, setEnvironment, setEvaluationContextProvider, setPersistentPropertyAccessorFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getRequiredKeyspace, hasKeyspace, setTableName

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

doWithAll, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

Constructor Details

BasicCassandraPersistentEntity

public BasicCassandraPersistentEntity(TypeInformation<T> typeInformation)

Create a new BasicCassandraPersistentEntity given TypeInformation.

Parameters:

typeInformation - must not be null.

BasicCassandraPersistentEntity

public BasicCassandraPersistentEntity(TypeInformation<T> typeInformation,
 CassandraPersistentEntityMetadataVerifier verifier)

Create a new BasicCassandraPersistentEntity with the given TypeInformation. Will default the table name to the entity's simple type name.

Parameters:

typeInformation - must not be null.

verifier - must not be null.

BasicCassandraPersistentEntity

protected BasicCassandraPersistentEntity(TypeInformation<T> typeInformation,
 CassandraPersistentEntityMetadataVerifier verifier,
 Comparator<CassandraPersistentProperty> comparator)

Create a new BasicCassandraPersistentEntity with the given TypeInformation. Will default the table name to the entity's simple type name.

Parameters:

typeInformation - must not be null.

verifier - must not be null.

comparator - must not be null.

Since:

2.1

Method Details

determineTableName

protected com.datastax.oss.driver.api.core.CqlIdentifier determineTableName()

determineKeyspace

@Nullable
protected com.datastax.oss.driver.api.core.CqlIdentifier determineKeyspace()

getEvaluationContext

protected EvaluationContext getEvaluationContext(Object rootObject)

Overrides:

getEvaluationContext in class BasicPersistentEntity<T,CassandraPersistentProperty>

getEvaluationContext

protected EvaluationContext getEvaluationContext(Object rootObject,
 ExpressionDependencies dependencies)

Overrides:

getEvaluationContext in class BasicPersistentEntity<T,CassandraPersistentProperty>

getValueEvaluationContext

protected ValueEvaluationContext getValueEvaluationContext(Object rootObject)

Overrides:

getValueEvaluationContext in class BasicPersistentEntity<T,CassandraPersistentProperty>

getValueEvaluationContext

protected ValueEvaluationContext getValueEvaluationContext(Object rootObject,
 ExpressionDependencies dependencies)

Overrides:

getValueEvaluationContext in class BasicPersistentEntity<T,CassandraPersistentProperty>

addAssociation

public void addAssociation(Association<CassandraPersistentProperty> association)

Specified by:

addAssociation in interface MutablePersistentEntity<T,CassandraPersistentProperty>

Overrides:

addAssociation in class BasicPersistentEntity<T,CassandraPersistentProperty>

doWithAssociations

public void doWithAssociations(AssociationHandler<CassandraPersistentProperty> handler)

Specified by:

doWithAssociations in interface PersistentEntity<T,CassandraPersistentProperty>

Overrides:

doWithAssociations in class BasicPersistentEntity<T,CassandraPersistentProperty>

isCompositePrimaryKey

public boolean isCompositePrimaryKey()

Description copied from interface: CassandraPersistentEntity

Returns whether this entity represents a composite primary key.

Specified by:

isCompositePrimaryKey in interface CassandraPersistentEntity<T>

verify

public void verify()
            throws MappingException

Specified by:

verify in interface MutablePersistentEntity<T,CassandraPersistentProperty>

Overrides:

verify in class BasicPersistentEntity<T,CassandraPersistentProperty>

Throws:

MappingException

setApplicationContext

public void setApplicationContext(ApplicationContext context)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setForceQuote

public void setForceQuote(boolean forceQuote)

Description copied from interface: CassandraPersistentEntity

Sets whether to enforce quoting when using the CassandraPersistentEntity.getTableName() in CQL.

Specified by:

setForceQuote in interface CassandraPersistentEntity<T>

Parameters:

forceQuote - true to enforce quoting; false to disable enforced quoting usage.

See Also:

• CqlIdentifier.fromInternal(String)

getKeyspace

@Nullable
public com.datastax.oss.driver.api.core.CqlIdentifier getKeyspace()

Description copied from interface: CassandraPersistentEntity

Returns a specific keyspace to which the entity shall be persisted. If the entity isn't associated with a specific keyspace, then the entity is persisted in the keyspace associated with the Cassandra session.

Specified by:

getKeyspace in interface CassandraPersistentEntity<T>

setKeyspace

public void setKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)

Description copied from interface: CassandraPersistentEntity

Sets the CQL keyspace.

Specified by:

setKeyspace in interface CassandraPersistentEntity<T>

Parameters:

keyspace - must not be null.

getTableName

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

Description copied from interface: CassandraPersistentEntity

Returns the table name to which the entity shall be persisted.

Specified by:

getTableName in interface CassandraPersistentEntity<T>

setTableName

public void setTableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Description copied from interface: CassandraPersistentEntity

Sets the CQL table name.

Specified by:

setTableName in interface CassandraPersistentEntity<T>

Parameters:

tableName - must not be null.

setNamingStrategy

public void setNamingStrategy(NamingStrategy namingStrategy)

Set the NamingStrategy to use.

Parameters:

namingStrategy - must not be null.

Since:

3.0

setVerifier

public void setVerifier(CassandraPersistentEntityMetadataVerifier verifier)

Parameters:

verifier - The verifier to set.

getVerifier

public CassandraPersistentEntityMetadataVerifier getVerifier()

Returns:

the verifier.

isTupleType

public boolean isTupleType()

Specified by:

isTupleType in interface CassandraPersistentEntity<T>

Returns:

true if the type is a mapped tuple type.

See Also:

• Tuple

isUserDefinedType

public boolean isUserDefinedType()

Specified by:

isUserDefinedType in interface CassandraPersistentEntity<T>

Returns:

true if the type is a mapped user defined type.

See Also:

• UserDefinedType

getProperty

public CassandraPersistentProperty getProperty(Parameter<?,CassandraPersistentProperty> parameter)

Description copied from interface: CassandraPersistentEntity

Retrieve a CassandraPersistentProperty from a persistence creator (constructor/factory method) parameter. Parameters are either derived by name or synthesized if their name does not map to a existing property.

Specified by:

getProperty in interface CassandraPersistentEntity<T>

Parameters:

parameter - the parameter to create a property from. Parameters without a name return no (null) parameter.

Returns:

the property, synthetic property or null, if the parameter is unnamed.

toString

public String toString()

Overrides:

toString in class Object