Module spring.data.cassandra

Package 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, BeanFactoryAware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, EnvironmentAware, 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	Description
CassandraMappingContext()	Create a new CassandraMappingContext.
CassandraMappingContext(UserTypeResolver userTypeResolver, TupleTypeFactory tupleTypeFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0, UserTypeResolver and TupleTypeFactory no longer required here as high-level type resolution went into CassandraConverter.

Method Summary

Modifier and Type	Method	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.oss.driver.api.core.type.codec.registry.CodecRegistry	getCodecRegistry()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
CustomConversions	getCustomConversions()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
Collection<BasicCassandraPersistentEntity<?>>	getTableEntities()	Returns only Table entities.
Collection<CassandraPersistentEntity<?>>	getUserDefinedTypeEntities()	Returns only those entities representing a user defined type.
UserTypeResolver	getUserTypeResolver()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
CassandraPersistentEntityMetadataVerifier	getVerifier()
void	initialize()
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setCodecRegistry(com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
void	setCustomConversions(CustomConversions customConversions)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
void	setMapping(Mapping mapping)	Sets the Mapping.
void	setNamingStrategy(NamingStrategy namingStrategy)	Set the NamingStrategy to use.
void	setTupleTypeFactory(TupleTypeFactory tupleTypeFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
void	setUserTypeResolver(UserTypeResolver userTypeResolver)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
void	setVerifier(CassandraPersistentEntityMetadataVerifier verifier)
protected boolean	shouldCreatePersistentEntityFor(TypeInformation<?> typeInfo)
boolean	usesTable(com.datastax.oss.driver.api.core.CqlIdentifier name)	Returns whether this mapping context has any entities mapped to the given table.
boolean	usesUserType(com.datastax.oss.driver.api.core.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, getPersistentPropertyPath, hasPersistentEntityFor, setApplicationEventPublisher, setBeanFactory, setEnvironment, setInitialEntitySet, setManagedTypes, setSimpleTypeHolder, setStrict, shouldCreateProperties

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 Details

CassandraMappingContext

public CassandraMappingContext()

Create a new CassandraMappingContext.

CassandraMappingContext

@Deprecated(forRemoval=true)
public CassandraMappingContext(UserTypeResolver userTypeResolver,
 TupleTypeFactory tupleTypeFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0, UserTypeResolver and TupleTypeFactory no longer required here as high-level type resolution went into CassandraConverter.

Create a new CassandraMappingContext given UserTypeResolver and TupleTypeFactory.

Parameters:

userTypeResolver - must not be null.

tupleTypeFactory - must not be null.

Since:

2.1

Method Details

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

@Deprecated(forRemoval=true)
public void setCustomConversions(CustomConversions customConversions)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Use custom conversion through MappingCassandraConverter.

Sets the CustomConversions.

Parameters:

customConversions - must not be null.

Since:

1.5

getCustomConversions

@Deprecated(forRemoval=true)
public CustomConversions getCustomConversions()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Use custom conversion through MappingCassandraConverter.

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

@Deprecated(forRemoval=true)
public void setCodecRegistry(com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Set CodecRegistry directly on CassandraConverter.

Sets the CodecRegistry.

Parameters:

codecRegistry - must not be null.

Since:

2.2

getCodecRegistry

@Deprecated(forRemoval=true)
public com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry getCodecRegistry()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Retrieve CodecRegistry directly from CassandraConverter.

setNamingStrategy

public void setNamingStrategy(NamingStrategy namingStrategy)

Set the NamingStrategy to use.

Parameters:

namingStrategy - must not be null.

Since:

3.0

setTupleTypeFactory

@Deprecated(forRemoval=true)
public void setTupleTypeFactory(TupleTypeFactory tupleTypeFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Tuple type creation uses DataTypes.tupleOf(DataType...)

Sets the TupleTypeFactory.

Parameters:

tupleTypeFactory - must not be null.

Since:

2.1

setUserTypeResolver

@Deprecated(forRemoval=true)
public void setUserTypeResolver(UserTypeResolver userTypeResolver)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Set UserTypeResolver directly on CassandraConverter.

Sets the UserTypeResolver.

Parameters:

userTypeResolver - must not be null.

Since:

1.5

getUserTypeResolver

@Nullable
@Deprecated(forRemoval=true)
public UserTypeResolver getUserTypeResolver()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. Retrieve UserTypeResolver directly from CassandraConverter.

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(com.datastax.oss.driver.api.core.CqlIdentifier name)

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

Parameters:

name - must not be null.

Returns:

true is this TableMetadata is used by a mapping.

usesUserType

public boolean usesUserType(com.datastax.oss.driver.api.core.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