Package 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

Method Summary

Modifier and Type	Method	Description
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.
boolean	isCompositePrimaryKey()	Returns whether this entity represents a composite primary key.
boolean	isTupleType()
boolean	isUserDefinedType()
void	setForceQuote(boolean forceQuote)	Deprecated. since 3.0.
void	setTableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Sets the CQL table name.
default void	setTableName(CqlIdentifier tableName)	Deprecated. since 3.0, use setTableName(CqlIdentifier) instead.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

doWithAll, doWithAssociations, 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

Method Details

getProperty

@Nullable
CassandraPersistentProperty getProperty(Parameter<?,CassandraPersistentProperty> parameter)

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.

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.

Since:

4.2.3

isCompositePrimaryKey

boolean isCompositePrimaryKey()

Returns whether this entity represents a composite primary key.

setForceQuote

@Deprecated
void setForceQuote(boolean forceQuote)

Deprecated.

since 3.0. The table name gets converted into CqlIdentifier hence it no longer requires an indication whether the name should be quoted.

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

Parameters:

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

See Also:

• CqlIdentifier.fromInternal(String)

getTableName

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

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

setTableName

@Deprecated
default void setTableName(CqlIdentifier tableName)

Deprecated.

since 3.0, use setTableName(CqlIdentifier) instead.

Sets the CQL table name.

Parameters:

tableName - must not be null.

setTableName

void setTableName(com.datastax.oss.driver.api.core.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

isUserDefinedType

boolean isUserDefinedType()

Returns:

true if the type is a mapped user defined type.

Since:

1.5

See Also:

• UserDefinedType