org.springframework.data.cassandra.convert

Interface CassandraConverter

All Superinterfaces:

EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>, EntityReader<Object,Object>, EntityWriter<Object,Object>

All Known Implementing Classes:

AbstractCassandraConverter, MappingCassandraConverter

public interface CassandraConverter
extends EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>

Central Cassandra specific converter interface from Object to Row.

Author:

Alex Shvid, Matthew T. Adams, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Object	convertToCassandraColumn(Object obj, TypeInformation<?> typeInformation) Converts the given object into one Cassandra will be able to store natively in a column.
CustomConversions	getCustomConversions() Returns the CustomConversions registered in the CassandraConverter.
Object	getId(Object object, CassandraPersistentEntity<?> entity) Returns the Id for an entity.
CassandraMappingContext	getMappingContext()
void	write(Object source, Object sink, CassandraPersistentEntity<?> entity) Converts and writes a source object into a sink using the given CassandraPersistentEntity.

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

getConversionService

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

read

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

write

Method Detail

getMappingContext

CassandraMappingContext getMappingContext()

Specified by:

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

getId

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

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

Parameters:

object - must not be null.

entity - must not be null.

Returns:

write

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

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

Parameters:

source - the source, may be null.

sink - must not be null.

entity - must not be null.

convertToCassandraColumn

Object convertToCassandraColumn(Object obj,
                                TypeInformation<?> typeInformation)

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

Parameters:

obj - Object to convert; can be null.

typeInformation - TypeInformation used to describe the object type; must not be null.

Returns:

the result of the conversion.

Since:

1.5

getCustomConversions

CustomConversions getCustomConversions()

Returns the CustomConversions registered in the CassandraConverter.

Returns:

the CustomConversions.