DataDecoder (Helenus Implementation 1.0.14 API)

java.lang.Object
- org.helenus.driver.impl.DataDecoder<V>

Type Parameters:

V - the type of data being decoded
```
public abstract class DataDecoder<V>
extends Object
```
The DataDecoder abstract class defines the decoding functionality for a column.
Supported conversions are: - "ascii" to Enum, Class, Locale, ZoneId, or String - "bigint" to Long - "blob" to byte[] or ByteBuffer - "boolean" to Boolean - "counter" to AtomicLong or Long - "decimal" to BigDecimal - "double" to Double - "float" to Float - "inet" to InetAddress - "int" to Integer - "text" to String - "timestamp" to Date, Instant, or Long - "uuid" to UUID - "varchar" to String - "varint" to BigInteger - "timeuuid" to UUID - "list<ctype>" to List of the corresponding element type - "map<ctype, ctype>" to Map of the corresponding element types - "set<ctype>" to Set of the corresponding element type - "frozen<udt>" to an object of the user-defined type

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Field Summary

Fields
Modifier and Type	Field and Description
`static DataDecoder<Class>`	`asciiToClass` Holds the "ascii" to `Class` decoder.
`static DataDecoder<Enum>`	`asciiToEnum` Holds the "ascii" to `Enum` decoder.
`static DataDecoder<Locale>`	`asciiToLocale` Holds the "ascii" to `Locale` decoder.
`static DataDecoder<String>`	`asciiToString` Holds the "ascii" to `String` decoder.
`static DataDecoder<java.time.ZoneId>`	`asciiToZoneId` Holds the "ascii" to `ZoneId` decoder.
`static DataDecoder<Long>`	`bigintToLong` Holds the "bigint" to `Long` decoder.
`static DataDecoder<byte[]>`	`blobToByteArray` Holds the "blob" to `byte[]` decoder.
`static DataDecoder<ByteBuffer>`	`blobToByteBuffer` Holds the "blob" to `ByteBuffer` decoder.
`static DataDecoder<Boolean>`	`booleanToBoolean` Holds the "boolean" to `Boolean` decoder.
`static DataDecoder<AtomicLong>`	`counterToAtomicLong` Holds the "counter" to `AtomicLong` decoder.
`static DataDecoder<Long>`	`counterToLong` Holds the "counter" to `Long` decoder.
`static DataDecoder<BigDecimal>`	`decimalToBigDecimal` Holds the "decimal" to `BigDecimal` decoder.
`static DataDecoder<Double>`	`doubleToDouble` Holds the "double" to `Double` decoder.
`static DataDecoder<Float>`	`floatToFloat` Holds the "float" to `Float` decoder.
`static DataDecoder<InetAddress>`	`inetToInetAddress` Holds the "inet" to `InetAddress` decoder.
`static DataDecoder<Integer>`	`intToInteger` Holds the "int" to `Integer` decoder.
`static DataDecoder<String>`	`textToString` Holds the "text" to `String` decoder.
`static DataDecoder<Date>`	`timestampToDate` Holds the "timestamp" to `Date` decoder.
`static DataDecoder<java.time.Instant>`	`timestampToInstant` Holds the "timestamp" to `Instant` decoder.
`static DataDecoder<Long>`	`timestampToLong` Holds the "timestamp" to `Long` decoder.
`static DataDecoder<UUID>`	`timeuuidToUUID` Holds the "timeuuid" to `UUID` decoder.
`static DataDecoder<UUID>`	`uuidToUUID` Holds the "uuid" to `UUID` decoder.
`static DataDecoder<String>`	`varcharToString` Holds the "varchar" to `String` decoder.
`static DataDecoder<BigInteger>`	`varintToBigInteger` Holds the "varint" to `BigInteger` decoder.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canDecodeTo(Class<?> clazz)` Checks if this decoder can decode to the specified class.
`V`	`decode(com.datastax.driver.core.Row row, String name, Class<V> clazz)` Decodes the specified column from the given row and return the value that matches the decoder's defined class.
`V`	`decode(com.datastax.driver.core.UDTValue uval, String name, Class<V> clazz)` Decodes the specified column from the given UDT value and return the value that matches the decoder's defined class.
`protected abstract V`	`decodeImpl(com.datastax.driver.core.Row row, String name, Class<V> clazz)` Decodes the specified column from the given row and return the value that matches the decoder's defined class.
`protected abstract V`	`decodeImpl(com.datastax.driver.core.UDTValue uval, String name, Class<V> clazz)` Decodes the specified column from the given UDT value and return the value that matches the decoder's defined class.
`static Class<?>`	`findClass(String name)` Finds and loads the specified class.
`static DataDecoder<List>`	`list(Class<?> eclazz, boolean mandatory)` Gets a "list" to `List` decoder based on the given element class.
`static DataDecoder<Map>`	`map(Class<?> ekclazz, Class<?> evclazz, boolean mandatory)` Gets a "map" to `Map` decoder based on the given key and value classes.
`static DataDecoder<LinkedHashSet>`	`orderedSet(Class<?> eclazz, boolean mandatory)` Gets a "list" to `Set` decoder based on the given element class.
`static DataDecoder<Set>`	`set(Class<?> eclazz, boolean mandatory)` Gets a "set" to `Set` decoder based on the given element class.
`static DataDecoder<SortedMap>`	`sortedMap(Class<?> ekclazz, Class<?> evclazz, boolean mandatory)` Gets a "map" to `SortedMap` decoder based on the given key and value classes.
`static DataDecoder<Object>`	`udt(UDTClassInfoImpl<?> cinfo)` Gets a "udt" to `Object` decoder based on the given UDT class info.

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

- Field Detail
  - asciiToString
```
public static final DataDecoder<String> asciiToString
```
    Holds the "ascii" to String decoder.
  - asciiToEnum
```
public static final DataDecoder<Enum> asciiToEnum
```
    Holds the "ascii" to Enum decoder.
  - asciiToClass
```
public static final DataDecoder<Class> asciiToClass
```
    Holds the "ascii" to Class decoder.
  - asciiToLocale
```
public static final DataDecoder<Locale> asciiToLocale
```
    Holds the "ascii" to Locale decoder.
  - asciiToZoneId
```
public static final DataDecoder<java.time.ZoneId> asciiToZoneId
```
    Holds the "ascii" to ZoneId decoder.
  - bigintToLong
```
public static final DataDecoder<Long> bigintToLong
```
    Holds the "bigint" to Long decoder.
  - blobToByteArray
```
public static final DataDecoder<byte[]> blobToByteArray
```
    Holds the "blob" to byte[] decoder.
  - blobToByteBuffer
```
public static final DataDecoder<ByteBuffer> blobToByteBuffer
```
    Holds the "blob" to ByteBuffer decoder.
  - booleanToBoolean
```
public static final DataDecoder<Boolean> booleanToBoolean
```
    Holds the "boolean" to Boolean decoder.
  - counterToLong
```
public static final DataDecoder<Long> counterToLong
```
    Holds the "counter" to Long decoder.
  - counterToAtomicLong
```
public static final DataDecoder<AtomicLong> counterToAtomicLong
```
    Holds the "counter" to AtomicLong decoder.
  - decimalToBigDecimal
```
public static final DataDecoder<BigDecimal> decimalToBigDecimal
```
    Holds the "decimal" to BigDecimal decoder.
  - doubleToDouble
```
public static final DataDecoder<Double> doubleToDouble
```
    Holds the "double" to Double decoder.
  - floatToFloat
```
public static final DataDecoder<Float> floatToFloat
```
    Holds the "float" to Float decoder.
  - inetToInetAddress
```
public static final DataDecoder<InetAddress> inetToInetAddress
```
    Holds the "inet" to InetAddress decoder.
  - intToInteger
```
public static final DataDecoder<Integer> intToInteger
```
    Holds the "int" to Integer decoder.
  - textToString
```
public static final DataDecoder<String> textToString
```
    Holds the "text" to String decoder.
  - timestampToDate
```
public static final DataDecoder<Date> timestampToDate
```
    Holds the "timestamp" to Date decoder.
  - timestampToInstant
```
public static final DataDecoder<java.time.Instant> timestampToInstant
```
    Holds the "timestamp" to Instant decoder.
  - timestampToLong
```
public static final DataDecoder<Long> timestampToLong
```
    Holds the "timestamp" to Long decoder.
  - uuidToUUID
```
public static final DataDecoder<UUID> uuidToUUID
```
    Holds the "uuid" to UUID decoder.
  - varcharToString
```
public static final DataDecoder<String> varcharToString
```
    Holds the "varchar" to String decoder.
  - varintToBigInteger
```
public static final DataDecoder<BigInteger> varintToBigInteger
```
    Holds the "varint" to BigInteger decoder.
  - timeuuidToUUID
```
public static final DataDecoder<UUID> timeuuidToUUID
```
    Holds the "timeuuid" to UUID decoder.
- Method Detail
  - findClass
```
public static Class<?> findClass(String name)
                          throws ClassNotFoundException
```
    Finds and loads the specified class.
    Note: This method is designed to use the thread context class loader if set; otherwise it falls back to the primordial class loader.
    
    Parameters:
    
    name - the name of the class to find and load
    
    Returns:
    
    the corresponding non-null class
    
    Throws:
    
    LinkageError - if the linkage fails
    
    ExceptionInInitializerError - if the initialization provoked by this method fails
    
    ClassNotFoundException - if the class cannot be located
  - list
```
public static final DataDecoder<List> list(Class<?> eclazz,
                                           boolean mandatory)
```
    Gets a "list" to List decoder based on the given element class.
    
    Parameters:
    
    eclazz - the non-null class of elements
    
    mandatory - if the field associated with the decoder is mandatory or represents a primary key
    
    Returns:
    
    the non-null decoder for lists of the specified element class
  - set
```
public static final DataDecoder<Set> set(Class<?> eclazz,
                                         boolean mandatory)
```
    Gets a "set" to Set decoder based on the given element class.
    
    Parameters:
    
    eclazz - the non-null class of elements
    
    mandatory - if the field associated with the decoder is mandatory or represents a primary key
    
    Returns:
    
    the non-null decoder for sets of the specified element class
  - orderedSet
```
public static final DataDecoder<LinkedHashSet> orderedSet(Class<?> eclazz,
                                                          boolean mandatory)
```
    Gets a "list" to Set decoder based on the given element class.
    
    Parameters:
    
    eclazz - the non-null class of elements
    
    mandatory - if the field associated with the decoder is mandatory or represents a primary key
    
    Returns:
    
    the non-null decoder for sets of the specified element class
  - map
```
public static final DataDecoder<Map> map(Class<?> ekclazz,
                                         Class<?> evclazz,
                                         boolean mandatory)
```
    Gets a "map" to Map decoder based on the given key and value classes.
    
    Parameters:
    
    ekclazz - the non-null class of keys
    
    evclazz - the non-null class of values
    
    mandatory - if the field associated with the decoder is mandatory or represents a primary key
    
    Returns:
    
    the non-null decoder for maps of the specified key and value classes
  - sortedMap
```
public static final DataDecoder<SortedMap> sortedMap(Class<?> ekclazz,
                                                     Class<?> evclazz,
                                                     boolean mandatory)
```
    Gets a "map" to SortedMap decoder based on the given key and value classes.
    
    Parameters:
    
    ekclazz - the non-null class of keys
    
    evclazz - the non-null class of values
    
    mandatory - if the field associated with the decoder is mandatory or represents a primary key
    
    Returns:
    
    the non-null decoder for sorted maps of the specified key and value classes
  - udt
```
public static final DataDecoder<Object> udt(UDTClassInfoImpl<?> cinfo)
```
    Gets a "udt" to Object decoder based on the given UDT class info.
    
    Parameters:
    
    cinfo - the user-defined class info
    
    Returns:
    
    the non-null decoder for user-defined types represented by the given class info
  - decodeImpl
```
protected abstract V decodeImpl(com.datastax.driver.core.Row row,
                                String name,
                                Class<V> clazz)
```
    Decodes the specified column from the given row and return the value that matches the decoder's defined class.
    
    Parameters:
    
    row - the non-null row where the column value is defined
    
    name - the non-null name of the column to decode
    
    clazz - the non-null class to decode to
    
    Returns:
    
    the decoded object
    
    Throws:
    
    IllegalArgumentException - if decoding to clazz is not supported or if name is not part of the result set this row is part of
    
    com.datastax.driver.core.exceptions.InvalidTypeException - if column name type is not the expected one
  - decodeImpl
```
protected abstract V decodeImpl(com.datastax.driver.core.UDTValue uval,
                                String name,
                                Class<V> clazz)
```
    Decodes the specified column from the given UDT value and return the value that matches the decoder's defined class.
    
    Parameters:
    
    uval - the non-null UDT value where the column value is defined
    
    name - the non-null name of the column to decode
    
    clazz - the non-null class to decode to
    
    Returns:
    
    the decoded object
    
    Throws:
    
    IllegalArgumentException - if decoding to clazz is not supported or if name is not part of the UDT value
    
    com.datastax.driver.core.exceptions.InvalidTypeException - if column name type is not the expected one
  - canDecodeTo
```
public boolean canDecodeTo(Class<?> clazz)
```
    Checks if this decoder can decode to the specified class.
    
    Parameters:
    
    clazz - the class to check if the decoder can decode to
    
    Returns:
    
    true if this decoder can decode to the specified class; false otherwise
  - decode
```
public V decode(com.datastax.driver.core.Row row,
                String name,
                Class<V> clazz)
```
    Decodes the specified column from the given row and return the value that matches the decoder's defined class.
    
    Parameters:
    
    row - the non-null row where the column value is defined
    
    name - the non-null name of the column to decode
    
    clazz - the class to decode to
    
    Returns:
    
    the decoded object or null if the specified column doesn't exist in the rows
    
    Throws:
    
    NullPointerException - if row, name, or clazz is null
    
    IllegalArgumentException - if decoding to clazz is not supported or if name is not part of the result set this row is part of
    
    com.datastax.driver.core.exceptions.InvalidTypeException - if column name type is not the expected one
  - decode
```
public V decode(com.datastax.driver.core.UDTValue uval,
                String name,
                Class<V> clazz)
```
    Decodes the specified column from the given UDT value and return the value that matches the decoder's defined class.
    
    Parameters:
    
    uval - the non-null UDT value where the column value is defined
    
    name - the non-null name of the column to decode
    
    clazz - the class to decode to
    
    Returns:
    
    the decoded object or null if the specified column doesn't exist in the UDT value
    
    Throws:
    
    NullPointerException - if uval, name, or clazz is null
    
    IllegalArgumentException - if decoding to clazz is not supported or if name is not part of the UDT value
    
    com.datastax.driver.core.exceptions.InvalidTypeException - if column name type is not the expected one

Class DataDecoder<V>

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

asciiToString

asciiToEnum

asciiToClass

asciiToLocale

asciiToZoneId

bigintToLong

blobToByteArray

blobToByteBuffer

booleanToBoolean

counterToLong

counterToAtomicLong

decimalToBigDecimal

doubleToDouble

floatToFloat

inetToInetAddress

intToInteger

textToString

timestampToDate

timestampToInstant

timestampToLong

uuidToUUID

varcharToString

varintToBigInteger

timeuuidToUUID

Method Detail

findClass

list

set

orderedSet

map

sortedMap

udt

decodeImpl

decodeImpl

canDecodeTo

decode

decode