com.ing.data.cassandra.jdbc.metadata

Class MetadataRow

java.lang.Object

com.ing.data.cassandra.jdbc.metadata.MetadataRow

public class MetadataRow
extends Object

The content of a metadata row returned in a CassandraMetadataResultSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataRow.MetadataRowTemplate A template of metadata row.

Constructor Summary

Constructors

Constructor and Description
MetadataRow() Constructor.

Method Summary

Modifier and Type	Method and Description
MetadataRow	addEntry(String key, Object value, com.datastax.oss.driver.api.core.type.DataType type) Add a metadata to this MetadataRow instance.
boolean	getBool(int i) Retrieves the value of the ith column of the metadata row as boolean.
boolean	getBool(String name) Retrieves the value of the column name of the metadata row as boolean.
byte	getByte(int i) Retrieves the value of the ith column of the metadata row as byte.
byte	getByte(String name) Retrieves the value of the column name of the metadata row as byte.
ByteBuffer	getBytes(int i) Retrieves the value of the ith column of the metadata row as ByteBuffer.
ByteBuffer	getBytes(String name) Retrieves the value of the column name of the metadata row as ByteBuffer.
ColumnDefinitions	getColumnDefinitions() Gets the column definitions for the metadata row.
Date	getDate(int i) Retrieves the value of the ith column of the metadata row as Date.
Date	getDate(String name) Retrieves the value of the column name of the metadata row as Date.
BigDecimal	getDecimal(int i) Retrieves the value of the ith column of the metadata row as BigDecimal.
BigDecimal	getDecimal(String name) Retrieves the value of the column name of the metadata row as BigDecimal.
double	getDouble(int i) Retrieves the value of the ith column of the metadata row as double.
double	getDouble(String name) Retrieves the value of the column name of the metadata row as double.
com.datastax.oss.driver.api.core.data.CqlDuration	getDuration(int i) Retrieves the value of the ith column of the metadata row as CqlDuration.
com.datastax.oss.driver.api.core.data.CqlDuration	getDuration(String name) Retrieves the value of the column name of the metadata row as CqlDuration.
float	getFloat(int i) Retrieves the value of the ith column of the metadata row as float.
float	getFloat(String name) Retrieves the value of the column name of the metadata row as float.
InetAddress	getInet(int i) Retrieves the value of the ith column of the metadata row as InetAddress.
InetAddress	getInet(String name) Retrieves the value of the column name of the metadata row as InetAddress.
int	getInt(int i) Retrieves the value of the ith column of the metadata row as int.
Integer	getInt(String name) Retrieves the value of the column name of the metadata row as int.
<T> List<T>	getList(int i, Class<T> elementsClass) Retrieves the value of the ith column of the metadata row as List.
<T> List<T>	getList(String name, Class<T> elementsClass) Retrieves the value of the column name of the metadata row as List.
long	getLong(int i) Retrieves the value of the ith column of the metadata row as long.
long	getLong(String name) Retrieves the value of the column name of the metadata row as long.
<K,V> Map<K,V>	getMap(int i, Class<K> keysClass, Class<V> valuesClass) Retrieves the value of the ith column of the metadata row as Map.
<K,V> Map<K,V>	getMap(String name, Class<K> keysClass, Class<V> valuesClass) Retrieves the value of the column name of the metadata row as Map.
<T> Set<T>	getSet(int i, Class<T> elementsClass) Retrieves the value of the ith column of the metadata row as Set.
<T> Set<T>	getSet(String name, Class<T> elementsClass) Retrieves the value of the column name of the metadata row as Set.
short	getShort(int i) Retrieves the value of the ith column of the metadata row as short.
short	getShort(String name) Retrieves the value of the column name of the metadata row as short.
String	getString(int i) Retrieves the value of the ith column of the metadata row as String.
String	getString(String name) Retrieves the value of the column name of the metadata row as String.
Time	getTime(int i) Retrieves the value of the ith column of the metadata row as Time.
Time	getTime(String name) Retrieves the value of the column name of the metadata row as Time.
UUID	getUUID(int i) Retrieves the value of the ith column of the metadata row as UUID.
UUID	getUUID(String name) Retrieves the value of the column name of the metadata row as UUID.
BigInteger	getVarint(int i) Retrieves the value of the ith column of the metadata row as BigInteger.
BigInteger	getVarint(String name) Retrieves the value of the column name of the metadata row as BigInteger.
boolean	isNull(int i) Gets whether the ith column of the metadata row is null.
boolean	isNull(String name) Gets whether the column name of the metadata row is null.
String	toString()
MetadataRow	withTemplate(MetadataRow.MetadataRowTemplate template, Object... values) Populates a metadata row defined by a row template with the specified values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataRow

public MetadataRow()

Constructor.

Method Detail

addEntry

public MetadataRow addEntry(String key,
                            Object value,
                            com.datastax.oss.driver.api.core.type.DataType type)

Add a metadata to this MetadataRow instance.

Parameters:

key - The metadata key.

value - The metadata value.

type - The metadata column type.

Returns:

The updated MetadataRow instance.

withTemplate

public MetadataRow withTemplate(MetadataRow.MetadataRowTemplate template,
                                Object... values)

Populates a metadata row defined by a row template with the specified values.

The number of values must match the number of columns defined in the row template, otherwise a runtime exception will be thrown.

Parameters:

template - The row template.

values - The values used to populate the metadata row.

Returns:

The updated MetadataRow instance.

Throws:

RuntimeException - when the number of values does not match the number of columns defined in the row template.

getColumnDefinitions

public ColumnDefinitions getColumnDefinitions()

Gets the column definitions for the metadata row.

Returns:

The column definitions for the metadata row.

isNull

public boolean isNull(int i)

Gets whether the ith column of the metadata row is null.

Parameters:

i - The column index (the first column is 0).

Returns:

true if the ith column of the metadata row is null, false otherwise.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

isNull

public boolean isNull(String name)

Gets whether the column name of the metadata row is null.

Parameters:

name - The column name.

Returns:

true if the column name of the metadata row is null, false otherwise.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getBool

public boolean getBool(int i)

Retrieves the value of the ith column of the metadata row as boolean.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value. If the underlying value is NULL, the value returned is false.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getBool

public boolean getBool(String name)

Retrieves the value of the column name of the metadata row as boolean.

Parameters:

name - The column name.

Returns:

The metadata value. If the underlying value is NULL, the value returned is false.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getByte

public byte getByte(int i)

Retrieves the value of the ith column of the metadata row as byte.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getByte

public byte getByte(String name)

Retrieves the value of the column name of the metadata row as byte.

Parameters:

name - The column name.

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getShort

public short getShort(int i)

Retrieves the value of the ith column of the metadata row as short.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getShort

public short getShort(String name)

Retrieves the value of the column name of the metadata row as short.

Parameters:

name - The column name.

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getInt

public int getInt(int i)

Retrieves the value of the ith column of the metadata row as int.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getInt

public Integer getInt(String name)

Retrieves the value of the column name of the metadata row as int.

Parameters:

name - The column name.

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getLong

public long getLong(int i)

Retrieves the value of the ith column of the metadata row as long.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getLong

public long getLong(String name)

Retrieves the value of the column name of the metadata row as long.

Parameters:

name - The column name.

Returns:

The metadata value. If the underlying value is NULL, the value returned is 0.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getDate

public Date getDate(int i)

Retrieves the value of the ith column of the metadata row as Date.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getDate

public Date getDate(String name)

Retrieves the value of the column name of the metadata row as Date.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getTime

public Time getTime(int i)

Retrieves the value of the ith column of the metadata row as Time.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getTime

public Time getTime(String name)

Retrieves the value of the column name of the metadata row as Time.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getDuration

public com.datastax.oss.driver.api.core.data.CqlDuration getDuration(int i)

Retrieves the value of the ith column of the metadata row as CqlDuration.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getDuration

public com.datastax.oss.driver.api.core.data.CqlDuration getDuration(String name)

Retrieves the value of the column name of the metadata row as CqlDuration.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getFloat

public float getFloat(int i)

Retrieves the value of the ith column of the metadata row as float.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getFloat

public float getFloat(String name)

Retrieves the value of the column name of the metadata row as float.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getDouble

public double getDouble(int i)

Retrieves the value of the ith column of the metadata row as double.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getDouble

public double getDouble(String name)

Retrieves the value of the column name of the metadata row as double.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getBytes

public ByteBuffer getBytes(int i)

Retrieves the value of the ith column of the metadata row as ByteBuffer.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getBytes

public ByteBuffer getBytes(String name)

Retrieves the value of the column name of the metadata row as ByteBuffer.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getString

public String getString(int i)

Retrieves the value of the ith column of the metadata row as String.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getString

public String getString(String name)

Retrieves the value of the column name of the metadata row as String.

Parameters:

name - the column name

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getVarint

public BigInteger getVarint(int i)

Retrieves the value of the ith column of the metadata row as BigInteger.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getVarint

public BigInteger getVarint(String name)

Retrieves the value of the column name of the metadata row as BigInteger.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getDecimal

public BigDecimal getDecimal(int i)

Retrieves the value of the ith column of the metadata row as BigDecimal.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getDecimal

public BigDecimal getDecimal(String name)

Retrieves the value of the column name of the metadata row as BigDecimal.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getUUID

public UUID getUUID(int i)

Retrieves the value of the ith column of the metadata row as UUID.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getUUID

public UUID getUUID(String name)

Retrieves the value of the column name of the metadata row as UUID.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getInet

public InetAddress getInet(int i)

Retrieves the value of the ith column of the metadata row as InetAddress.

Parameters:

i - The column index (the first column is 0).

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getInet

public InetAddress getInet(String name)

Retrieves the value of the column name of the metadata row as InetAddress.

Parameters:

name - The column name.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getList

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

Retrieves the value of the ith column of the metadata row as List.

Type Parameters:

T - The type of the list elements.

Parameters:

i - The column index (the first column is 0).

elementsClass - The class of the list elements.

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getList

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

Retrieves the value of the column name of the metadata row as List.

Type Parameters:

T - The type of the list elements.

Parameters:

name - The column name.

elementsClass - The class of the list elements.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getSet

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

Retrieves the value of the ith column of the metadata row as Set.

Type Parameters:

T - The type of the set elements.

Parameters:

i - The column index (the first column is 0).

elementsClass - The class of the set elements.

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getSet

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

Retrieves the value of the column name of the metadata row as Set.

Type Parameters:

T - The type of the set elements.

Parameters:

name - The column name.

elementsClass - The class of the set elements.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

getMap

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

Retrieves the value of the ith column of the metadata row as Map.

Type Parameters:

K - The type of the map keys.

V - The type of the map values.

Parameters:

i - The column index (the first column is 0).

keysClass - The class of the map keys.

valuesClass - The class of the map values.

Returns:

The metadata value.

Throws:

IndexOutOfBoundsException - if i < 0 or i >= size().

getMap

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

Retrieves the value of the column name of the metadata row as Map.

Type Parameters:

K - The type of the map keys.

V - The type of the map values.

Parameters:

name - The column name.

keysClass - The class of the map keys.

valuesClass - The class of the map values.

Returns:

The metadata value.

Throws:

IllegalArgumentException - if name is not a valid metadata name for this row.

toString

public String toString()

Overrides:

toString in class Object