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 TypeMethodDescriptioncom.datastax.oss.driver.api.core.CqlIdentifier
Returns a specific keyspace to which the entity shall be persisted.getProperty
(Parameter<?, CassandraPersistentProperty> parameter) default com.datastax.oss.driver.api.core.CqlIdentifier
Returns the required keyspace name or throwsIllegalStateException
if the entity isn't associated with a specific keyspace.com.datastax.oss.driver.api.core.CqlIdentifier
Returns the table name to which the entity shall be persisted.default boolean
Returnstrue
if the entity is associated with a specific keyspace;false
otherwise.boolean
Returns whether this entity represents a composite primary key.boolean
boolean
void
setForceQuote
(boolean forceQuote) Deprecated.since 3.0.void
setKeyspace
(com.datastax.oss.driver.api.core.CqlIdentifier keyspace) Sets the CQL keyspace.void
setTableName
(com.datastax.oss.driver.api.core.CqlIdentifier tableName) Sets the CQL table name.default void
setTableName
(CqlIdentifier tableName) Deprecated.since 3.0, usesetTableName(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 aCassandraPersistentProperty
from apersistence 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.since 3.0. The table name gets converted intoCqlIdentifier
hence it no longer requires an indication whether the name should be quoted.Sets whether to enforce quoting when using thegetTableName()
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.since 3.0, usesetTableName(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.
-
getKeyspace
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.- Since:
- 4.4
-
getRequiredKeyspace
default com.datastax.oss.driver.api.core.CqlIdentifier getRequiredKeyspace()Returns the required keyspace name or throwsIllegalStateException
if the entity isn't associated with a specific keyspace.- Returns:
- the required keyspace name.
- Throws:
IllegalStateException
- if the entity isn't associated with a specific keyspace.- Since:
- 4.4
-
hasKeyspace
default boolean hasKeyspace()Returnstrue
if the entity is associated with a specific keyspace;false
otherwise.- Returns:
true
if the entity is associated with a specific keyspace;false
otherwise.- Since:
- 4.4
-
setKeyspace
void setKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace) Sets the CQL keyspace.- Parameters:
keyspace
- must not be null.- Since:
- 4.4
-
isTupleType
boolean isTupleType()- Returns:
- true if the type is a mapped tuple type.
- Since:
- 2.1
- See Also:
-
isUserDefinedType
boolean isUserDefinedType()- Returns:
- true if the type is a mapped user defined type.
- Since:
- 1.5
- See Also:
-