io.delta.standalone.data

Interface RowRecord

public interface RowRecord

Represents one row of data containing a non-empty collection of fieldName - value pairs. It provides APIs to allow retrieval of values through fieldName lookup. For example,

   if (row.isNullAt("int_field")) {
     // handle the null value.
   } else {
     int x = getInt("int_field");
   }
 

See Also:

StructType, StructField

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getBigDecimal(String fieldName) Retrieves value from data record and returns the value as a java.math.BigDecimal.
byte[]	getBinary(String fieldName) Retrieves value from data record and returns the value as binary (byte array).
boolean	getBoolean(String fieldName) Retrieves value from data record and returns the value as a primitive boolean.
byte	getByte(String fieldName) Retrieves value from data record and returns the value as a primitive byte.
java.sql.Date	getDate(String fieldName) Retrieves value from data record and returns the value as a java.sql.Date.
double	getDouble(String fieldName) Retrieves value from data record and returns the value as a primitive double.
float	getFloat(String fieldName) Retrieves value from data record and returns the value as a primitive float.
int	getInt(String fieldName) Retrieves value from data record and returns the value as a primitive int.
int	getLength()
<T> java.util.List<T>	getList(String fieldName) Retrieves value from data record and returns the value as a java.util.List<T> object.
long	getLong(String fieldName) Retrieves value from data record and returns the value as a primitive long.
<K,V> java.util.Map<K,V>	getMap(String fieldName) Retrieves value from data record and returns the value as a java.util.Map<K, V> object.
RowRecord	getRecord(String fieldName) Retrieves value from data record and returns the value as a RowRecord object.
StructType	getSchema()
short	getShort(String fieldName) Retrieves value from data record and returns the value as a primitive short.
String	getString(String fieldName) Retrieves value from data record and returns the value as a String object.
java.sql.Timestamp	getTimestamp(String fieldName) Retrieves value from data record and returns the value as a java.sql.Timestamp.
boolean	isNullAt(String fieldName)

Method Detail

getSchema

StructType getSchema()

Returns:

the schema for this RowRecord

getLength

int getLength()

Returns:

the number of elements in this RowRecord

isNullAt

boolean isNullAt(String fieldName)

Parameters:

fieldName - name of field/column, not null

Returns:

whether the value of field fieldName is null

getInt

int getInt(String fieldName)

Retrieves value from data record and returns the value as a primitive int.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive int

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getLong

long getLong(String fieldName)

Retrieves value from data record and returns the value as a primitive long.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive long

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getByte

byte getByte(String fieldName)

Retrieves value from data record and returns the value as a primitive byte.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive byte

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getShort

short getShort(String fieldName)

Retrieves value from data record and returns the value as a primitive short.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive short

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getBoolean

boolean getBoolean(String fieldName)

Retrieves value from data record and returns the value as a primitive boolean.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive boolean

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getFloat

float getFloat(String fieldName)

Retrieves value from data record and returns the value as a primitive float.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive float

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getDouble

double getDouble(String fieldName)

Retrieves value from data record and returns the value as a primitive double.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a primitive double

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if null data value read

getString

String getString(String fieldName)

Retrieves value from data record and returns the value as a String object.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a String object. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if field is not nullable and null data value read

getBinary

byte[] getBinary(String fieldName)

Retrieves value from data record and returns the value as binary (byte array).

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as binary (byte array). null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if field is not nullable and null data value read

getBigDecimal

java.math.BigDecimal getBigDecimal(String fieldName)

Retrieves value from data record and returns the value as a java.math.BigDecimal.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as java.math.BigDecimal. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if field is not nullable and null data value read

getTimestamp

java.sql.Timestamp getTimestamp(String fieldName)

Retrieves value from data record and returns the value as a java.sql.Timestamp.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as java.sql.Timestamp. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if field is not nullable and null data value read

getDate

java.sql.Date getDate(String fieldName)

Retrieves value from data record and returns the value as a java.sql.Date.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as java.sql.Date. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - if field is not nullable and null data value read

getRecord

RowRecord getRecord(String fieldName)

Retrieves value from data record and returns the value as a RowRecord object.

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a RowRecord object. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - for this field or any nested field, if that field is not nullable and null data value read

getList

<T> java.util.List<T> getList(String fieldName)

Retrieves value from data record and returns the value as a java.util.List<T> object.

Type Parameters:

T - element type

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a java.util.List<T> object. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - for this field or any element field, if that field is not nullable and null data value read

getMap

<K,V> java.util.Map<K,V> getMap(String fieldName)

Retrieves value from data record and returns the value as a java.util.Map<K, V> object.

Type Parameters:

K - key type

V - value type

Parameters:

fieldName - name of field/column, not null

Returns:

the value for field fieldName as a java.util.Map<K, V> object. null only if null value read and field is nullable.

Throws:

IllegalArgumentException - if fieldName does not exist in this schema

ClassCastException - if data type does not match

NullPointerException - for this field or any key/value field, if that field is not nullable and null data value read