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, CassandraConverter, EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>, EntityReader<Object,Object>, EntityWriter<Object,Object>

public class MappingCassandraConverter
extends AbstractCassandraConverter
implements ApplicationContextAware, 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

Constructor Summary

Constructors

Constructor and 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 and 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.
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.
Object	getId(Object object, CassandraPersistentEntity<?> entity) Returns the Id for an entity.
CassandraMappingContext	getMappingContext()
UserTypeResolver	getUserTypeResolver() Returns the configured UserTypeResolver.
<R> R	read(Class<R> type, Object row)
<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	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 Detail

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 Detail

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

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

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

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.

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.