org.springframework.data.cassandra.core.mapping

Class CassandraMappingContext

java.lang.Object

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

org.springframework.data.cassandra.core.mapping.CassandraMappingContext

All Implemented Interfaces:

Aware, BeanClassLoaderAware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, MappingContext<BasicCassandraPersistentEntity<?>,CassandraPersistentProperty>

Direct Known Subclasses:

BasicCassandraMappingContext

public class CassandraMappingContext
extends AbstractMappingContext<BasicCassandraPersistentEntity<?>,CassandraPersistentProperty>
implements ApplicationContextAware, BeanClassLoaderAware

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, Vagif Zeynalov

Constructor Summary

Constructors

Constructor and Description
CassandraMappingContext() Create a new CassandraMappingContext.
CassandraMappingContext(UserTypeResolver userTypeResolver, TupleTypeFactory tupleTypeFactory) Create a new CassandraMappingContext given UserTypeResolver and TupleTypeFactory.

Method Summary

Modifier and Type	Method and Description
protected Optional<BasicCassandraPersistentEntity<?>>	addPersistentEntity(TypeInformation<?> typeInformation)
protected <T> BasicCassandraPersistentEntity<T>	createPersistentEntity(TypeInformation<T> typeInformation)
protected CassandraPersistentProperty	createPersistentProperty(Property property, BasicCassandraPersistentEntity<?> owner, SimpleTypeHolder simpleTypeHolder)
com.datastax.driver.core.CodecRegistry	getCodecRegistry()
List<CreateIndexSpecification>	getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity) Deprecated. will be removed in version 3.0 in favor of SchemaFactory.
CreateTableSpecification	getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity) Returns a CreateTableSpecification for the given entity, including all mapping information.
CreateTableSpecification	getCreateTableSpecificationFor(CqlIdentifier tableName, CassandraPersistentEntity<?> entity) Deprecated. will be removed in version 3.0 in favor of SchemaFactory.
CreateUserTypeSpecification	getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity) Deprecated. will be removed in version 3.0 in favor of SchemaFactory.
com.datastax.driver.core.DataType	getDataType(CassandraPersistentProperty property) Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.
com.datastax.driver.core.DataType	getDataType(Class<?> type) Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.
Collection<BasicCassandraPersistentEntity<?>>	getTableEntities() Returns only Table entities.
com.datastax.driver.core.TupleType	getTupleType(CassandraPersistentEntity<?> persistentEntity) Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.
protected TupleTypeFactory	getTupleTypeFactory()
Collection<CassandraPersistentEntity<?>>	getUserDefinedTypeEntities() Returns only those entities representing a user defined type.
protected UserTypeResolver	getUserTypeResolver()
CassandraPersistentEntityMetadataVerifier	getVerifier()
void	initialize()
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setCodecRegistry(com.datastax.driver.core.CodecRegistry codecRegistry) Sets the CodecRegistry.
void	setCustomConversions(CustomConversions customConversions) Sets the CustomConversions.
void	setMapping(Mapping mapping) Sets the Mapping.
void	setTupleTypeFactory(TupleTypeFactory tupleTypeFactory) Sets the TupleTypeFactory.
void	setUserTypeResolver(UserTypeResolver userTypeResolver) Sets the UserTypeResolver.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier)
protected boolean	shouldCreatePersistentEntityFor(TypeInformation<?> typeInfo)
boolean	usesTable(CqlIdentifier name) Returns whether this mapping context has any entities mapped to the given table.
boolean	usesUserType(CqlIdentifier name) 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, doFindPersistentPropertyPaths, findPersistentPropertyPaths, getManagedTypes, getPersistentEntities, getPersistentEntity, getPersistentEntity, getPersistentEntity, 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.mapping.context.MappingContext

getRequiredPersistentEntity, getRequiredPersistentEntity, getRequiredPersistentEntity

Constructor Detail

CassandraMappingContext

public CassandraMappingContext()

Create a new CassandraMappingContext.

CassandraMappingContext

public CassandraMappingContext(UserTypeResolver userTypeResolver,
                               TupleTypeFactory tupleTypeFactory)

Create a new CassandraMappingContext given UserTypeResolver and TupleTypeFactory.

Parameters:

userTypeResolver - must not be null.

tupleTypeFactory - must not be null.

Since:

2.1

Method Detail

initialize

public void initialize()

Overrides:

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

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Overrides:

setApplicationContext in class AbstractMappingContext<BasicCassandraPersistentEntity<?>,CassandraPersistentProperty>

Throws:

BeansException

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setCustomConversions

public void setCustomConversions(CustomConversions customConversions)

Sets the CustomConversions.

Parameters:

customConversions - must not be null.

Since:

1.5

setMapping

public void setMapping(Mapping mapping)

Sets the Mapping.

Parameters:

mapping - must not be null.

getTableEntities

public Collection<BasicCassandraPersistentEntity<?>> getTableEntities()

Returns only Table entities.

Since:

1.5

getUserDefinedTypeEntities

public Collection<CassandraPersistentEntity<?>> getUserDefinedTypeEntities()

Returns only those entities representing a user defined type.

Since:

1.5

setCodecRegistry

public void setCodecRegistry(com.datastax.driver.core.CodecRegistry codecRegistry)

Sets the CodecRegistry.

Parameters:

codecRegistry - must not be null.

Since:

2.2

getCodecRegistry

@NonNull
public com.datastax.driver.core.CodecRegistry getCodecRegistry()

setTupleTypeFactory

public void setTupleTypeFactory(TupleTypeFactory tupleTypeFactory)

Sets the TupleTypeFactory.

Parameters:

tupleTypeFactory - must not be null.

Since:

2.1

getTupleTypeFactory

@NonNull
protected TupleTypeFactory getTupleTypeFactory()

setUserTypeResolver

public void setUserTypeResolver(UserTypeResolver userTypeResolver)

Sets the UserTypeResolver.

Parameters:

userTypeResolver - must not be null.

Since:

1.5

getUserTypeResolver

@Nullable
protected UserTypeResolver getUserTypeResolver()

setVerifier

public void setVerifier(CassandraPersistentEntityMetadataVerifier verifier)

Parameters:

verifier - The verifier to set.

getVerifier

public CassandraPersistentEntityMetadataVerifier getVerifier()

Returns:

Returns the verifier.

addPersistentEntity

protected Optional<BasicCassandraPersistentEntity<?>> addPersistentEntity(TypeInformation<?> typeInformation)

Overrides:

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

shouldCreatePersistentEntityFor

protected boolean shouldCreatePersistentEntityFor(TypeInformation<?> typeInfo)

Overrides:

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

createPersistentEntity

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

Specified by:

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

createPersistentProperty

protected CassandraPersistentProperty createPersistentProperty(Property property,
                                                               BasicCassandraPersistentEntity<?> owner,
                                                               SimpleTypeHolder simpleTypeHolder)

Specified by:

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

usesTable

public boolean usesTable(CqlIdentifier name)

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

Parameters:

name - must not be null.

Returns:

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

usesUserType

public boolean usesUserType(CqlIdentifier name)

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

Parameters:

name - must not be null.

Returns:

true is this UserType is used.

Since:

1.5

getCreateTableSpecificationFor

public CreateTableSpecification getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity)

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

Parameters:

entity - must not be null.

Returns:

getCreateTableSpecificationFor

@Deprecated
public CreateTableSpecification getCreateTableSpecificationFor(CqlIdentifier tableName,
                                                                           CassandraPersistentEntity<?> entity)

Deprecated. will be removed in version 3.0 in favor of SchemaFactory.

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

Parameters:

tableName - must not be null.

entity - must not be null.

Returns:

Since:

2.2

getCreateIndexSpecificationsFor

@Deprecated
public List<CreateIndexSpecification> getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity)

Deprecated. will be removed in version 3.0 in favor of SchemaFactory.

Parameters:

entity - must not be null.

Returns:

Since:

2.0

getCreateUserTypeSpecificationFor

@Deprecated
public CreateUserTypeSpecification getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity)

Deprecated. will be removed in version 3.0 in favor of SchemaFactory.

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

Parameters:

entity - must not be null.

getDataType

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

Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.

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

getTupleType

@Deprecated
public com.datastax.driver.core.TupleType getTupleType(CassandraPersistentEntity<?> persistentEntity)

Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.

Parameters:

persistentEntity -

Returns:

getDataType

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

Deprecated. will be removed in version 3.0 in favor of ColumnTypeResolver.

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