org.springframework.data.cassandra.mapping

Interface CassandraMappingContext

All Superinterfaces:

MappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

All Known Implementing Classes:

BasicCassandraMappingContext

public interface CassandraMappingContext
extends MappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

A MappingContext for Cassandra.

Author:

Matthew T. Adams, Mark Paluch

Method Summary

Modifier and Type	Method and Description
boolean	contains(Class<?> type) Returns whether this CassandraMappingContext already contains a CassandraPersistentEntity for the given type.
CreateTableSpecification	getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity) Returns a CreateTableSpecification for the given entity, including all mapping information.
CreateUserTypeSpecification	getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity) Returns a CreateUserTypeSpecification for the given entity, including all mapping information.
com.datastax.driver.core.DataType	getDataType(CassandraPersistentProperty property) Retrieve the data type of the property.
com.datastax.driver.core.DataType	getDataType(Class<?> type) Retrieve the data type based on the given type.
CassandraPersistentEntity<?>	getExistingPersistentEntity(Class<?> type) Returns the existing CassandraPersistentEntity for the given Class.
Collection<CassandraPersistentEntity<?>>	getNonPrimaryKeyEntities() Deprecated. as of 1.5, use getTableEntities().
Collection<CassandraPersistentEntity<?>>	getPersistentEntities() Returns only those entities that don't represent primary key types.
Collection<CassandraPersistentEntity<?>>	getPersistentEntities(boolean includePrimaryKeyTypesAndUdts) Returns all persistent entities or only non-primary-key entities.
Collection<CassandraPersistentEntity<?>>	getPrimaryKeyEntities() Deprecated. as of 1.5
Collection<CassandraPersistentEntity<?>>	getTableEntities() Returns only Table entities.
Collection<CassandraPersistentEntity<?>>	getUserDefinedTypeEntities() Returns only those entities representing a user defined type.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier) Sets a verifier other than the BasicCassandraPersistentEntityMetadataVerifier
boolean	usesTable(com.datastax.driver.core.TableMetadata table) Returns whether this mapping context has any entities mapped to the given table.
boolean	usesUserType(CqlIdentifier userType) Returns whether this mapping context has any entities using the given user type.
boolean	usesUserType(com.datastax.driver.core.UserType userType) Returns whether this mapping context has any entities using the given user type.

Methods inherited from interface org.springframework.data.mapping.context.MappingContext

getManagedTypes, getPersistentEntity, getPersistentEntity, getPersistentEntity, getPersistentPropertyPath, getPersistentPropertyPath, getPersistentPropertyPath, hasPersistentEntityFor

Method Detail

getPersistentEntities

Collection<CassandraPersistentEntity<?>> getPersistentEntities()

Returns only those entities that don't represent primary key types.

Specified by:

getPersistentEntities in interface MappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

See Also:

getPersistentEntities(boolean)

getPersistentEntities

Collection<CassandraPersistentEntity<?>> getPersistentEntities(boolean includePrimaryKeyTypesAndUdts)

Returns all persistent entities or only non-primary-key entities.

Parameters:

includePrimaryKeyTypesAndUdts - If true, returns all entities, including entities that represent primary key types and user-defined types. If false, returns only entities that don't represent primary key types and no user-defined types.

getNonPrimaryKeyEntities

@Deprecated
Collection<CassandraPersistentEntity<?>> getNonPrimaryKeyEntities()

Deprecated. as of 1.5, use getTableEntities().

Returns only those entities not representing primary key types.

See Also:

getPersistentEntities(boolean)

getPrimaryKeyEntities

@Deprecated
Collection<CassandraPersistentEntity<?>> getPrimaryKeyEntities()

Deprecated. as of 1.5

Returns only those entities representing primary key types.

getTableEntities

Collection<CassandraPersistentEntity<?>> getTableEntities()

Returns only Table entities.

Since:

1.5

getUserDefinedTypeEntities

Collection<CassandraPersistentEntity<?>> getUserDefinedTypeEntities()

Returns only those entities representing a user defined type.

Since:

1.5

See Also:

getPersistentEntities(boolean)

getCreateTableSpecificationFor

CreateTableSpecification getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity)

Returns a CreateTableSpecification for the given entity, including all mapping information.

Parameters:

entity - must not be null.

getCreateUserTypeSpecificationFor

CreateUserTypeSpecification getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity)

Returns a CreateUserTypeSpecification for the given entity, including all mapping information.

Parameters:

entity - must not be null.

usesTable

boolean usesTable(com.datastax.driver.core.TableMetadata table)

Returns whether this mapping context has any entities mapped to the given table.

Parameters:

table - must not be null.

Returns:

@return true is this TableMetadata is used by a mapping.

usesUserType

boolean usesUserType(com.datastax.driver.core.UserType userType)

Returns whether this mapping context has any entities using the given user type.

Parameters:

userType - must not be null.

Returns:

true is this UserType is used.

Since:

1.5

usesUserType

boolean usesUserType(CqlIdentifier userType)

Returns whether this mapping context has any entities using the given user type.

Parameters:

userType - must not be null.

Returns:

true is this UserType is used.

Since:

1.5.12

getExistingPersistentEntity

CassandraPersistentEntity<?> getExistingPersistentEntity(Class<?> type)

Returns the existing CassandraPersistentEntity for the given Class. If it is not yet known to this CassandraMappingContext, an IllegalArgumentException is thrown.

Parameters:

type - The class of the existing persistent entity.

Returns:

The existing persistent entity.

contains

boolean contains(Class<?> type)

Returns whether this CassandraMappingContext already contains a CassandraPersistentEntity for the given type.

setVerifier

void setVerifier(CassandraPersistentEntityMetadataVerifier verifier)

Sets a verifier other than the BasicCassandraPersistentEntityMetadataVerifier

getDataType

com.datastax.driver.core.DataType getDataType(CassandraPersistentProperty property)

Retrieve the data type of the property. Cassandra types are determined using simple types and configured CustomConversions.

Parameters:

property - must not be null.

Returns:

the Cassandra type.

Since:

1.5

See Also:

CustomConversions, CassandraSimpleTypeHolder

getDataType

com.datastax.driver.core.DataType getDataType(Class<?> type)

Retrieve the data type based on the given type. Cassandra types are determined using simple types and configured CustomConversions.

Parameters:

type - must not be null.

Returns:

the Cassandra type.

Since:

1.5

See Also:

CustomConversions, CassandraSimpleTypeHolder