tech.bitey.dataframe

Interface Row

All Known Subinterfaces:

Cursor

public interface Row

Represents a logical row in a parent DataFrame, which implements the List<Row> interface. Rows do not store any data, rather they index into a dataframe which stores the data in columns.

Row implements equals and hashCode. Two rows are equals iff they have the same columnCount() and the values are equal in each column.

Author:

biteytech@protonmail.com

Method Summary

Modifier and Type	Method and Description
int	columnCount() Returns the number of columns in the parent DataFrame.
<T> T	get(int columnIndex) Returns the value for this row in the specified Column.
<T> T	get(String columnName) Returns the value for this row in the specified Column.
BigDecimal	getBigDecimal(int columnIndex) Returns the value for this row in the specified DecimalColumn.
BigDecimal	getBigDecimal(String columnName) Returns the value for this row in the specified DecimalColumn.
boolean	getBoolean(int columnIndex) boolean primitive specialization of get(int).
boolean	getBoolean(String columnName) boolean primitive specialization of get(int).
LocalDate	getDate(int columnIndex) Returns the value for this row in the specified DateColumn.
LocalDate	getDate(String columnName) Returns the value for this row in the specified DateColumn.
LocalDateTime	getDateTime(int columnIndex) Returns the value for this row in the specified DateTimeColumn.
LocalDateTime	getDateTime(String columnName) Returns the value for this row in the specified DateTimeColumn.
double	getDouble(int columnIndex) double primitive specialization of get(int).
double	getDouble(String columnName) double primitive specialization of get(int).
float	getFloat(int columnIndex) float primitive specialization of get(int).
float	getFloat(String columnName) float primitive specialization of get(int).
int	getInt(int columnIndex) int primitive specialization of get(int).
int	getInt(String columnName) int primitive specialization of get(int).
long	getLong(int columnIndex) long primitive specialization of get(int).
long	getLong(String columnName) long primitive specialization of get(int).
default double	getOrDefaultDouble(int columnIndex, double defaultValue) Returns the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.
default double	getOrDefaultDouble(String columnName, double defaultValue) Returns the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.
default float	getOrDefaultFloat(int columnIndex, float defaultValue) Returns the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.
default float	getOrDefaultFloat(String columnName, float defaultValue) Returns the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.
default int	getOrDefaultInt(int columnIndex, int defaultValue) Returns the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.
default int	getOrDefaultInt(String columnName, int defaultValue) Returns the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.
default long	getOrDefaultLong(int columnIndex, long defaultValue) Returns the value for this row in the specified LongColumn, or the specified defaultValue if the value is null.
default long	getOrDefaultLong(String columnName, long defaultValue) Returns the value for this row in the specified LongColumn, or the specified defaultValue if the value is null.
default short	getOrDefaultShort(int columnIndex, short defaultValue) Returns the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.
default short	getOrDefaultShort(String columnName, short defaultValue) Returns the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.
short	getShort(int columnIndex) short primitive specialization of get(int).
short	getShort(String columnName) short primitive specialization of get(int).
String	getString(int columnIndex) Returns the value for this row in the specified StringColumn.
String	getString(String columnName) Returns the value for this row in the specified StringColumn.
boolean	isNull(int columnIndex) Returns true if the value is null in the specified Column.
boolean	isNull(String columnName) Returns true if the value is null in the specified Column.
int	rowIndex() Returns the row index in the parent DataFrame, ranging from zero to dataframe size (exclusive).
int	yyyymmdd(int columnIndex) Returns the yyyymmdd date for this row in the specified DateColumn.
int	yyyymmdd(String columnName) Returns the yyyymmdd date for this row in the specified DateColumn.

Method Detail

rowIndex

int rowIndex()

Returns the row index in the parent DataFrame, ranging from zero to dataframe size (exclusive).

Returns:

row index in parent dataframe, ranging from zero to dataframe size (exclusive).

columnCount

int columnCount()

Returns the number of columns in the parent DataFrame.

Returns:

the number of columns in the parent DataFrame.

isNull

boolean isNull(int columnIndex)

Returns true if the value is null in the specified Column.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

true if the value is null in the specified Column.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

isNull

boolean isNull(String columnName)

Returns true if the value is null in the specified Column.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

true if the value is null in the specified Column.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

get

<T> T get(int columnIndex)

Returns the value for this row in the specified Column.

Type Parameters:

T - - the return type. Must be compatible with the column type. No attempt is made to convert between types beyond a cast.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified Column.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column type does not match the return type.

get

<T> T get(String columnName)

Returns the value for this row in the specified Column.

Type Parameters:

T - - the return type. Must be compatible with the column type. No attempt is made to convert between types beyond a cast.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified Column.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column type does not match the return type.

getBoolean

boolean getBoolean(int columnIndex)

boolean primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified BooleanColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a BooleanColumn

getBoolean

boolean getBoolean(String columnName)

boolean primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified BooleanColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a BooleanColumn

getInt

int getInt(int columnIndex)

int primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified IntColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a IntColumn

getInt

int getInt(String columnName)

int primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified IntColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an IntColumn

getOrDefaultInt

default int getOrDefaultInt(int columnIndex,
                            int defaultValue)

Returns the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not an IntColumn

getOrDefaultInt

default int getOrDefaultInt(String columnName,
                            int defaultValue)

Returns the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.

Parameters:

columnName - - name of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified IntColumn, or the specified defaultValue if the value is null.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an IntColumn

getLong

long getLong(int columnIndex)

long primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified LongColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a LongColumn

getLong

long getLong(String columnName)

long primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified LongColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a LongColumn

getOrDefaultLong

default long getOrDefaultLong(int columnIndex,
                              long defaultValue)

Returns the value for this row in the specified LongColumn, or the specified defaultValue if the value is null.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified LongColumn, or the specified defaultValue if the value is null.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not an LongColumn

getOrDefaultLong

default long getOrDefaultLong(String columnName,
                              long defaultValue)

Returns the value for this row in the specified LongColumn, or the specified defaultValue if the value is null.

Parameters:

columnName - - name of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an LongColumn

getShort

short getShort(int columnIndex)

short primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified ShortColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a ShortColumn

getShort

short getShort(String columnName)

short primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified ShortColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a ShortColumn

getOrDefaultShort

default short getOrDefaultShort(int columnIndex,
                                short defaultValue)

Returns the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not an ShortColumn

getOrDefaultShort

default short getOrDefaultShort(String columnName,
                                short defaultValue)

Returns the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.

Parameters:

columnName - - name of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified ShortColumn, or the specified defaultValue if the value is null.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an ShortColumn

getDouble

double getDouble(int columnIndex)

double primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified DoubleColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a DoubleColumn

getDouble

double getDouble(String columnName)

double primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified DoubleColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DoubleColumn

getOrDefaultDouble

default double getOrDefaultDouble(int columnIndex,
                                  double defaultValue)

Returns the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not an DoubleColumn

getOrDefaultDouble

default double getOrDefaultDouble(String columnName,
                                  double defaultValue)

Returns the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.

Parameters:

columnName - - name of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified DoubleColumn, or the specified defaultValue if the value is null.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an DoubleColumn

getFloat

float getFloat(int columnIndex)

float primitive specialization of get(int).

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified FloatColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a FloatColumn

getFloat

float getFloat(String columnName)

float primitive specialization of get(int).

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified FloatColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a FloatColumn

getOrDefaultFloat

default float getOrDefaultFloat(int columnIndex,
                                float defaultValue)

Returns the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not an FloatColumn

getOrDefaultFloat

default float getOrDefaultFloat(String columnName,
                                float defaultValue)

Returns the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.

Parameters:

columnName - - name of the column in the parent DataFrame.

defaultValue - - the value to return instead of null

Returns:

the value for this row in the specified FloatColumn, or the specified defaultValue if the value is null.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not an FloatColumn

yyyymmdd

int yyyymmdd(int columnIndex)

Returns the yyyymmdd date for this row in the specified DateColumn.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the yyyymmdd date for this row in the specified DateColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a DateColumn

yyyymmdd

int yyyymmdd(String columnName)

Returns the yyyymmdd date for this row in the specified DateColumn.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the yyyymmdd date for this row in the specified DateColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DateColumn

getString

String getString(int columnIndex)

Returns the value for this row in the specified StringColumn.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified StringColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a StringColumn

getString

String getString(String columnName)

Returns the value for this row in the specified StringColumn.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified StringColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DateColumn

getBigDecimal

BigDecimal getBigDecimal(int columnIndex)

Returns the value for this row in the specified DecimalColumn.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified DecimalColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a DecimalColumn

getBigDecimal

BigDecimal getBigDecimal(String columnName)

Returns the value for this row in the specified DecimalColumn.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified DecimalColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DecimalColumn

getDate

LocalDate getDate(int columnIndex)

Returns the value for this row in the specified DateColumn.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified DateColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a DateColumn

getDate

LocalDate getDate(String columnName)

Returns the value for this row in the specified DateColumn.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified DateColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DateColumn

getDateTime

LocalDateTime getDateTime(int columnIndex)

Returns the value for this row in the specified DateTimeColumn.

Parameters:

columnIndex - - index of the column in the parent DataFrame.

Returns:

the value for this row in the specified DateTimeColumn.

Throws:

IndexOutOfBoundsException - if columnIndex is negative or is not less than columnCount()

ClassCastException - if the column is not a DateTimeColumn

getDateTime

LocalDateTime getDateTime(String columnName)

Returns the value for this row in the specified DateTimeColumn.

Parameters:

columnName - - name of the column in the parent DataFrame.

Returns:

the value for this row in the specified DateTimeColumn.

Throws:

IllegalArgumentException - if columnName is not a recognized column name in the parent dataframe.

ClassCastException - if the column is not a DateTimeColumn