FieldInfoImpl (Helenus Implementation 3.0.1 API)

java.lang.Object
- org.helenus.driver.impl.FieldInfoImpl<T>

Type Parameters:

T - The type of POJO represented by this field

All Implemented Interfaces:

FieldInfo<T>
```
public class FieldInfoImpl<T>
extends Object
implements FieldInfo<T>
```
The FieldInfo class caches all the field information needed by the class ClassInfo.
Note: A fake TableInfoImpl class with no table annotations might be passed in for user-defined type entities. By design, this class will not allow any type of keys but only columns.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle, vasu - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Field Summary

Fields
Modifier and Type	Field and Description
`protected DataTypeImpl.Definition`	`definition` Holds the data type definition for this field (if it is a column).
`TableInfoImpl<T>`	`tinfo` Holds the table information for this field.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decodeAndSetValue(T object, com.datastax.driver.core.Row row)` Decodes and sets the field's value in the specified POJO based on the given row.
`void`	`decodeAndSetValue(T object, com.datastax.driver.core.UDTValue uval)` Decodes and sets the field's value in the specified POJO based on the given UDT value.
`Object`	`decodeValue(com.datastax.driver.core.Row row)` Decodes the field's value based on the given row.
`Object`	`decodeValue(com.datastax.driver.core.UDTValue uval)` Decodes the field's value based on the given UDT value.
`<A extends Annotation> A`	`getAnnotation(Class<A> annotationClass)`
`ClassInfo<T>`	`getClassInfo()`
`ClusteringKey`	`getClusteringKey()`
`com.datastax.driver.core.TypeCodec<?>`	`getCodec()` Gets a codec for this field.
`String`	`getColumnName()`
`DataTypeImpl.Definition`	`getDataType()` Gets the column data type for this field.
`Class<?>`	`getDeclaringClass()`
`Object`	`getFinalValue()` Gets the final value for the field if it is defined as final.
`Index`	`getIndex()`
`KeyspaceKey`	`getKeyspaceKey()`
`String`	`getKeyspaceKeyName()`
`String`	`getName()`
`Class<T>`	`getObjectClass()`
`PartitionKey`	`getPartitionKey()`
`TableInfo<T>`	`getTableInfo()`
`Class<?>`	`getType()`
`TypeKey`	`getTypeKey()`
`Object`	`getValue(Class<?> clazz, T object)` Retrieves the field's encoded value from the specified POJO.
`Object`	`getValue(T object)` Retrieves the field's encoded value from the specified POJO.
`boolean`	`isCaseInsensitiveKey()`
`boolean`	`isClusteringKey()`
`boolean`	`isColumn()`
`boolean`	`isCounter()`
`boolean`	`isFinal()`
`boolean`	`isIndex()`
`boolean`	`isKeyspaceKey()`
`boolean`	`isLast()`
`boolean`	`isMandatory()`
`boolean`	`isMultiKey()`
`boolean`	`isOptional()` Checks if the field is defined as optional.
`boolean`	`isPartitionKey()`
`boolean`	`isStatic()`
`boolean`	`isTypeKey()`
`void`	`setValue(T object, Object value)` Sets the field's value in the specified POJO with the given value.
`String`	`toString()`
`java.util.stream.Stream<UDTClassInfoImpl<?>>`	`udts()` Gets all user-defined types this field is dependent on.
`void`	`validateCollectionValue(Object value)` Validate the provided element value for this collection field.
`void`	`validateListValue(Object value)` Validate the provided value for this list field.
`void`	`validateMapKey(Object key)` Validate the provided mapping key for this map field.
`void`	`validateMapKeyValue(Object key, Object value)` Validate the provided mapping key/value for this map field.
`void`	`validateSetValue(Object value)` Validate the provided value for this set field.
`void`	`validateValue(Object value)` Validate the provided value for this field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - tinfo
```
public final TableInfoImpl<T> tinfo
```
    Holds the table information for this field. Can be null if the field is only used as a keyspace key.
  - definition
```
protected final DataTypeImpl.Definition definition
```
    Holds the data type definition for this field (if it is a column).
- Method Detail
  - getObjectClass
```
public Class<T> getObjectClass()
```
    Specified by:
    
    getObjectClass in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getObjectClass()
  - getDeclaringClass
```
public Class<?> getDeclaringClass()
```
    Specified by:
    
    getDeclaringClass in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getDeclaringClass()
  - getClassInfo
```
public ClassInfo<T> getClassInfo()
```
    Specified by:
    
    getClassInfo in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getClassInfo()
  - getTableInfo
```
public TableInfo<T> getTableInfo()
```
    Specified by:
    
    getTableInfo in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getTableInfo()
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getName()
  - getType
```
public Class<?> getType()
```
    Specified by:
    
    getType in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getType()
  - isColumn
```
public boolean isColumn()
```
    Specified by:
    
    isColumn in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isColumn()
  - isStatic
```
public boolean isStatic()
```
    Specified by:
    
    isStatic in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isStatic()
  - getColumnName
```
public String getColumnName()
```
    Specified by:
    
    getColumnName in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getColumnName()
  - getKeyspaceKeyName
```
public String getKeyspaceKeyName()
```
    Specified by:
    
    getKeyspaceKeyName in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getKeyspaceKeyName()
  - getDataType
```
public DataTypeImpl.Definition getDataType()
```
    Gets the column data type for this field.
    
    Returns:
    
    the column data type for this field if it is annotated as a column; null otherwise
  - isKeyspaceKey
```
public boolean isKeyspaceKey()
```
    Specified by:
    
    isKeyspaceKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isKeyspaceKey()
  - getKeyspaceKey
```
public KeyspaceKey getKeyspaceKey()
```
    Specified by:
    
    getKeyspaceKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getKeyspaceKey()
  - isMandatory
```
public boolean isMandatory()
```
    Specified by:
    
    isMandatory in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isMandatory()
  - isOptional
```
public boolean isOptional()
```
    Checks if the field is defined as optional.
    
    Returns:
    
    true if the field is defined as optional; false otherwise
  - isIndex
```
public boolean isIndex()
```
    Specified by:
    
    isIndex in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isIndex()
  - getIndex
```
public Index getIndex()
```
    Specified by:
    
    getIndex in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getIndex()
  - isCounter
```
public boolean isCounter()
```
    Specified by:
    
    isCounter in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isCounter()
  - isLast
```
public boolean isLast()
```
    Specified by:
    
    isLast in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isLast()
  - isPartitionKey
```
public boolean isPartitionKey()
```
    Specified by:
    
    isPartitionKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isPartitionKey()
  - getPartitionKey
```
public PartitionKey getPartitionKey()
```
    Specified by:
    
    getPartitionKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getPartitionKey()
  - isClusteringKey
```
public boolean isClusteringKey()
```
    Specified by:
    
    isClusteringKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isClusteringKey()
  - getClusteringKey
```
public ClusteringKey getClusteringKey()
```
    Specified by:
    
    getClusteringKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getClusteringKey()
  - isCaseInsensitiveKey
```
public boolean isCaseInsensitiveKey()
```
    Specified by:
    
    isCaseInsensitiveKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isCaseInsensitiveKey()
  - isTypeKey
```
public boolean isTypeKey()
```
    Specified by:
    
    isTypeKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isTypeKey()
  - getTypeKey
```
public TypeKey getTypeKey()
```
    Specified by:
    
    getTypeKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getClusteringKey()
  - isMultiKey
```
public boolean isMultiKey()
```
    Specified by:
    
    isMultiKey in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isMultiKey()
  - getAnnotation
```
public <A extends Annotation> A getAnnotation(Class<A> annotationClass)
```
    Specified by:
    
    getAnnotation in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.getAnnotation(java.lang.Class)
  - validateValue
```
public void validateValue(Object value)
```
    Validate the provided value for this field.
    
    Parameters:
    
    value - the value to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified value is not of the right type or is null when the field is mandatory
    
    ExcludedKeyspaceKeyException - if this field is a keyspace key and the specified value is marked as excluded
  - getCodec
```
public com.datastax.driver.core.TypeCodec<?> getCodec()
```
    Gets a codec for this field.
    
    Returns:
    
    a suitable codec for this field
  - validateCollectionValue
```
public void validateCollectionValue(Object value)
```
    Validate the provided element value for this collection field.
    
    Parameters:
    
    value - the element value to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified value is not of the right type or is null when the column is mandatory
  - validateListValue
```
public void validateListValue(Object value)
```
    Validate the provided value for this list field.
    
    Parameters:
    
    value - the element value to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified value is not of the right element type or the value is null when the column is mandatory
  - validateSetValue
```
public void validateSetValue(Object value)
```
    Validate the provided value for this set field.
    
    Parameters:
    
    value - the element value to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified value is not of the right element type or the value is null when the column is mandatory
  - validateMapKeyValue
```
public void validateMapKeyValue(Object key,
                                Object value)
```
    Validate the provided mapping key/value for this map field.
    
    Parameters:
    
    key - the mapping key to be validated
    
    value - the mapping value to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified key/value are not of the right mapping types or the value is null when the column is mandatory
  - validateMapKey
```
public void validateMapKey(Object key)
```
    Validate the provided mapping key for this map field.
    
    Parameters:
    
    key - the mapping key to be validated
    
    Throws:
    
    IllegalArgumentException - if the specified key is not of the right mapping types
  - isFinal
```
public boolean isFinal()
```
    Specified by:
    
    isFinal in interface FieldInfo<T>
    
    See Also:
    
    FieldInfo.isFinal()
  - getFinalValue
```
public Object getFinalValue()
```
    Gets the final value for the field if it is defined as final.
    
    Returns:
    
    the final value for the field if defined as final; null otherwise
  - getValue
```
public Object getValue(T object)
```
    Retrieves the field's encoded value from the specified POJO.
    
    Parameters:
    
    object - the POJO from which to retrieve the field's value
    
    Returns:
    
    the POJO's field value
    
    Throws:
    
    NullPointerException - if object is null
  - getValue
```
public Object getValue(Class<?> clazz,
                       T object)
```
    Retrieves the field's encoded value from the specified POJO.
    
    Parameters:
    
    clazz - the class for the expected value
    
    object - the POJO from which to retrieve the field's value
    
    Returns:
    
    the POJO's field value
    
    Throws:
    
    NullPointerException - if object is null
    
    ClassCastException - if the field value from the given object cannot be type casted to the specified class
  - setValue
```
public void setValue(T object,
                     Object value)
```
    Sets the field's value in the specified POJO with the given value.
    
    Parameters:
    
    object - the POJO in which to set the field's value
    
    value - the value to set the field with
    
    Throws:
    
    NullPointerException - if object is null or if the column is a primary key or mandatory and value is null
  - decodeValue
```
public Object decodeValue(com.datastax.driver.core.Row row)
```
    Decodes the field's value based on the given row.
    
    Parameters:
    
    row - the row where the column encoded value is defined
    
    Returns:
    
    the decoded value for this field from the given row
    
    Throws:
    
    NullPointerException - if row is null
    
    ObjectConversionException - if unable to decode the column or if the column is not defined in the given row
  - decodeAndSetValue
```
public void decodeAndSetValue(T object,
                              com.datastax.driver.core.Row row)
```
    Decodes and sets the field's value in the specified POJO based on the given row.
    
    Parameters:
    
    object - the POJO in which to set the field's decoded value
    
    row - the row where the column encoded value is defined
    
    Throws:
    
    NullPointerException - if object or row is null
    
    ObjectConversionException - if unable to decode the column and store the corresponding value into the POJO object or if the column is a primary key, type key, or mandatory and not defined in the given row
  - decodeValue
```
public Object decodeValue(com.datastax.driver.core.UDTValue uval)
```
    Decodes the field's value based on the given UDT value.
    
    Parameters:
    
    uval - the UDT value where the column encoded value is defined
    
    Returns:
    
    the decoded value for this field from the given UDT value
    
    Throws:
    
    NullPointerException - if uval is null
    
    ObjectConversionException - if unable to decode the column or if the column is not defined in the given UDT value
  - decodeAndSetValue
```
public void decodeAndSetValue(T object,
                              com.datastax.driver.core.UDTValue uval)
```
    Decodes and sets the field's value in the specified POJO based on the given UDT value.
    
    Parameters:
    
    object - the POJO in which to set the field's decoded value
    
    uval - the UDT value where the column encoded value is defined
    
    Throws:
    
    NullPointerException - if object or uval is null
    
    ObjectConversionException - if unable to decode the column and store the corresponding value into the POJO object or if the column is mandatory and not defined in the given UDT value
  - udts
```
public java.util.stream.Stream<UDTClassInfoImpl<?>> udts()
```
    Gets all user-defined types this field is dependent on.
    
    Returns:
    
    a stream of all class infos for the user-defined types this field depends on
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class FieldInfoImpl<T>

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tinfo

definition

Method Detail

getObjectClass

getDeclaringClass

getClassInfo

getTableInfo

getName

getType

isColumn

isStatic

getColumnName

getKeyspaceKeyName

getDataType

isKeyspaceKey

getKeyspaceKey

isMandatory

isOptional

isIndex

getIndex

isCounter

isLast

isPartitionKey

getPartitionKey

isClusteringKey

getClusteringKey

isCaseInsensitiveKey

isTypeKey

getTypeKey

isMultiKey

getAnnotation

validateValue

getCodec

validateCollectionValue

validateListValue

validateSetValue

validateMapKeyValue

validateMapKey

isFinal

getFinalValue

getValue

getValue

setValue

decodeValue

decodeAndSetValue

decodeValue

decodeAndSetValue

udts

toString