info.archinnov.achilles.internals.metamodel

Class ListProperty<ENTITY,VALUEFROM,VALUETO>

java.lang.Object

info.archinnov.achilles.internals.metamodel.AbstractProperty<ENTITY,List<VALUEFROM>,List<VALUETO>>

info.archinnov.achilles.internals.metamodel.ListProperty<ENTITY,VALUEFROM,VALUETO>

All Implemented Interfaces:

InjectBeanFactory, InjectJacksonMapper, InjectKeyspace, InjectRuntimeCodecs, InjectSchemaStrategy, InjectUserAndTupleTypeFactory

public class ListProperty<ENTITY,VALUEFROM,VALUETO>
extends AbstractProperty<ENTITY,List<VALUEFROM>,List<VALUETO>>
implements InjectBeanFactory

Property Summary

Type	Property and Description
boolean	containsUDT

Field Summary

Fields

Modifier and Type	Field and Description
boolean	emptyCollectionIfNull
boolean	frozen
AbstractProperty<ENTITY,VALUEFROM,VALUETO>	valueProperty
Class<?>	valueToClass

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

fieldInfo, fieldName, schemaNameProvider, valueFromTypeToken, valueToTypeToken

Constructor Summary

Constructors

Constructor and Description
ListProperty(FieldInfo<ENTITY,List<VALUEFROM>> fieldInfo, boolean frozen, boolean emptyCollectionIfNull, Class<?> valueToClass, 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()
List<VALUEFROM>	decodeFromGettable(GettableData gettableData) Decode the given GettableData (Row, UDTValue, ...) to Java value value using Achilles codec system
List<VALUEFROM>	decodeFromGettableInternal(GettableData gettableData)
List<VALUEFROM>	decodeFromRaw(Object o) Decode the given raw object to Java value value using Achilles codec system
List<VALUEFROM>	decodeFromRawInternal(Object o)
VALUEFROM	decodeSingleElement(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.
List<VALUETO>	encodeFromJavaInternal(List<VALUEFROM> list, Optional<CassandraOptions> cassandraOptions)
List<VALUETO>	encodeFromRawInternal(Object o, Optional<CassandraOptions> cassandraOptions)
VALUETO	encodeSingleElement(VALUEFROM javaValue) Encode the single element of the list to a CQL-compatible value using Achilles codec system
VALUETO	encodeSingleElement(VALUEFROM javaValue, Optional<CassandraOptions> cassandraOptions) Encode the single element of the list to a CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
void	encodeToSettable(List<VALUETO> valueTos, 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,List<VALUEFROM>,List<VALUETO>>

Field Detail

valueToClass

public final Class<?> valueToClass

valueProperty

public final AbstractProperty<ENTITY,VALUEFROM,VALUETO> valueProperty

frozen

public final boolean frozen

emptyCollectionIfNull

public final boolean emptyCollectionIfNull

Constructor Detail

ListProperty

public ListProperty(FieldInfo<ENTITY,List<VALUEFROM>> fieldInfo,
                    boolean frozen,
                    boolean emptyCollectionIfNull,
                    Class<?> valueToClass,
                    AbstractProperty<ENTITY,VALUEFROM,VALUETO> valueProperty)

Method Detail

encodeSingleElement

public VALUETO encodeSingleElement(VALUEFROM javaValue)

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

Parameters:

javaValue -

Returns:

encodeSingleElement

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

Encode the single element of the list 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(List<VALUETO> valueTos,
                             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,List<VALUEFROM>,List<VALUETO>>

encodeFromJavaInternal

public List<VALUETO> encodeFromJavaInternal(List<VALUEFROM> list,
                                            Optional<CassandraOptions> cassandraOptions)

encodeFromRawInternal

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

decodeFromGettable

public List<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,List<VALUEFROM>,List<VALUETO>>

Returns:

decodeFromGettableInternal

public List<VALUEFROM> decodeFromGettableInternal(GettableData gettableData)

decodeFromRaw

public List<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,List<VALUEFROM>,List<VALUETO>>

Returns:

decodeFromRawInternal

public List<VALUEFROM> decodeFromRawInternal(Object o)

decodeSingleElement

public VALUEFROM decodeSingleElement(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,List<VALUEFROM>,List<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,List<VALUEFROM>,List<VALUETO>>

containsUDTProperty

public boolean containsUDTProperty()

Specified by:

containsUDTProperty in class AbstractProperty<ENTITY,List<VALUEFROM>,List<VALUETO>>

getUDTClassProperties

public List<AbstractUDTClassProperty<?>> getUDTClassProperties()

Specified by:

getUDTClassProperties in class AbstractProperty<ENTITY,List<VALUEFROM>,List<VALUETO>>

inject

public void inject(UserTypeFactory userTypeFactory,
                   TupleTypeFactory tupleTypeFactory)

Specified by:

inject in interface InjectUserAndTupleTypeFactory

inject

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

Specified by:

inject in interface InjectJacksonMapper

inject

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

Specified by:

inject in interface InjectBeanFactory

injectRuntimeCodecs

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

Specified by:

injectRuntimeCodecs in interface InjectRuntimeCodecs

injectKeyspace

public void injectKeyspace(String keyspace)

Specified by:

injectKeyspace in interface InjectKeyspace

inject

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

Specified by:

inject in interface InjectSchemaStrategy

Overrides:

inject in class AbstractProperty<ENTITY,List<VALUEFROM>,List<VALUETO>>