com.datastax.driver.core

Interface GettableByNameData

All Known Subinterfaces:

GettableData, Row

All Known Implementing Classes:

AbstractGettableData, BoundStatement, UDTValue

public interface GettableByNameData

Collection of (typed) CQL values that can be retrieved by name.

Method Summary

Modifier and Type	Method and Description
<T> T	get(String name, Class<T> targetClass) Returns the value for name converted to the given Java type.
<T> T	get(String name, TypeCodec<T> codec) Returns the value for name converted using the given TypeCodec.
<T> T	get(String name, com.google.common.reflect.TypeToken<T> targetType) Returns the value for name converted to the given Java type.
boolean	getBool(String name) Returns the value for name as a boolean.
byte	getByte(String name) Returns the value for name as a byte.
ByteBuffer	getBytes(String name) Returns the value for name as a byte array.
ByteBuffer	getBytesUnsafe(String name) Returns the value for name as a ByteBuffer.
LocalDate	getDate(String name) Returns the value for name as a date (without time).
BigDecimal	getDecimal(String name) Returns the value for name as a variable length decimal.
double	getDouble(String name) Returns the value for name as a double.
float	getFloat(String name) Returns the value for name as a float.
InetAddress	getInet(String name) Returns the value for name as an InetAddress.
int	getInt(String name) Returns the value for name as an integer.
<T> List<T>	getList(String name, Class<T> elementsClass) Returns the value for name as a list.
<T> List<T>	getList(String name, com.google.common.reflect.TypeToken<T> elementsType) Returns the value for name as a list.
long	getLong(String name) Returns the value for name as a long.
<K,V> Map<K,V>	getMap(String name, Class<K> keysClass, Class<V> valuesClass) Returns the value for name as a map.
<K,V> Map<K,V>	getMap(String name, com.google.common.reflect.TypeToken<K> keysType, com.google.common.reflect.TypeToken<V> valuesType) Returns the value for name as a map.
Object	getObject(String name) Returns the value for name as the Java type matching its CQL type.
<T> Set<T>	getSet(String name, Class<T> elementsClass) Returns the value for name as a set.
<T> Set<T>	getSet(String name, com.google.common.reflect.TypeToken<T> elementsType) Returns the value for name as a set.
short	getShort(String name) Returns the value for name as a short.
String	getString(String name) Returns the value for name as a string.
long	getTime(String name) Returns the value for name as a long in nanoseconds since midnight.
Date	getTimestamp(String name) Returns the value for name as a date.
TupleValue	getTupleValue(String name) Return the value for name as a tuple value.
UDTValue	getUDTValue(String name) Return the value for name as a UDT value.
UUID	getUUID(String name) Returns the value for name as a UUID.
BigInteger	getVarint(String name) Returns the value for name as a variable length integer.
boolean	isNull(String name) Returns whether the value for name is NULL.

Method Detail

isNull

boolean isNull(String name)

Returns whether the value for name is NULL.

Parameters:

name - the name to check.

Returns:

whether the value for name is NULL.

Throws:

IllegalArgumentException - if name is not valid name for this object.

getBool

boolean getBool(String name)

Returns the value for name as a boolean.

Parameters:

name - the name to retrieve.

Returns:

the boolean value for name. If the value is NULL, false is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type BOOLEAN.

getByte

byte getByte(String name)

Returns the value for name as a byte.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a byte. If the value is NULL, 0 is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type TINYINT.

getShort

short getShort(String name)

Returns the value for name as a short.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a short. If the value is NULL, 0 is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type SMALLINT.

getInt

int getInt(String name)

Returns the value for name as an integer.

Parameters:

name - the name to retrieve.

Returns:

the value for name as an integer. If the value is NULL, 0 is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type INT.

getLong

long getLong(String name)

Returns the value for name as a long.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a long. If the value is NULL, 0L is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value i is not of type BIGINT or COUNTER.

getTimestamp

Date getTimestamp(String name)

Returns the value for name as a date.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a date. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type TIMESTAMP.

getDate

LocalDate getDate(String name)

Returns the value for name as a date (without time).

Parameters:

name - the name to retrieve.

Returns:

the value for name as a date. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type DATE.

getTime

long getTime(String name)

Returns the value for name as a long in nanoseconds since midnight.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a long. If the value is NULL, 0L is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type TIME.

getFloat

float getFloat(String name)

Returns the value for name as a float.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a float. If the value is NULL, 0.0f is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type FLOAT.

getDouble

double getDouble(String name)

Returns the value for name as a double.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a double. If the value is NULL, 0.0 is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type DOUBLE.

getBytesUnsafe

ByteBuffer getBytesUnsafe(String name)

Returns the value for name as a ByteBuffer. Note: this method always return the bytes composing the value, even if the column is not of type BLOB. That is, this method never throw an InvalidTypeException. However, if the type is not BLOB, it is up to the caller to handle the returned value correctly.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a ByteBuffer. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

getBytes

ByteBuffer getBytes(String name)

Returns the value for name as a byte array.

Note that this method validate that the column is of type BLOB. If you want to retrieve the bytes for any type, use getBytesUnsafe(String) instead.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a byte array. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value i type is not of type BLOB.

getString

String getString(String name)

Returns the value for name as a string.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a string. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name type is none of: VARCHAR, TEXT or ASCII.

getVarint

BigInteger getVarint(String name)

Returns the value for name as a variable length integer.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a variable length integer. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type VARINT.

getDecimal

BigDecimal getDecimal(String name)

Returns the value for name as a variable length decimal.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a variable length decimal. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type DECIMAL.

getUUID

UUID getUUID(String name)

Returns the value for name as a UUID.

Parameters:

name - the name to retrieve.

Returns:

the value for name as a UUID. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type UUID or TIMEUUID.

getInet

InetAddress getInet(String name)

Returns the value for name as an InetAddress.

Parameters:

name - the name to retrieve.

Returns:

the value for name as an InetAddress. If the value is NULL, null is returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not of type INET.

getList

<T> List<T> getList(String name,
                    Class<T> elementsClass)

Returns the value for name as a list.

If the type of the elements is generic, use getList(String, TypeToken).

Parameters:

name - the name to retrieve.

elementsClass - the class for the elements of the list to retrieve.

Returns:

the value of the ith element as a list of T objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a list or if its elements are not of class T.

getList

<T> List<T> getList(String name,
                    com.google.common.reflect.TypeToken<T> elementsType)

Returns the value for name as a list.

Use this variant with nested collections, which produce a generic element type:

  List<List<String>> l = row.getList("theColumn", new TypeToken<List<String>>() {});
 

Parameters:

name - the name to retrieve.

elementsType - the type for the elements of the list to retrieve.

Returns:

the value of the ith element as a list of T objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a list or if its elements are not of class T.

getSet

<T> Set<T> getSet(String name,
                  Class<T> elementsClass)

Returns the value for name as a set.

If the type of the elements is generic, use getSet(String, TypeToken).

Parameters:

name - the name to retrieve.

elementsClass - the class for the elements of the set to retrieve.

Returns:

the value of the ith element as a set of T objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a set or if its elements are not of class T.

getSet

<T> Set<T> getSet(String name,
                  com.google.common.reflect.TypeToken<T> elementsType)

Returns the value for name as a set.

Use this variant with nested collections, which produce a generic element type:

  Set<List<String>> l = row.getSet("theColumn", new TypeToken<List<String>>() {});
 

Parameters:

name - the name to retrieve.

elementsType - the type for the elements of the set to retrieve.

Returns:

the value of the ith element as a set of T objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a set or if its elements are not of class T.

getMap

<K,V> Map<K,V> getMap(String name,
                      Class<K> keysClass,
                      Class<V> valuesClass)

Returns the value for name as a map.

If the type of the keys and/or values is generic, use getMap(String, TypeToken, TypeToken).

Parameters:

name - the name to retrieve.

keysClass - the class for the keys of the map to retrieve.

valuesClass - the class for the values of the map to retrieve.

Returns:

the value of name as a map of K to V objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a map, if its keys are not of class K or if its values are not of class V.

getMap

<K,V> Map<K,V> getMap(String name,
                      com.google.common.reflect.TypeToken<K> keysType,
                      com.google.common.reflect.TypeToken<V> valuesType)

Returns the value for name as a map.

Use this variant with nested collections, which produce a generic element type:

  Map<Int, List<String>> l = row.getMap("theColumn", TypeToken.of(Integer.class), new TypeToken<List<String>>() {});
 

Parameters:

name - the name to retrieve.

keysType - the class for the keys of the map to retrieve.

valuesType - the class for the values of the map to retrieve.

Returns:

the value of name as a map of K to V objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value name is not a map, if its keys are not of class K or if its values are not of class V.

getUDTValue

UDTValue getUDTValue(String name)

Return the value for name as a UDT value.

Parameters:

name - the name to retrieve.

Returns:

the value of name as a UDT value. If the value is NULL, then null will be returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value i is not a UDT value.

getTupleValue

TupleValue getTupleValue(String name)

Return the value for name as a tuple value.

Parameters:

name - the name to retrieve.

Returns:

the value of name as a tuple value. If the value is NULL, then null will be returned.

Throws:

IllegalArgumentException - if name is not valid name for this object.

InvalidTypeException - if value i is not a tuple value.

getObject

Object getObject(String name)

Returns the value for name as the Java type matching its CQL type.

This method uses the default codec for the underlying CQL type to perform deserialization, and is safe to be used as long as only default codecs are in use. If a second, custom codec for the same CQL type is registered, which one will be used is unspecified; in such cases, it is preferable to use the more deterministic methods get(String, Class) or get(String, TypeToken) instead.

Parameters:

name - the name to retrieve.

Returns:

the value of the ith value as the Java type matching its CQL type. If the value is NULL and is a simple type, UDT or tuple, null is returned. If it is NULL and is a collection type, an empty (immutable) collection is returned.

Throws:

IllegalArgumentException - if name is not a valid name for this object.

get

<T> T get(String name,
          Class<T> targetClass)

Returns the value for name converted to the given Java type.

A suitable TypeCodec instance for for the underlying CQL type and targetClass must have been previously registered with the CodecRegistry currently in use.

This method should be used instead of getObject(String) in cases where more than one codec is registered for the same CQL type; specifying the Java class allows the CodecRegistry to narrow down the search and return only an exactly-matching codec (if any), thus avoiding any risk of ambiguity.

Parameters:

name - the name to retrieve.

targetClass - The Java type the value should be converted to.

Returns:

the value for name value converted to the given Java type. If the CQL value is NULL, then null is returned.

Throws:

IllegalArgumentException - if name is not a valid name for this object.

CodecNotFoundException - if no TypeCodec instance for targetClass could be found by the CodecRegistry currently in use.

get

<T> T get(String name,
          com.google.common.reflect.TypeToken<T> targetType)

Returns the value for name converted to the given Java type.

A suitable TypeCodec instance for for the underlying CQL type and targetType must have been previously registered with the CodecRegistry currently in use.

This method should be used instead of getObject(String) in cases where more than one codec is registered for the same CQL type; specifying the Java class allows the CodecRegistry to narrow down the search and return only an exactly-matching codec (if any), thus avoiding any risk of ambiguity.

Parameters:

name - the name to retrieve.

targetType - The Java type the value should be converted to.

Returns:

the value for name value converted to the given Java type. If the CQL value is NULL, then null is returned.

Throws:

IllegalArgumentException - if name is not a valid name for this object.

CodecNotFoundException - if no TypeCodec instance for targetType could be found by the CodecRegistry currently in use.

get

<T> T get(String name,
          TypeCodec<T> codec)

Returns the value for name converted using the given TypeCodec.

Note that this method allows to entirely bypass the CodecRegistry currently in use and forces the driver to use the given codec instead.

It is the caller's responsibility to ensure that the given codec accepts the underlying CQL type; failing to do so may result in InvalidTypeExceptions being thrown.

Parameters:

name - the name to retrieve.

codec - The TypeCodec to use to deserialize the value; may not be null.

Returns:

the value of the ith value converted using the given TypeCodec.

Throws:

InvalidTypeException - if the given codec does not accept the underlying CQL type.

IndexOutOfBoundsException - if i is not a valid index for this object.