org.springframework.data.cassandra.core.mapping

Interface CassandraPersistentEntity<T>

All Superinterfaces:

Iterable<CassandraPersistentProperty>, PersistentEntity<T,CassandraPersistentProperty>

All Known Implementing Classes:

BasicCassandraPersistentEntity, BasicCassandraPersistentTupleEntity, CassandraUserTypePersistentEntity

public interface CassandraPersistentEntity<T>
extends PersistentEntity<T,CassandraPersistentProperty>

Cassandra specific PersistentEntity abstraction.

Author:

Alex Shvid, Matthew T. Adams, Mark Paluch

Property Summary

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

hasIdProperty, hasVersionProperty

Method Summary

Modifier and Type	Method and Description
CqlIdentifier	getTableName() Returns the table name to which the entity shall be persisted.
com.datastax.driver.core.TupleType	getTupleType()
com.datastax.driver.core.UserType	getUserType()
boolean	isCompositePrimaryKey() Returns whether this entity represents a composite primary key.
boolean	isTupleType()
boolean	isUserDefinedType()
void	setForceQuote(boolean forceQuote) Sets whether to enforce quoting when using the getTableName() in CQL.
void	setTableName(CqlIdentifier tableName) Sets the CQL table name.

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

doWithAssociations, 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, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isCompositePrimaryKey

boolean isCompositePrimaryKey()

Returns whether this entity represents a composite primary key.

setForceQuote

void setForceQuote(boolean forceQuote)

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

Parameters:

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

getTableName

CqlIdentifier getTableName()

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

setTableName

void setTableName(CqlIdentifier tableName)

Sets the CQL table name.

Parameters:

tableName - must not be null.

isTupleType

boolean isTupleType()

Returns:

true if the type is a mapped tuple type.

Since:

2.1

See Also:

Tuple

getTupleType

@Nullable
com.datastax.driver.core.TupleType getTupleType()

Returns:

the TupleType matching the data types from mapped tuple elements.

Since:

2.1

isUserDefinedType

boolean isUserDefinedType()

Returns:

true if the type is a mapped user defined type.

Since:

1.5

See Also:

UserDefinedType

getUserType

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

Returns:

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

Since:

1.5

See Also:

UserDefinedType