info.archinnov.achilles.internals.metamodel

Class MapProperty<ENTITY,KEYFROM,KEYTO,VALUEFROM,VALUETO>

java.lang.Object

info.archinnov.achilles.internals.metamodel.AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

info.archinnov.achilles.internals.metamodel.MapProperty<ENTITY,KEYFROM,KEYTO,VALUEFROM,VALUETO>

All Implemented Interfaces:

InjectBeanFactory, InjectJacksonMapper, InjectKeyspace, InjectRuntimeCodecs, InjectSchemaStrategy, InjectUserAndTupleTypeFactory

public class MapProperty<ENTITY,KEYFROM,KEYTO,VALUEFROM,VALUETO>
extends AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

Property Summary

Type	Property and Description
boolean	containsUDT

Field Summary

Fields

Modifier and Type	Field and Description
boolean	emptyCollectionIfNull
boolean	frozen
AbstractProperty<ENTITY,KEYFROM,KEYTO>	keyProperty
AbstractProperty<ENTITY,VALUEFROM,VALUETO>	valueProperty

Fields inherited from class info.archinnov.achilles.internals.metamodel.AbstractProperty

fieldInfo, fieldName, schemaNameProvider, valueFromTypeToken, valueToTypeToken

Constructor Summary

Constructors

Constructor and Description
MapProperty(FieldInfo<ENTITY,Map<KEYFROM,VALUEFROM>> fieldInfo, boolean frozen, boolean emptyCollectionIfNull, AbstractProperty<ENTITY,KEYFROM,KEYTO> keyProperty, AbstractProperty<ENTITY,VALUEFROM,VALUETO> valueProperty)

Method Summary

Modifier and Type	Method and Description
DataType	buildType(Optional<CassandraOptions> cassandraOptions) Build the Java driver DataType of this column given a CassandraOptions containing a runtime SchemaNameProvider.
boolean	containsUDTProperty()
Map<KEYFROM,VALUEFROM>	decodeFromGettable(GettableData gettableData) Decode the given GettableData (Row, UDTValue, ...) to Java value value using Achilles codec system
Map<KEYFROM,VALUEFROM>	decodeFromGettableInternal(GettableData gettableData)
Map<KEYFROM,VALUEFROM>	decodeFromRaw(Object o) Decode the given raw object to Java value value using Achilles codec system
Map<KEYFROM,VALUEFROM>	decodeFromRawInternal(Object o)
KEYFROM	decodeSingleKeyElement(KEYTO cassandraValue)
VALUEFROM	decodeSingleValueElement(VALUETO cassandraValue)
void	encodeFieldToUdt(ENTITY entity, UDTValue udtValue, Optional<CassandraOptions> cassandraOptions) First extract all the values from the given entity Then encode each of the extracted value into CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
Map<KEYTO,VALUETO>	encodeFromJavaInternal(Map<KEYFROM,VALUEFROM> map, Optional<CassandraOptions> cassandraOptions)
Map<KEYTO,VALUETO>	encodeFromRawInternal(Object o, Optional<CassandraOptions> cassandraOptions)
KEYTO	encodeSingleKeyElement(KEYFROM javaValue) Encode the single key element of the map to a CQL-compatible value using Achilles codec system
KEYTO	encodeSingleKeyElement(KEYFROM javaValue, Optional<CassandraOptions> cassandraOptions) Encode the single key element of the map to a CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
VALUETO	encodeSingleValueElement(VALUEFROM javaValue) Encode the single value element of the map to a CQL-compatible value using Achilles codec system
VALUETO	encodeSingleValueElement(VALUEFROM javaValue, Optional<CassandraOptions> cassandraOptions) Encode the single value element of the map to a CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
void	encodeToSettable(Map<KEYTO,VALUETO> mapTo, SettableData<?> settableData) Encode the given Java value to CQL-compatible value using Achilles codec system into the given SettableData (Row, UDTValue ...)
List<AbstractUDTClassProperty<?>>	getUDTClassProperties()
void	inject(info.archinnov.achilles.type.factory.BeanFactory factory)
void	inject(com.fasterxml.jackson.databind.ObjectMapper mapper)
void	inject(info.archinnov.achilles.type.SchemaNameProvider schemaNameProvider)
void	inject(UserTypeFactory userTypeFactory, TupleTypeFactory tupleTypeFactory)
void	injectKeyspace(String keyspace)
void	injectRuntimeCodecs(Map<info.archinnov.achilles.type.codec.CodecSignature<?,?>,info.archinnov.achilles.type.codec.Codec<?,?>> runtimeCodecs)

Methods inherited from class info.archinnov.achilles.internals.metamodel.AbstractProperty

decodeField, encodeField, encodeField, encodeFieldToUdt, encodeFromJava, encodeFromJava, encodeFromRaw, encodeFromRaw, equals, getColumnForSelect, getDataType, getFieldValue, getJavaValue, hashCode, setField, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Property Detail

containsUDT

public boolean containsUDTProperty

Specified by:

containsUDTProperty in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

Field Detail

keyProperty

public final AbstractProperty<ENTITY,KEYFROM,KEYTO> keyProperty

valueProperty

public final AbstractProperty<ENTITY,VALUEFROM,VALUETO> valueProperty

frozen

public final boolean frozen

emptyCollectionIfNull

public final boolean emptyCollectionIfNull

Constructor Detail

MapProperty

public MapProperty(FieldInfo<ENTITY,Map<KEYFROM,VALUEFROM>> fieldInfo,
                   boolean frozen,
                   boolean emptyCollectionIfNull,
                   AbstractProperty<ENTITY,KEYFROM,KEYTO> keyProperty,
                   AbstractProperty<ENTITY,VALUEFROM,VALUETO> valueProperty)

Method Detail

encodeSingleKeyElement

public KEYTO encodeSingleKeyElement(KEYFROM javaValue)

Encode the single key element of the map to a CQL-compatible value using Achilles codec system

Parameters:

javaValue -

Returns:

encodeSingleKeyElement

public KEYTO encodeSingleKeyElement(KEYFROM javaValue,
                                    Optional<CassandraOptions> cassandraOptions)

Encode the single key element of the map to a CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider. Use the

     CassandraOptions.withSchemaNameProvider(SchemaNameProvider provider)
 

static method to build such a CassandraOptions instance

Parameters:

javaValue -

cassandraOptions -

Returns:

encodeSingleValueElement

public VALUETO encodeSingleValueElement(VALUEFROM javaValue)

Encode the single value element of the map to a CQL-compatible value using Achilles codec system

Parameters:

javaValue -

Returns:

encodeSingleValueElement

public VALUETO encodeSingleValueElement(VALUEFROM javaValue,
                                        Optional<CassandraOptions> cassandraOptions)

Encode the single value element of the map to a CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider. Use the

     CassandraOptions.withSchemaNameProvider(SchemaNameProvider provider)
 

static method to build such a CassandraOptions instance

Parameters:

javaValue -

cassandraOptions -

Returns:

encodeToSettable

public void encodeToSettable(Map<KEYTO,VALUETO> mapTo,
                             SettableData<?> settableData)

Description copied from class: AbstractProperty

Encode the given Java value to CQL-compatible value using Achilles codec system into the given SettableData (Row, UDTValue ...)

Specified by:

encodeToSettable in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

encodeFromJavaInternal

public Map<KEYTO,VALUETO> encodeFromJavaInternal(Map<KEYFROM,VALUEFROM> map,
                                                 Optional<CassandraOptions> cassandraOptions)

encodeFromRawInternal

public Map<KEYTO,VALUETO> encodeFromRawInternal(Object o,
                                                Optional<CassandraOptions> cassandraOptions)

decodeFromGettable

public Map<KEYFROM,VALUEFROM> decodeFromGettable(GettableData gettableData)

Description copied from class: AbstractProperty

Decode the given GettableData (Row, UDTValue, ...) to Java value value using Achilles codec system

Overrides:

decodeFromGettable in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

Returns:

decodeFromGettableInternal

public Map<KEYFROM,VALUEFROM> decodeFromGettableInternal(GettableData gettableData)

decodeFromRaw

public Map<KEYFROM,VALUEFROM> decodeFromRaw(Object o)

Description copied from class: AbstractProperty

Decode the given raw object to Java value value using Achilles codec system

Overrides:

decodeFromRaw in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

Returns:

decodeFromRawInternal

public Map<KEYFROM,VALUEFROM> decodeFromRawInternal(Object o)

decodeSingleKeyElement

public KEYFROM decodeSingleKeyElement(KEYTO cassandraValue)

decodeSingleValueElement

public VALUEFROM decodeSingleValueElement(VALUETO cassandraValue)

buildType

public DataType buildType(Optional<CassandraOptions> cassandraOptions)

Description copied from class: AbstractProperty

Build the Java driver DataType of this column given a CassandraOptions containing a runtime SchemaNameProvider. Use the

     CassandraOptions.withSchemaNameProvider(SchemaNameProvider provider)
 

static method to build such a CassandraOptions instance

Specified by:

buildType in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

Returns:

encodeFieldToUdt

public void encodeFieldToUdt(ENTITY entity,
                             UDTValue udtValue,
                             Optional<CassandraOptions> cassandraOptions)

Description copied from class: AbstractProperty

1. First extract all the values from the given entity
2. Then encode each of the extracted value into CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider. Use the
   

   
        CassandraOptions.withSchemaNameProvider(SchemaNameProvider provider)
    

   static method to build such a CassandraOptions instance
3. Finally set the encoded value to the given UDTValue instance

Specified by:

encodeFieldToUdt in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

containsUDTProperty

public boolean containsUDTProperty()

Specified by:

containsUDTProperty in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

getUDTClassProperties

public List<AbstractUDTClassProperty<?>> getUDTClassProperties()

Specified by:

getUDTClassProperties in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>

inject

public void inject(UserTypeFactory userTypeFactory,
                   TupleTypeFactory tupleTypeFactory)

inject

public void inject(com.fasterxml.jackson.databind.ObjectMapper mapper)

inject

public void inject(info.archinnov.achilles.type.factory.BeanFactory factory)

injectRuntimeCodecs

public void injectRuntimeCodecs(Map<info.archinnov.achilles.type.codec.CodecSignature<?,?>,info.archinnov.achilles.type.codec.Codec<?,?>> runtimeCodecs)

injectKeyspace

public void injectKeyspace(String keyspace)

inject

public void inject(info.archinnov.achilles.type.SchemaNameProvider schemaNameProvider)

Specified by:

inject in interface InjectSchemaStrategy

Overrides:

inject in class AbstractProperty<ENTITY,Map<KEYFROM,VALUEFROM>,Map<KEYTO,VALUETO>>