org.springframework.data.cassandra.core.convert

Interface CassandraConverter

All Superinterfaces:

org.springframework.data.convert.EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>, org.springframework.data.convert.EntityReader<Object,Object>, org.springframework.data.convert.EntityWriter<Object,Object>

All Known Implementing Classes:

AbstractCassandraConverter, MappingCassandraConverter

public interface CassandraConverter
extends org.springframework.data.convert.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	convertToColumnType(Object value) Converts the given object into a value Cassandra will be able to store natively in a column.
Object	convertToColumnType(Object value, ColumnType typeDescriptor) Converts the given object into a value Cassandra will be able to store natively in a column.
default Object	convertToColumnType(Object value, org.springframework.data.util.TypeInformation<?> typeInformation) 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 CodecRegistry registered in the CassandraConverter.
ColumnTypeResolver	getColumnTypeResolver() Returns the ColumnTypeResolver to resolve ColumnType for properties, TypeInformation, and values.
org.springframework.data.convert.CustomConversions	getCustomConversions() Returns the CustomConversions for this converter.
Object	getId(Object object, CassandraPersistentEntity<?> entity) Returns the Id for an entity.
CassandraMappingContext	getMappingContext()
org.springframework.data.projection.ProjectionFactory	getProjectionFactory() Returns the ProjectionFactory for this converter.
<R> R	project(org.springframework.data.projection.EntityProjection<R,?> descriptor, com.datastax.oss.driver.api.core.cql.Row row) Apply a projection to Row and return the projection return type R.
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

getProjectionFactory

org.springframework.data.projection.ProjectionFactory getProjectionFactory()

Returns the ProjectionFactory for this converter.

Returns:

will never be null.

Since:

3.4

getCustomConversions

org.springframework.data.convert.CustomConversions getCustomConversions()

Returns the CustomConversions for this converter.

Returns:

will never be null.

getCodecRegistry

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

Returns the CodecRegistry registered in the CassandraConverter.

Returns:

the CodecRegistry.

Since:

3.0

getMappingContext

CassandraMappingContext getMappingContext()

Specified by:

getMappingContext in interface org.springframework.data.convert.EntityConverter<CassandraPersistentEntity<?>,CassandraPersistentProperty,Object,Object>

getColumnTypeResolver

ColumnTypeResolver getColumnTypeResolver()

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

Returns:

the ColumnTypeResolver

Since:

3.0

project

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

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

Type Parameters:

R -

Parameters:

descriptor - the projection descriptor, must not be null.

row - must not be null.

Returns:

a new instance of the projection return type R.

Since:

3.4

getId

@Nullable
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:

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

convertToColumnType

Object convertToColumnType(Object value)

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

Parameters:

value - Object to convert; must not be null.

Returns:

the result of the conversion.

Since:

2.0

convertToColumnType

default Object convertToColumnType(Object value,
                                   org.springframework.data.util.TypeInformation<?> typeInformation)

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

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.

Since:

1.5

convertToColumnType

Object convertToColumnType(Object value,
                           ColumnType typeDescriptor)

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

Parameters:

value - Object to convert; must not be null.

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

Returns:

the result of the conversion.

Since:

3.0

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, must not be null.

sink - must not be null.

entity - must not be null.