tech.bitey.dataframe

Interface Cursor

All Superinterfaces:

Row

public interface Cursor
extends Row

Method Summary

Modifier and Type	Method and Description
int	currentIndex() Returns the index of the current row, ranging from zero to dataframe size, exclusive.
boolean	hasNext() Returns true if this dataframe cursor has more rows to traverse in the forward direction.
boolean	hasPrevious() Returns true if this dataframe cursor has more rows to traverse in the backward direction.
void	next() Moves the cursor to the next Row in the dataframe.
void	previous() Returns the previous element in the dataframe and moves the cursor position backwards.

Methods inherited from interface tech.bitey.dataframe.Row

columnCount, get, get, getBoolean, getBoolean, getDate, getDate, getDateTime, getDateTime, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getOrDefaultDouble, getOrDefaultDouble, getOrDefaultFloat, getOrDefaultFloat, getOrDefaultInt, getOrDefaultInt, getOrDefaultLong, getOrDefaultLong, getString, getString, isNull, isNull, yyyymmdd, yyyymmdd

Method Detail

hasNext

boolean hasNext()

Returns true if this dataframe cursor has more rows to traverse in the forward direction. (In other words, returns true if next() would move to a valid row rather than throwing an exception.)

Returns:

true if the cursor has more rows when traversing the dataframe in the forward direction

next

void next()

Moves the cursor to the next Row in the dataframe. This method may be called repeatedly to iterate through the dataframe, or intermixed with calls to previous() to go back and forth. (Note that alternating calls to next and previous will land on the same row repeatedly.)

Throws:

NoSuchElementException - if the dataframe has no next row

hasPrevious

boolean hasPrevious()

Returns true if this dataframe cursor has more rows to traverse in the backward direction. (In other words, returns true if previous() would move to a valid row rather than throwing an exception.)

Returns:

true if the cursor has more rows when traversing the dataframe in the backward direction

previous

void previous()

Returns the previous element in the dataframe and moves the cursor position backwards. This method may be called repeatedly to iterate through the dataframe backwards, or intermixed with calls to next() to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Throws:

NoSuchElementException - if the dataframe has no previous row

currentIndex

int currentIndex()

Returns the index of the current row, ranging from zero to dataframe size, exclusive.

Note: calls to DataFrame.cursor() will throw an IndexOutOfBoundsException for empty dataframes, so there will always be a at least one valid row to iterator over.

Returns:

the index of the current row, ranging from zero to dataframe size, exclusive.