com.datastax.driver.core
Interface Row

public interface Row

A CQL Row returned in a ResultSet.

The values of a CQL Row can be retrieve by either index (index starts at 0) or name. When setting them by name, names follow the case insensitivity rules explained in ColumnDefinitions.

Method Summary

boolean	getBool(int i) Returns the ith value of this row as a boolean.
boolean	getBool(String name) Returns the value of column name as a boolean.
ByteBuffer	getBytes(int i) Returns the ith value of this row as a byte array.
ByteBuffer	getBytes(String name) Returns the value of column name as a byte array.
ByteBuffer	getBytesUnsafe(int i) Returns the ith value of this row as a ByteBuffer.
ByteBuffer	getBytesUnsafe(String name) Returns the value of column name as a ByteBuffer.
ColumnDefinitions	getColumnDefinitions() Returns the columns contained in this Row.
Date	getDate(int i) Returns the ith value of this row as a date.
Date	getDate(String name) Returns the value of column name as a date.
BigDecimal	getDecimal(int i) Returns the ith value of this row as a variable length decimal.
BigDecimal	getDecimal(String name) Returns the value of column name as a variable length decimal.
double	getDouble(int i) Returns the ith value of this row as a double.
double	getDouble(String name) Returns the value of column name as a double.
float	getFloat(int i) Returns the ith value of this row as a float.
float	getFloat(String name) Returns the value of column name as a float.
InetAddress	getInet(int i) Returns the ith value of this row as an InetAddress.
InetAddress	getInet(String name) Returns the value of column name as an InetAddress.
int	getInt(int i) Returns the ith value of this row as an integer.
int	getInt(String name) Returns the value of column name as an integer.
<T> List<T>	getList(int i, Class<T> elementsClass) Returns the ith value of this row as a list.
<T> List<T>	getList(String name, Class<T> elementsClass) Returns the value of column name as a list.
long	getLong(int i) Returns the ith value of this row as a long.
long	getLong(String name) Returns the value of column name as a long.
<K,V> Map<K,V>	getMap(int i, Class<K> keysClass, Class<V> valuesClass) Returns the ith value of this row as a map.
<K,V> Map<K,V>	getMap(String name, Class<K> keysClass, Class<V> valuesClass) Returns the value of column name as a map.
<T> Set<T>	getSet(int i, Class<T> elementsClass) Returns the ith value of this row as a set.
<T> Set<T>	getSet(String name, Class<T> elementsClass) Returns the value of column name as a set.
String	getString(int i) Returns the ith value of this row as a string.
String	getString(String name) Returns the value of column name as a string.
UUID	getUUID(int i) Returns the ith value of this row as a UUID.
UUID	getUUID(String name) Returns the value of column name as a UUID.
BigInteger	getVarint(int i) Returns the ith value of this row as a variable length integer.
BigInteger	getVarint(String name) Returns the value of column name as a variable length integer.
boolean	isNull(int i) Returns whether the ith value of this row is NULL.
boolean	isNull(String name) Returns whether the value for column name in this row is NULL.

Method Detail

getColumnDefinitions

ColumnDefinitions getColumnDefinitions()

Returns the columns contained in this Row.

Returns:

the columns contained in this Row.

isNull

boolean isNull(int i)

Returns whether the ith value of this row is NULL.

Parameters:

i - the index (0 <= i < size()) of the column to check.

Returns:

whether the ith value of this row is NULL.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

isNull

boolean isNull(String name)

Returns whether the value for column name in this row is NULL.

Parameters:

name - the name of the column to check.

Returns:

whether the value of column name is NULL.

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

getBool

boolean getBool(int i)

Returns the ith value of this row as a boolean.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the boolean value of the ith column in this row. If the value is NULL, false is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type BOOLEAN.

getBool

boolean getBool(String name)

Returns the value of column name as a boolean.

Parameters:

name - the name of the column to retrieve.

Returns:

the boolean value of column name. If the value is NULL, false is returned.

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type BOOLEAN.

getInt

int getInt(int i)

Returns the ith value of this row as an integer.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as an integer. If the value is NULL, 0 is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type INT.

getInt

int getInt(String name)

Returns the value of column name as an integer.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type INT.

getLong

long getLong(int i)

Returns the ith value of this row as a long.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a long. If the value is NULL, 0L is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

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

getLong

long getLong(String name)

Returns the value of column name as a long.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

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

getDate

Date getDate(int i)

Returns the ith value of this row as a date.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a data. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type TIMESTAMP.

getDate

Date getDate(String name)

Returns the value of column name as a date.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type TIMESTAMP.

getFloat

float getFloat(int i)

Returns the ith value of this row as a float.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a float. If the value is NULL, 0.0f is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type FLOAT.

getFloat

float getFloat(String name)

Returns the value of column name as a float.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type FLOAT.

getDouble

double getDouble(int i)

Returns the ith value of this row as a double.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a double. If the value is NULL, 0.0 is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type DOUBLE.

getDouble

double getDouble(String name)

Returns the value of column name as a double.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type DOUBLE.

getBytesUnsafe

ByteBuffer getBytesUnsafe(int i)

Returns the ith value of this row 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:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a ByteBuffer. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

getBytesUnsafe

ByteBuffer getBytesUnsafe(String name)

Returns the value of column 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 of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

getBytes

ByteBuffer getBytes(int i)

Returns the ith value of this row as a byte array.

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

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a byte array. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

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

getBytes

ByteBuffer getBytes(String name)

Returns the value of column 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 of columns, use getBytesUnsafe(String) instead.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

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

getString

String getString(int i)

Returns the ith value of this row as a string.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a string. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i type is none of: VARCHAR, TEXT or ASCII.

getString

String getString(String name)

Returns the value of column name as a string.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

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

getVarint

BigInteger getVarint(int i)

Returns the ith value of this row as a variable length integer.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a variable length integer. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type VARINT.

getVarint

BigInteger getVarint(String name)

Returns the value of column name as a variable length integer.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type VARINT.

getDecimal

BigDecimal getDecimal(int i)

Returns the ith value of this row as a variable length decimal.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a variable length decimal. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type DECIMAL.

getDecimal

BigDecimal getDecimal(String name)

Returns the value of column name as a variable length decimal.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type DECIMAL.

getUUID

UUID getUUID(int i)

Returns the ith value of this row as a UUID.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as a UUID. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type UUID or TIMEUUID.

getUUID

UUID getUUID(String name)

Returns the value of column name as a UUID.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

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

getInet

InetAddress getInet(int i)

Returns the ith value of this row as an InetAddress.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

Returns:

the value of the ith column in this row as an InetAddress. If the value is NULL, null is returned.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not of type INET.

getInet

InetAddress getInet(String name)

Returns the value of column name as an InetAddress.

Parameters:

name - the name of the column to retrieve.

Returns:

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

Throws:

IllegalArgumentException - if name is not part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not of type INET.

getList

<T> List<T> getList(int i,
                    Class<T> elementsClass)

Returns the ith value of this row as a list.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

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

Returns:

the value of the ith column in this row as a list of elementsClass 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:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not a list or if its elements are not of class elementsClass.

getList

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

Returns the value of column name as a list.

Parameters:

name - the name of the column to retrieve.

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

Returns:

the value of the ith column in this row as a list of elementsClass 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 part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not a list or if its elements are not of class elementsClass.

getSet

<T> Set<T> getSet(int i,
                  Class<T> elementsClass)

Returns the ith value of this row as a set.

Parameters:

i - the index (0 <= i < size()) of the column to retrieve.

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

Returns:

the value of the ith column in this row as a set of elementsClass 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:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not a set or if its elements are not of class elementsClass.

getSet

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

Returns the value of column name as a set.

Parameters:

name - the name of the column to retrieve.

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

Returns:

the value of the ith column in this row as a set of elementsClass 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 part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not a set or if its elements are not of class elementsClass.

getMap

<K,V> Map<K,V> getMap(int i,
                      Class<K> keysClass,
                      Class<V> valuesClass)

Returns the ith value of this row as a map.

Parameters:

i - the index (0 <= i < size()) of the column 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 the ith column in this row as a map of keysClass to valuesClass 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:

IndexOutOfBoundsException - if i < 0 || i >= this.columns().size().

InvalidTypeException - if column i is not a map, if its keys are not of class keysClass or if its values are not of class valuesClass.

getMap

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

Returns the value of column name as a map.

Parameters:

name - the name of the column 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 the ith column in this row as a map of keysClass to valuesClass 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 part of the ResultSet this row is part of, i.e. if !this.columns().names().contains(name).

InvalidTypeException - if column name is not a map, if its keys are not of class keysClass or if its values are not of class valuesClass.