Tuple

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractTuple
```
public interface Tuple
extends java.io.Serializable
```
A tuple is an immutable finite ordered list (sequence) of elements. Allows both generic access by ordinal, which will incur boxing overhead for primitives, as well as native primitive access.
It is invalid to use the native primitive interface to retrieve a value that is null, instead a user must check `isNullAt` before attempting to retrieve a value that might be null.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`anyNull()` Returns true if there are any NULL values in this tuple.
`default java.lang.Object`	`apply(int i)` Returns the value at position i.
`default java.lang.Object`	`apply(java.lang.String field)` Returns the value by field name.
`default int`	`fieldIndex(java.lang.String name)` Returns the index of a given field name.
`java.lang.Object`	`get(int i)` Returns the value at position i.
`default java.lang.Object`	`get(java.lang.String field)` Returns the value by field name.
`default <T> T[]`	`getArray(int i)` Returns the value at position i of array type.
`default <T> T[]`	`getArray(java.lang.String field)` Returns the field value of array type.
`default <T> T`	`getAs(int i)` Returns the value at position i.
`default <T> T`	`getAs(java.lang.String fieldName)` Returns the value of a given fieldName.
`default boolean`	`getBoolean(int i)` Returns the value at position i as a primitive boolean.
`default boolean`	`getBoolean(java.lang.String field)` Returns the field value as a primitive boolean.
`default byte`	`getByte(int i)` Returns the value at position i as a primitive byte.
`default byte`	`getByte(java.lang.String field)` Returns the field value as a primitive byte.
`default char`	`getChar(int i)` Returns the value at position i as a primitive byte.
`default char`	`getChar(java.lang.String field)` Returns the field value as a primitive byte.
`default java.time.LocalDate`	`getDate(int i)` Returns the value at position i of date type as java.time.LocalDate.
`default java.time.LocalDate`	`getDate(java.lang.String field)` Returns the field value of date type as java.time.LocalDate.
`default java.time.LocalDateTime`	`getDateTime(int i)` Returns the value at position i of date type as java.time.LocalDateTime.
`default java.time.LocalDateTime`	`getDateTime(java.lang.String field)` Returns the field value of date type as java.time.LocalDateTime.
`default java.math.BigDecimal`	`getDecimal(int i)` Returns the value at position i of decimal type as java.math.BigDecimal.
`default java.math.BigDecimal`	`getDecimal(java.lang.String field)` Returns the field value of decimal type as java.math.BigDecimal.
`default double`	`getDouble(int i)` Returns the value at position i as a primitive double.
`default double`	`getDouble(java.lang.String field)` Returns the field value as a primitive double.
`default float`	`getFloat(int i)` Returns the value at position i as a primitive float.
`default float`	`getFloat(java.lang.String field)` Returns the field value as a primitive float.
`default int`	`getInt(int i)` Returns the value at position i as a primitive int.
`default int`	`getInt(java.lang.String field)` Returns the field value as a primitive int.
`default long`	`getLong(int i)` Returns the value at position i as a primitive long.
`default long`	`getLong(java.lang.String field)` Returns the field value as a primitive long.
`default java.lang.String`	`getScale(int i)` Returns the value at position i of NominalScale or OrdinalScale.
`default java.lang.String`	`getScale(java.lang.String field)` Returns the field value of NominalScale or OrdinalScale.
`default short`	`getShort(int i)` Returns the value at position i as a primitive short.
`default short`	`getShort(java.lang.String field)` Returns the field value as a primitive short.
`default java.lang.String`	`getString(int i)` Returns the value at position i as a String object.
`default java.lang.String`	`getString(java.lang.String field)` Returns the field value as a String object.
`default Tuple`	`getStruct(int i)` Returns the value at position i of struct type.
`default Tuple`	`getStruct(java.lang.String field)` Returns the field value of struct type.
`default java.time.LocalTime`	`getTime(int i)` Returns the value at position i of date type as java.time.LocalTime.
`default java.time.LocalTime`	`getTime(java.lang.String field)` Returns the field value of date type as java.time.LocalTime.
`default boolean`	`hasNull()` Returns true if the tuple has null/missing values.
`default boolean`	`isNullAt(int i)` Checks whether the value at position i is null.
`default boolean`	`isNullAt(java.lang.String field)` Checks whether the field value is null.
`default int`	`length()` Number of elements in the Tuple.
`static Tuple`	`of(double[] row, StructType schema)` Returns a double array based tuple.
`static Tuple`	`of(java.lang.Object[] row, StructType schema)` Returns an object array based tuple.
`static Tuple`	`of(java.sql.ResultSet rs, StructType schema)` Returns the current row of a JDBC ResultSet as a tuple.
`StructType`	`schema()` Returns the schema of tuple.
`default double[]`	`toArray()` Returns the tuple as an array of doubles.
`default double[]`	`toArray(boolean bias, CategoricalEncoder encoder)` Return an array obtained by converting all the variables in a data frame to numeric mode.
`default java.lang.String`	`toString(int i)` Returns the string representation of the value at position i.
`default java.lang.String`	`toString(java.lang.String field)` Returns the string representation of the field value.

- Method Detail
  - schema
```
StructType schema()
```
    Returns the schema of tuple.
  - length
```
default int length()
```
    Number of elements in the Tuple.
  - toArray
```
default double[] toArray()
```
    Returns the tuple as an array of doubles.
  - toArray
```
default double[] toArray(boolean bias,
                         CategoricalEncoder encoder)
```
    Return an array obtained by converting all the variables in a data frame to numeric mode. Missing values/nulls will be encoded as Double.NaN.
    
    Parameters:
    
    bias - if true, add the first column of all 1's.
    
    encoder - the categorical variable encoder.
  - apply
```
default java.lang.Object apply(int i)
```
    Returns the value at position i. The value may be null.
  - apply
```
default java.lang.Object apply(java.lang.String field)
```
    Returns the value by field name. The value may be null.
  - get
```
java.lang.Object get(int i)
```
    Returns the value at position i. The value may be null.
  - get
```
default java.lang.Object get(java.lang.String field)
```
    Returns the value by field name. The value may be null.
  - isNullAt
```
default boolean isNullAt(int i)
```
    Checks whether the value at position i is null.
  - isNullAt
```
default boolean isNullAt(java.lang.String field)
```
    Checks whether the field value is null.
  - hasNull
```
default boolean hasNull()
```
    Returns true if the tuple has null/missing values.
  - getBoolean
```
default boolean getBoolean(int i)
```
    Returns the value at position i as a primitive boolean.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getBoolean
```
default boolean getBoolean(java.lang.String field)
```
    Returns the field value as a primitive boolean.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getChar
```
default char getChar(int i)
```
    Returns the value at position i as a primitive byte.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getChar
```
default char getChar(java.lang.String field)
```
    Returns the field value as a primitive byte.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getByte
```
default byte getByte(int i)
```
    Returns the value at position i as a primitive byte.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getByte
```
default byte getByte(java.lang.String field)
```
    Returns the field value as a primitive byte.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getShort
```
default short getShort(int i)
```
    Returns the value at position i as a primitive short.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getShort
```
default short getShort(java.lang.String field)
```
    Returns the field value as a primitive short.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getInt
```
default int getInt(int i)
```
    Returns the value at position i as a primitive int.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getInt
```
default int getInt(java.lang.String field)
```
    Returns the field value as a primitive int.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getLong
```
default long getLong(int i)
```
    Returns the value at position i as a primitive long.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getLong
```
default long getLong(java.lang.String field)
```
    Returns the field value as a primitive long.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getFloat
```
default float getFloat(int i)
```
    Returns the value at position i as a primitive float. Throws an exception if the type mismatches or if the value is null.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getFloat
```
default float getFloat(java.lang.String field)
```
    Returns the field value as a primitive float. Throws an exception if the type mismatches or if the value is null.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getDouble
```
default double getDouble(int i)
```
    Returns the value at position i as a primitive double.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getDouble
```
default double getDouble(java.lang.String field)
```
    Returns the field value as a primitive double.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
    
    java.lang.NullPointerException - when value is null.
  - getString
```
default java.lang.String getString(int i)
```
    Returns the value at position i as a String object.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getString
```
default java.lang.String getString(java.lang.String field)
```
    Returns the field value as a String object.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - toString
```
default java.lang.String toString(int i)
```
    Returns the string representation of the value at position i.
  - toString
```
default java.lang.String toString(java.lang.String field)
```
    Returns the string representation of the field value.
  - getDecimal
```
default java.math.BigDecimal getDecimal(int i)
```
    Returns the value at position i of decimal type as java.math.BigDecimal.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getDecimal
```
default java.math.BigDecimal getDecimal(java.lang.String field)
```
    Returns the field value of decimal type as java.math.BigDecimal.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getDate
```
default java.time.LocalDate getDate(int i)
```
    Returns the value at position i of date type as java.time.LocalDate.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getDate
```
default java.time.LocalDate getDate(java.lang.String field)
```
    Returns the field value of date type as java.time.LocalDate.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getTime
```
default java.time.LocalTime getTime(int i)
```
    Returns the value at position i of date type as java.time.LocalTime.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getTime
```
default java.time.LocalTime getTime(java.lang.String field)
```
    Returns the field value of date type as java.time.LocalTime.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getDateTime
```
default java.time.LocalDateTime getDateTime(int i)
```
    Returns the value at position i of date type as java.time.LocalDateTime.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getDateTime
```
default java.time.LocalDateTime getDateTime(java.lang.String field)
```
    Returns the field value of date type as java.time.LocalDateTime.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getScale
```
default java.lang.String getScale(int i)
```
    Returns the value at position i of NominalScale or OrdinalScale.
  - getScale
```
default java.lang.String getScale(java.lang.String field)
```
    Returns the field value of NominalScale or OrdinalScale.
    
    Throws:
    
    java.lang.ClassCastException - when the data is not nominal or ordinal.
  - getArray
```
default <T> T[] getArray(int i)
```
    Returns the value at position i of array type.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getArray
```
default <T> T[] getArray(java.lang.String field)
```
    Returns the field value of array type.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getStruct
```
default Tuple getStruct(int i)
```
    Returns the value at position i of struct type.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getStruct
```
default Tuple getStruct(java.lang.String field)
```
    Returns the field value of struct type.
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getAs
```
default <T> T getAs(int i)
```
    Returns the value at position i. For primitive types if value is null it returns 'zero value' specific for primitive ie. 0 for Int - use isNullAt to ensure that value is not null
    
    Throws:
    
    java.lang.ClassCastException - when data type does not match.
  - getAs
```
default <T> T getAs(java.lang.String fieldName)
```
    Returns the value of a given fieldName. For primitive types if value is null it returns 'zero value' specific for primitive ie. 0 for Int - use isNullAt to ensure that value is not null
    
    Throws:
    
    java.lang.UnsupportedOperationException - when schema is not defined.
    
    java.lang.IllegalArgumentException - when fieldName do not exist.
    
    java.lang.ClassCastException - when data type does not match.
  - fieldIndex
```
default int fieldIndex(java.lang.String name)
```
    Returns the index of a given field name.
    
    Throws:
    
    java.lang.IllegalArgumentException - when a field `name` does not exist.
  - anyNull
```
default boolean anyNull()
```
    Returns true if there are any NULL values in this tuple.
  - of
```
static Tuple of(java.lang.Object[] row,
                StructType schema)
```
    Returns an object array based tuple.
  - of
```
static Tuple of(double[] row,
                StructType schema)
```
    Returns a double array based tuple.
  - of
```
static Tuple of(java.sql.ResultSet rs,
                StructType schema)
         throws java.sql.SQLException
```
    Returns the current row of a JDBC ResultSet as a tuple.
    
    Throws:
    
    java.sql.SQLException

Interface Tuple

Method Summary

Method Detail

schema

length

toArray

toArray

apply

apply

get

get

isNullAt

isNullAt

hasNull

getBoolean

getBoolean

getChar

getChar

getByte

getByte

getShort

getShort

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getString

getString

toString

toString

getDecimal

getDecimal

getDate

getDate

getTime

getTime

getDateTime

getDateTime

getScale

getScale

getArray

getArray

getStruct

getStruct

getAs

getAs

fieldIndex

anyNull

of

of

of