info.archinnov.achilles.internals.metamodel

Class AbstractProperty<ENTITY,VALUEFROM,VALUETO>

java.lang.Object

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

All Implemented Interfaces:

InjectBeanFactory, InjectJacksonMapper, InjectKeyspace, InjectRuntimeCodecs, InjectSchemaStrategy, InjectUserAndTupleTypeFactory

Direct Known Subclasses:

AbstractTupleProperty, ComputedProperty, JdkOptionalProperty, ListProperty, MapProperty, SetProperty, SimpleProperty, UDTProperty

public abstract class AbstractProperty<ENTITY,VALUEFROM,VALUETO>
extends Object
implements InjectUserAndTupleTypeFactory, InjectBeanFactory, InjectJacksonMapper, InjectRuntimeCodecs, InjectKeyspace, InjectSchemaStrategy

Property Summary

Type	Property and Description
abstract boolean	containsUDT

Field Summary

Fields

Modifier and Type	Field and Description
FieldInfo<ENTITY,VALUEFROM>	fieldInfo
String	fieldName
protected Optional<info.archinnov.achilles.type.SchemaNameProvider>	schemaNameProvider
com.google.common.reflect.TypeToken<VALUEFROM>	valueFromTypeToken
com.google.common.reflect.TypeToken<VALUETO>	valueToTypeToken

Method Summary

Modifier and Type	Method and Description
abstract DataType	buildType(Optional<CassandraOptions> cassandraOptions) Build the Java driver DataType of this column given a CassandraOptions containing a runtime SchemaNameProvider.
abstract boolean	containsUDTProperty()
void	decodeField(GettableData gettableData, ENTITY entity) First extract the column value from the given GettableData (Row, UDTValue, ...) Then call the setter on the given entity to set the value
VALUEFROM	decodeFromGettable(GettableData gettableData) Decode the given GettableData (Row, UDTValue, ...) to Java value value using Achilles codec system
VALUEFROM	decodeFromRaw(Object o) Decode the given raw object to Java value value using Achilles codec system
VALUETO	encodeField(ENTITY entity) Encode the field of the given entity into CQL-compatible value using Achilles codec system
VALUETO	encodeField(ENTITY entity, Optional<CassandraOptions> cassandraOptions) Encode the field of the given entity into CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
void	encodeFieldToUdt(ENTITY entity, UDTValue udtValue) First extract all the values from the given entity Then encode each of the extracted value into CQL-compatible value using Achilles codec system Finally set the encoded value to the given UDTValue instance
abstract 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.
VALUETO	encodeFromJava(VALUEFROM javaValue) Encode given java value to CQL-compatible value using Achilles codec system
VALUETO	encodeFromJava(VALUEFROM javaValue, Optional<CassandraOptions> cassandraOptions) Encode given java value to CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
VALUETO	encodeFromRaw(Object o) Encode the given raw Java object to CQL-compatible value using Achilles codec system
VALUETO	encodeFromRaw(Object o, Optional<CassandraOptions> cassandraOptions) Encode given java raw object to CQL-compatible value using Achilles codec system and a CassandraOptions containing a runtime SchemaNameProvider.
abstract void	encodeToSettable(VALUETO valueto, SettableData<?> settableData) Encode the given Java value to CQL-compatible value using Achilles codec system into the given SettableData (Row, UDTValue ...)
boolean	equals(Object o)
String	getColumnForSelect()
DataType	getDataType()
VALUEFROM	getFieldValue(ENTITY entity) Call the getter on the given entity to get the value
VALUEFROM	getJavaValue(ENTITY entity) Get the raw value associated with this field from the given entity (non encoded)
abstract List<AbstractUDTClassProperty<?>>	getUDTClassProperties()
int	hashCode()
void	inject(info.archinnov.achilles.type.SchemaNameProvider schemaNameProvider)
void	setField(ENTITY entity, VALUEFROM value)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.archinnov.achilles.internals.injectable.InjectUserAndTupleTypeFactory

inject

Methods inherited from interface info.archinnov.achilles.internals.injectable.InjectBeanFactory

inject

Methods inherited from interface info.archinnov.achilles.internals.injectable.InjectJacksonMapper

inject

Methods inherited from interface info.archinnov.achilles.internals.injectable.InjectRuntimeCodecs

injectRuntimeCodecs

Methods inherited from interface info.archinnov.achilles.internals.injectable.InjectKeyspace

injectKeyspace

Property Detail

containsUDT

public abstract boolean containsUDTProperty

Field Detail

fieldInfo

public final FieldInfo<ENTITY,VALUEFROM> fieldInfo

fieldName

public final String fieldName

valueFromTypeToken

public com.google.common.reflect.TypeToken<VALUEFROM> valueFromTypeToken

valueToTypeToken

public com.google.common.reflect.TypeToken<VALUETO> valueToTypeToken

schemaNameProvider

protected Optional<info.archinnov.achilles.type.SchemaNameProvider> schemaNameProvider

Method Detail

encodeFromJava

public VALUETO encodeFromJava(VALUEFROM javaValue)

Encode given java value to CQL-compatible value using Achilles codec system

Parameters:

javaValue -

Returns:

encodeFromJava

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

Encode given java value to 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 abstract void encodeToSettable(VALUETO valueto,
                                      SettableData<?> settableData)

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

Parameters:

valueto -

settableData -

encodeFromRaw

public VALUETO encodeFromRaw(Object o)

Encode the given raw Java object to CQL-compatible value using Achilles codec system

Parameters:

o -

Returns:

encodeFromRaw

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

Encode given java raw object to 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:

o -

cassandraOptions -

Returns:

decodeFromGettable

public VALUEFROM decodeFromGettable(GettableData gettableData)

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

Parameters:

gettableData -

Returns:

decodeFromRaw

public VALUEFROM decodeFromRaw(Object o)

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

Parameters:

o -

Returns:

buildType

public abstract DataType buildType(Optional<CassandraOptions> cassandraOptions)

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

Parameters:

cassandraOptions -

Returns:

encodeField

public VALUETO encodeField(ENTITY entity)

Encode the field of the given entity into CQL-compatible value using Achilles codec system

Parameters:

entity -

Returns:

encodeField

public VALUETO encodeField(ENTITY entity,
                           Optional<CassandraOptions> cassandraOptions)

Encode the field of the given entity 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

Parameters:

entity -

Returns:

getJavaValue

public VALUEFROM getJavaValue(ENTITY entity)

Get the raw value associated with this field from the given entity (non encoded)

Parameters:

entity -

Returns:

encodeFieldToUdt

public void encodeFieldToUdt(ENTITY entity,
                             UDTValue udtValue)

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
3. Finally set the encoded value to the given UDTValue instance

Parameters:

entity -

udtValue -

encodeFieldToUdt

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

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

Parameters:

entity -

udtValue -

containsUDTProperty

public abstract boolean containsUDTProperty()

getUDTClassProperties

public abstract List<AbstractUDTClassProperty<?>> getUDTClassProperties()

decodeField

public void decodeField(GettableData gettableData,
                        ENTITY entity)

1. First extract the column value from the given GettableData (Row, UDTValue, ...)
2. Then call the setter on the given entity to set the value

Parameters:

gettableData -

entity -

getFieldValue

public VALUEFROM getFieldValue(ENTITY entity)

Call the getter on the given entity to get the value

Parameters:

entity -

Returns:

setField

public void setField(ENTITY entity,
                     VALUEFROM value)

getColumnForSelect

public String getColumnForSelect()

getDataType

public DataType getDataType()

inject

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

Specified by:

inject in interface InjectSchemaStrategy

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object