Package org.springframework.data.cassandra.core.convert

Class MappingCassandraConverter

java.lang.Object

org.springframework.data.cassandra.core.convert.AbstractCassandraConverter

org.springframework.data.cassandra.core.convert.MappingCassandraConverter

All Implemented Interfaces:

Aware, BeanClassLoaderAware, InitializingBean, ApplicationContextAware, EnvironmentAware, EnvironmentCapable, CassandraConverter, EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>, EntityReader<Object,Object>, EntityWriter<Object,Object>

public class MappingCassandraConverter
extends AbstractCassandraConverter
implements ApplicationContextAware, EnvironmentAware, EnvironmentCapable, BeanClassLoaderAware

CassandraConverter that uses a MappingContext to do sophisticated mapping of domain objects to Row.

Author:

Alex Shvid, Matthew T. Adams, Oliver Gierke, Mark Paluch, Antoine Toulme, John Blum, Christoph Strobl, Frank Spitulski

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MappingCassandraConverter.ConversionContext	Conversion context holding references to simple MappingCassandraConverter.ConversionContext.ValueConverter and MappingCassandraConverter.ConversionContext.ContainerValueConverter.

Constructor Summary

Constructors

Constructor	Description
MappingCassandraConverter()	Create a new MappingCassandraConverter with a CassandraMappingContext.
MappingCassandraConverter(CassandraMappingContext mappingContext)	Create a new MappingCassandraConverter with the given CassandraMappingContext.

Method Summary

Modifier and Type	Method	Description
Object	convertToColumnType(Object obj)	Converts the given object into a value Cassandra will be able to store natively in a column.
Object	convertToColumnType(Object value, ColumnType columnType)	Converts the given object into a value Cassandra will be able to store natively in a column.
protected <S> S	doReadEntity(MappingCassandraConverter.ConversionContext context, CassandraValueProvider valueProvider, TypeInformation<? extends S> typeHint)	Conversion method to materialize an object from a Row, TupleValue, or UdtValue.
com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry	getCodecRegistry()	Returns the configured CodecRegistry.
ColumnTypeResolver	getColumnTypeResolver()	Returns the ColumnTypeResolver to resolve ColumnType for properties, TypeInformation, and values.
protected MappingCassandraConverter.ConversionContext	getConversionContext()	Constructs a new instance of MappingCassandraConverter.ConversionContext with various converters to convert different Cassandra value types.
Environment	getEnvironment()
Object	getId(Object object, CassandraPersistentEntity<?> entity)	Returns the Id for an entity.
CassandraMappingContext	getMappingContext()
protected Object	getPotentiallyConvertedSimpleRead(Object value, TypeInformation<?> target)	Checks whether we have a custom conversion for the given simple object.
ProjectionFactory	getProjectionFactory()	Returns the ProjectionFactory for this converter.
UserTypeResolver	getUserTypeResolver()	Returns the configured UserTypeResolver.
<R> R	project(EntityProjection<R,?> projection, com.datastax.oss.driver.api.core.cql.Row row)	Apply a projection to Row and return the projection return type R.
<R> R	read(Class<R> type, Object row)
protected Object	readCollectionOrArray(MappingCassandraConverter.ConversionContext context, Collection<?> source, TypeInformation<?> targetType)	Reads the given Collection into a collection of the given TypeInformation.
protected Object	readMap(MappingCassandraConverter.ConversionContext context, Map<?,?> source, TypeInformation<?> targetType)	Reads the given Map into a map of the given TypeInformation.
<R> R	readRow(Class<R> type, com.datastax.oss.driver.api.core.cql.Row row)	Read a Row into the requested target type.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader classLoader)
void	setCodecRegistry(com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)	Sets the CodecRegistry.
void	setCodecRegistry(Supplier<com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry> codecRegistry)	Sets the Supplier used for obtaining the CodecRegistry to use.
void	setEnvironment(Environment environment)
void	setSpELContext(SpELContext spELContext)
void	setUserTypeResolver(UserTypeResolver userTypeResolver)	Sets the UserTypeResolver.
void	write(Object source, Object sink)
void	write(Object source, Object sink, CassandraPersistentEntity<?> entity)	Converts and writes a source object into a sink using the given CassandraPersistentEntity.

Methods inherited from class org.springframework.data.cassandra.core.convert.AbstractCassandraConverter

afterPropertiesSet, getConversionService, getCustomConversions, setCustomConversions, setInstantiators

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.core.convert.CassandraConverter

convertToColumnType

Constructor Details

MappingCassandraConverter

public MappingCassandraConverter()

Create a new MappingCassandraConverter with a CassandraMappingContext.

MappingCassandraConverter

public MappingCassandraConverter(CassandraMappingContext mappingContext)

Create a new MappingCassandraConverter with the given CassandraMappingContext.

Parameters:

mappingContext - must not be null.

Method Details

getConversionContext

protected MappingCassandraConverter.ConversionContext getConversionContext()

Constructs a new instance of MappingCassandraConverter.ConversionContext with various converters to convert different Cassandra value types.

Returns:

the MappingCassandraConverter.ConversionContext.

See Also:

• MappingCassandraConverter.ConversionContext

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

getEnvironment

public Environment getEnvironment()

Specified by:

getEnvironment in interface EnvironmentCapable

setSpELContext

public void setSpELContext(SpELContext spELContext)

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getProjectionFactory

public ProjectionFactory getProjectionFactory()

Description copied from interface: CassandraConverter

Returns the ProjectionFactory for this converter.

Specified by:

getProjectionFactory in interface CassandraConverter

Returns:

will never be null.

setCodecRegistry

public void setCodecRegistry(com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)

Sets the CodecRegistry.

Parameters:

codecRegistry - must not be null.

Since:

3.0

setCodecRegistry

public void setCodecRegistry(Supplier<com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry> codecRegistry)

Sets the Supplier used for obtaining the CodecRegistry to use.

Parameters:

codecRegistry - must not be null.

Since:

4.3

getCodecRegistry

public com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry getCodecRegistry()

Returns the configured CodecRegistry.

Specified by:

getCodecRegistry in interface CassandraConverter

Returns:

the configured CodecRegistry.

Since:

3.0

setUserTypeResolver

public void setUserTypeResolver(UserTypeResolver userTypeResolver)

Sets the UserTypeResolver.

Parameters:

userTypeResolver - must not be null.

getUserTypeResolver

public UserTypeResolver getUserTypeResolver()

Returns the configured UserTypeResolver.

Returns:

the configured UserTypeResolver.

Since:

3.0

getMappingContext

public CassandraMappingContext getMappingContext()

Specified by:

getMappingContext in interface CassandraConverter

Specified by:

getMappingContext in interface EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>

getColumnTypeResolver

public ColumnTypeResolver getColumnTypeResolver()

Description copied from interface: CassandraConverter

Returns the ColumnTypeResolver to resolve ColumnType for properties, TypeInformation, and values.

Specified by:

getColumnTypeResolver in interface CassandraConverter

Returns:

the ColumnTypeResolver

project

public <R> R project(EntityProjection<R,?> projection,
 com.datastax.oss.driver.api.core.cql.Row row)

Description copied from interface: CassandraConverter

Apply a projection to Row and return the projection return type R. Non-projecting descriptors fall back to regular object materialization.

Specified by:

project in interface CassandraConverter

Parameters:

projection - the projection descriptor, must not be null.

row - must not be null.

Returns:

a new instance of the projection return type R.

read

public <R> R read(Class<R> type,
 Object row)

Specified by:

read in interface EntityReader<Object,Object>

readRow

public <R> R readRow(Class<R> type,
 com.datastax.oss.driver.api.core.cql.Row row)

Read a Row into the requested target type.

Parameters:

type - must not be null.

row - must not be null.

Returns:

the converted valued.

doReadEntity

protected <S> S doReadEntity(MappingCassandraConverter.ConversionContext context,
 CassandraValueProvider valueProvider,
 TypeInformation<? extends S> typeHint)

Conversion method to materialize an object from a Row, TupleValue, or UdtValue. Can be overridden by subclasses.

Parameters:

context - must not be null

valueProvider - must not be null

typeHint - the TypeInformation to be used to unmarshall this Row.

Returns:

the converted object, will never be null.

convertToColumnType

public Object convertToColumnType(Object obj)

Description copied from interface: CassandraConverter

Converts the given object into a value Cassandra will be able to store natively in a column.

Specified by:

convertToColumnType in interface CassandraConverter

Parameters:

obj - Object to convert; must not be null.

Returns:

the result of the conversion.

convertToColumnType

public Object convertToColumnType(Object value,
 ColumnType columnType)

Description copied from interface: CassandraConverter

Converts the given object into a value Cassandra will be able to store natively in a column.

Specified by:

convertToColumnType in interface CassandraConverter

Parameters:

value - Object to convert; must not be null.

columnType - ColumnType used to describe the object type; must not be null.

Returns:

the result of the conversion.

write

public void write(Object source,
 Object sink)

Specified by:

write in interface EntityWriter<Object,Object>

write

public void write(Object source,
 Object sink,
 CassandraPersistentEntity<?> entity)

Description copied from interface: CassandraConverter

Converts and writes a source object into a sink using the given CassandraPersistentEntity.

Specified by:

write in interface CassandraConverter

Parameters:

source - the source, must not be null.

sink - must not be null.

entity - must not be null.

getId

public Object getId(Object object,
 CassandraPersistentEntity<?> entity)

Description copied from interface: CassandraConverter

Returns the Id for an entity. It can return:

• A singular value if for a simple Id or PrimaryKey Id
• A MapId for composite PrimaryKeyColumn Id's
• A the composite primary key for PrimaryKey using a PrimaryKeyClass

Specified by:

getId in interface CassandraConverter

Parameters:

object - must not be null.

entity - must not be null.

Returns:

the id value or null, if the id is not set.

getPotentiallyConvertedSimpleRead

protected Object getPotentiallyConvertedSimpleRead(Object value,
 TypeInformation<?> target)

Checks whether we have a custom conversion for the given simple object. Converts the given value if so, applies Enum handling or returns the value as is. Can be overridden by subclasses.

Since:

3.2

readCollectionOrArray

protected Object readCollectionOrArray(MappingCassandraConverter.ConversionContext context,
 Collection<?> source,
 TypeInformation<?> targetType)

Reads the given Collection into a collection of the given TypeInformation. Will recursively resolve nested Lists as well. Can be overridden by subclasses.

Parameters:

source - must not be null.

targetType - must not be null.

Returns:

the converted Collection or array, will never be null.

readMap

protected Object readMap(MappingCassandraConverter.ConversionContext context,
 Map<?,?> source,
 TypeInformation<?> targetType)

Reads the given Map into a map of the given TypeInformation. Will recursively resolve nested Maps as well. Can be overridden by subclasses.

Parameters:

source - must not be null.

targetType - must not be null.

Returns:

the converted Collection or array, will never be null.