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, CassandraPersistentEntity<T>, MutablePersistentEntity<T,CassandraPersistentProperty>, PersistentEntity<T,CassandraPersistentProperty>

Direct Known Subclasses:

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

Property Summary

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

hasIdProperty, hasVersionProperty

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

hasIdProperty, hasVersionProperty

Constructor Summary

Constructors

Constructor and 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.

Method Summary

Modifier and Type	Method and Description
void	addAssociation(Association<CassandraPersistentProperty> association)
protected CqlIdentifier	determineTableName()
void	doWithAssociations(AssociationHandler<CassandraPersistentProperty> handler)
CqlIdentifier	getTableName() Returns the table name to which the entity shall be persisted.
com.datastax.driver.core.UserType	getUserType()
CassandraPersistentEntityMetadataVerifier	getVerifier()
boolean	isCompositePrimaryKey() Returns whether this entity represents a composite primary key.
boolean	isUserDefinedType()
void	setApplicationContext(ApplicationContext context)
void	setForceQuote(boolean forceQuote) Sets whether to enforce quoting when using the CassandraPersistentEntity.getTableName() in CQL.
void	setTableName(CqlIdentifier tableName) Sets the CQL table name.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier)
void	verify()

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

addPersistentProperty, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isIdProperty, isVersionProperty, iterator, returnPropertyIfBetterIdPropertyCandidateOrNull, setPersistentPropertyAccessorFactory

Methods inherited from class java.lang.Object

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

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

doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isIdProperty, isVersionProperty

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

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.

Method Detail

determineTableName

protected CqlIdentifier determineTableName()

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.

setTableName

public void setTableName(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.

getTableName

public 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>

setVerifier

public void setVerifier(CassandraPersistentEntityMetadataVerifier verifier)

Parameters:

verifier - The verifier to set.

getVerifier

public CassandraPersistentEntityMetadataVerifier getVerifier()

Returns:

the verifier.

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

getUserType

@Nullable
public com.datastax.driver.core.UserType getUserType()

Specified by:

getUserType in interface CassandraPersistentEntity<T>

Returns:

the CQL UserType if the type is a mapped user defined type, otherwise null.

See Also:

UserDefinedType