org.springframework.data.cassandra.mapping

Class BasicCassandraMappingContext

java.lang.Object

org.springframework.data.mapping.context.AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

org.springframework.data.cassandra.mapping.BasicCassandraMappingContext

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, CassandraMappingContext, MappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

public class BasicCassandraMappingContext
extends AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>
implements CassandraMappingContext, ApplicationContextAware

Default implementation of a MappingContext for Cassandra using CassandraPersistentEntity and CassandraPersistentProperty as primary abstractions.

Author:

Alex Shvid, Matthew T. Adams, Mark Paluch, John Blum, Jens Schauder

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	beanClassLoader
protected ApplicationContext	context
protected Map<Class<?>,CassandraPersistentEntity<?>>	entitiesByType
protected Map<CqlIdentifier,Set<CassandraPersistentEntity<?>>>	entitySetsByTableName
protected Mapping	mapping
protected Set<CassandraPersistentEntity<?>>	primaryKeyEntities
protected Set<CassandraPersistentEntity<?>>	tableEntities
protected Set<CassandraPersistentEntity<?>>	userDefinedTypes
protected CassandraPersistentEntityMetadataVerifier	verifier

Constructor Summary

Constructors

Constructor and Description
BasicCassandraMappingContext() Creates a new BasicCassandraMappingContext.

Method Summary

Modifier and Type	Method and Description
protected CassandraPersistentEntity<?>	addPersistentEntity(TypeInformation<?> typeInformation)
boolean	contains(Class<?> type) Returns whether this CassandraMappingContext already contains a CassandraPersistentEntity for the given type.
protected <T> CassandraPersistentEntity<T>	createPersistentEntity(TypeInformation<T> typeInformation)
CassandraPersistentProperty	createPersistentProperty(Field field, PropertyDescriptor descriptor, CassandraPersistentEntity<?> owner, CassandraSimpleTypeHolder simpleTypeHolder)
CassandraPersistentProperty	createPersistentProperty(Field field, PropertyDescriptor descriptor, CassandraPersistentEntity<?> owner, SimpleTypeHolder simpleTypeHolder)
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() Returns only those entities not representing primary key types.
Collection<CassandraPersistentEntity<?>>	getPersistentEntities(boolean includePrimaryKeyTypesAndUdts) Returns all persistent entities or only non-primary-key entities.
Collection<CassandraPersistentEntity<?>>	getPrimaryKeyEntities() Returns only those entities representing primary key types.
Collection<CassandraPersistentEntity<?>>	getTableEntities() Returns only Table entities.
Collection<CassandraPersistentEntity<?>>	getUserDefinedTypeEntities() Returns only those entities representing a user defined type.
CassandraPersistentEntityMetadataVerifier	getVerifier()
void	initialize()
protected void	processMappingOverride(CassandraPersistentEntity<?> entity, PropertyMapping mapping)
protected void	processMappingOverrides()
protected void	processMappingOverrides(CassandraPersistentEntity<?> entity, EntityMapping entityMapping)
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setCustomConversions(CustomConversions customConversions) Sets the CustomConversions.
void	setMapping(Mapping mapping)
void	setUserTypeResolver(UserTypeResolver userTypeResolver) Sets the UserTypeResolver.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier) Sets a verifier other than the BasicCassandraPersistentEntityMetadataVerifier
protected boolean	shouldCreatePersistentEntityFor(TypeInformation<?> typeInfo)
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 class org.springframework.data.mapping.context.AbstractMappingContext

addPersistentEntity, afterPropertiesSet, getManagedTypes, getPersistentEntities, getPersistentEntity, getPersistentEntity, getPersistentEntity, getPersistentPropertyPath, getPersistentPropertyPath, getPersistentPropertyPath, hasPersistentEntityFor, setApplicationEventPublisher, setInitialEntitySet, setSimpleTypeHolder, setStrict

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.cassandra.mapping.CassandraMappingContext

getPersistentEntities

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

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

Field Detail

context

protected ApplicationContext context

verifier

protected CassandraPersistentEntityMetadataVerifier verifier

beanClassLoader

protected ClassLoader beanClassLoader

mapping

protected Mapping mapping

entitiesByType

protected Map<Class<?>,CassandraPersistentEntity<?>> entitiesByType

entitySetsByTableName

protected Map<CqlIdentifier,Set<CassandraPersistentEntity<?>>> entitySetsByTableName

primaryKeyEntities

protected Set<CassandraPersistentEntity<?>> primaryKeyEntities

userDefinedTypes

protected Set<CassandraPersistentEntity<?>> userDefinedTypes

tableEntities

protected Set<CassandraPersistentEntity<?>> tableEntities

Constructor Detail

BasicCassandraMappingContext

public BasicCassandraMappingContext()

Creates a new BasicCassandraMappingContext.

Method Detail

initialize

public void initialize()

Overrides:

initialize in class AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

processMappingOverrides

protected void processMappingOverrides()

processMappingOverrides

protected void processMappingOverrides(CassandraPersistentEntity<?> entity,
                                       EntityMapping entityMapping)

processMappingOverride

protected void processMappingOverride(CassandraPersistentEntity<?> entity,
                                      PropertyMapping mapping)

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

setCustomConversions

public void setCustomConversions(CustomConversions customConversions)

Sets the CustomConversions.

Parameters:

customConversions - must not be null.

Since:

1.5

setMapping

public void setMapping(Mapping mapping)

setUserTypeResolver

public void setUserTypeResolver(UserTypeResolver userTypeResolver)

Sets the UserTypeResolver.

Parameters:

userTypeResolver - must not be null.

Since:

1.5

setVerifier

public void setVerifier(CassandraPersistentEntityMetadataVerifier verifier)

Description copied from interface: CassandraMappingContext

Sets a verifier other than the BasicCassandraPersistentEntityMetadataVerifier

Specified by:

setVerifier in interface CassandraMappingContext

Parameters:

verifier - The verifier to set.

getVerifier

public CassandraPersistentEntityMetadataVerifier getVerifier()

Returns:

Returns the verifier.

getNonPrimaryKeyEntities

public Collection<CassandraPersistentEntity<?>> getNonPrimaryKeyEntities()

Description copied from interface: CassandraMappingContext

Returns only those entities not representing primary key types.

Specified by:

getNonPrimaryKeyEntities in interface CassandraMappingContext

See Also:

CassandraMappingContext.getPersistentEntities(boolean)

getPrimaryKeyEntities

public Collection<CassandraPersistentEntity<?>> getPrimaryKeyEntities()

Description copied from interface: CassandraMappingContext

Returns only those entities representing primary key types.

Specified by:

getPrimaryKeyEntities in interface CassandraMappingContext

getTableEntities

public Collection<CassandraPersistentEntity<?>> getTableEntities()

Description copied from interface: CassandraMappingContext

Returns only Table entities.

Specified by:

getTableEntities in interface CassandraMappingContext

getUserDefinedTypeEntities

public Collection<CassandraPersistentEntity<?>> getUserDefinedTypeEntities()

Description copied from interface: CassandraMappingContext

Returns only those entities representing a user defined type.

Specified by:

getUserDefinedTypeEntities in interface CassandraMappingContext

See Also:

CassandraMappingContext.getPersistentEntities(boolean)

getPersistentEntities

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

Description copied from interface: CassandraMappingContext

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

Specified by:

getPersistentEntities in interface CassandraMappingContext

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.

createPersistentEntity

protected <T> CassandraPersistentEntity<T> createPersistentEntity(TypeInformation<T> typeInformation)

Specified by:

createPersistentEntity in class AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

createPersistentProperty

public CassandraPersistentProperty createPersistentProperty(Field field,
                                                            PropertyDescriptor descriptor,
                                                            CassandraPersistentEntity<?> owner,
                                                            SimpleTypeHolder simpleTypeHolder)

Specified by:

createPersistentProperty in class AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

createPersistentProperty

public CassandraPersistentProperty createPersistentProperty(Field field,
                                                            PropertyDescriptor descriptor,
                                                            CassandraPersistentEntity<?> owner,
                                                            CassandraSimpleTypeHolder simpleTypeHolder)

usesTable

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

Description copied from interface: CassandraMappingContext

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

Specified by:

usesTable in interface CassandraMappingContext

Parameters:

table - must not be null.

Returns:

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

usesUserType

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

Description copied from interface: CassandraMappingContext

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

Specified by:

usesUserType in interface CassandraMappingContext

Parameters:

userType - must not be null.

Returns:

true is this UserType is used.

usesUserType

public boolean usesUserType(CqlIdentifier userType)

Description copied from interface: CassandraMappingContext

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

Specified by:

usesUserType in interface CassandraMappingContext

Parameters:

userType - must not be null.

Returns:

true is this UserType is used.

getCreateTableSpecificationFor

public CreateTableSpecification getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity)

Description copied from interface: CassandraMappingContext

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

Specified by:

getCreateTableSpecificationFor in interface CassandraMappingContext

Parameters:

entity - must not be null.

getCreateUserTypeSpecificationFor

public CreateUserTypeSpecification getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity)

Description copied from interface: CassandraMappingContext

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

Specified by:

getCreateUserTypeSpecificationFor in interface CassandraMappingContext

Parameters:

entity - must not be null.

shouldCreatePersistentEntityFor

protected boolean shouldCreatePersistentEntityFor(TypeInformation<?> typeInfo)

Overrides:

shouldCreatePersistentEntityFor in class AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

addPersistentEntity

protected CassandraPersistentEntity<?> addPersistentEntity(TypeInformation<?> typeInformation)

Overrides:

addPersistentEntity in class AbstractMappingContext<CassandraPersistentEntity<?>,CassandraPersistentProperty>

getDataType

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

Description copied from interface: CassandraMappingContext

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

Specified by:

getDataType in interface CassandraMappingContext

Parameters:

property - must not be null.

Returns:

the Cassandra type.

See Also:

CustomConversions, CassandraSimpleTypeHolder

getDataType

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

Description copied from interface: CassandraMappingContext

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

Specified by:

getDataType in interface CassandraMappingContext

Parameters:

type - must not be null.

Returns:

the Cassandra type.

See Also:

CustomConversions, CassandraSimpleTypeHolder

getExistingPersistentEntity

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

Description copied from interface: CassandraMappingContext

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

Specified by:

getExistingPersistentEntity in interface CassandraMappingContext

Parameters:

type - The class of the existing persistent entity.

Returns:

The existing persistent entity.

contains

public boolean contains(Class<?> type)

Description copied from interface: CassandraMappingContext

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

Specified by:

contains in interface CassandraMappingContext