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 CassandraConverter, 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

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, TypeInformation<?> typeInformation) Converts the given object into a value Cassandra will be able to store natively in a column.
Object	getId(Object object, CassandraPersistentEntity<?> entity) Returns the Id for an entity.
CassandraMappingContext	getMappingContext()
protected Object	getReadValue(CassandraValueProvider row, CassandraPersistentProperty property) Retrieve the value to read for the given CassandraPersistentProperty from BasicCassandraRowValueProvider and perform optionally a conversion of collection element types.
protected Object	instantiatePrimaryKey(CassandraPersistentEntity<?> entity, CassandraPersistentProperty keyProperty, CassandraValueProvider propertyProvider)
<R> R	read(Class<R> type, Object row)
protected <S> S	readEntityFromRow(CassandraPersistentEntity<S> entity, com.datastax.driver.core.Row row)
protected <S> S	readEntityFromUdt(CassandraPersistentEntity<S> entity, com.datastax.driver.core.UDTValue udtValue)
protected void	readProperties(CassandraPersistentEntity<?> entity, CassandraValueProvider valueProvider, PersistentPropertyAccessor propertyAccessor)
protected void	readPropertiesFromRow(CassandraPersistentEntity<?> entity, CassandraRowValueProvider row, PersistentPropertyAccessor propertyAccessor)
protected void	readProperty(CassandraPersistentEntity<?> entity, CassandraPersistentProperty property, CassandraValueProvider valueProvider, PersistentPropertyAccessor propertyAccessor)
<R> R	readRow(Class<R> type, com.datastax.driver.core.Row row) Read a Row into the requested target type.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader classLoader)
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.
protected void	writeDeleteWhereFromObject(Object object, com.datastax.driver.core.querybuilder.Delete.Where where, CassandraPersistentEntity<?> entity)
protected void	writeInsertFromWrapper(ConvertingPropertyAccessor accessor, com.datastax.driver.core.querybuilder.Insert insert, CassandraPersistentEntity<?> entity)
protected void	writeSelectWhereFromObject(Object object, com.datastax.driver.core.querybuilder.Select.Where where, CassandraPersistentEntity<?> entity)
protected void	writeUDTValueWhereFromObject(ConvertingPropertyAccessor accessor, com.datastax.driver.core.UDTValue udtValue, CassandraPersistentEntity<?> entity)
protected void	writeUpdateFromObject(Object object, com.datastax.driver.core.querybuilder.Update update, CassandraPersistentEntity<?> entity)
protected void	writeUpdateFromWrapper(ConvertingPropertyAccessor accessor, com.datastax.driver.core.querybuilder.Update update, CassandraPersistentEntity<?> entity)

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

getCustomConversions

Methods inherited from interface org.springframework.data.convert.EntityConverter

getConversionService

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

getMappingContext

public CassandraMappingContext getMappingContext()

Specified by:

getMappingContext in interface CassandraConverter

Specified by:

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

readRow

public <R> R readRow(Class<R> type,
                     com.datastax.driver.core.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.

readEntityFromRow

protected <S> S readEntityFromRow(CassandraPersistentEntity<S> entity,
                                  com.datastax.driver.core.Row row)

readEntityFromUdt

protected <S> S readEntityFromUdt(CassandraPersistentEntity<S> entity,
                                  com.datastax.driver.core.UDTValue udtValue)

readPropertiesFromRow

protected void readPropertiesFromRow(CassandraPersistentEntity<?> entity,
                                     CassandraRowValueProvider row,
                                     PersistentPropertyAccessor propertyAccessor)

readProperties

protected void readProperties(CassandraPersistentEntity<?> entity,
                              CassandraValueProvider valueProvider,
                              PersistentPropertyAccessor propertyAccessor)

readProperty

protected void readProperty(CassandraPersistentEntity<?> entity,
                            CassandraPersistentProperty property,
                            CassandraValueProvider valueProvider,
                            PersistentPropertyAccessor propertyAccessor)

instantiatePrimaryKey

protected Object instantiatePrimaryKey(CassandraPersistentEntity<?> entity,
                                       CassandraPersistentProperty keyProperty,
                                       CassandraValueProvider propertyProvider)

read

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

Specified by:

read in interface EntityReader<Object,Object>

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,
                                  TypeInformation<?> typeInformation)

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.

typeInformation - TypeInformation 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.

writeInsertFromWrapper

protected void writeInsertFromWrapper(ConvertingPropertyAccessor accessor,
                                      com.datastax.driver.core.querybuilder.Insert insert,
                                      CassandraPersistentEntity<?> entity)

writeUpdateFromObject

protected void writeUpdateFromObject(Object object,
                                     com.datastax.driver.core.querybuilder.Update update,
                                     CassandraPersistentEntity<?> entity)

writeUpdateFromWrapper

protected void writeUpdateFromWrapper(ConvertingPropertyAccessor accessor,
                                      com.datastax.driver.core.querybuilder.Update update,
                                      CassandraPersistentEntity<?> entity)

writeSelectWhereFromObject

protected void writeSelectWhereFromObject(Object object,
                                          com.datastax.driver.core.querybuilder.Select.Where where,
                                          CassandraPersistentEntity<?> entity)

writeDeleteWhereFromObject

protected void writeDeleteWhereFromObject(Object object,
                                          com.datastax.driver.core.querybuilder.Delete.Where where,
                                          CassandraPersistentEntity<?> entity)

writeUDTValueWhereFromObject

protected void writeUDTValueWhereFromObject(ConvertingPropertyAccessor accessor,
                                            com.datastax.driver.core.UDTValue udtValue,
                                            CassandraPersistentEntity<?> entity)

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.

getReadValue

@Nullable
protected Object getReadValue(CassandraValueProvider row,
                                        CassandraPersistentProperty property)

Retrieve the value to read for the given CassandraPersistentProperty from BasicCassandraRowValueProvider and perform optionally a conversion of collection element types.

Parameters:

row - the row.

property - the property.

Returns:

the return value, may be null.