com.bayesserver.data.timeseries

Class WindowDataReader

java.lang.Object

com.bayesserver.data.timeseries.WindowDataReader

All Implemented Interfaces:

DataReader, DataRecord, Closeable, AutoCloseable

public final class WindowDataReader
extends Object
implements DataReader

A data reader that reads windows of data over another data reader.

Constructor Summary

Constructors

Constructor and Description
WindowDataReader(DataReader source, WindowOptions windowOptions, WindowDataReaderOptions readerOptions) Initializes a new instance of the WindowDataReader class.

Method Summary

Modifier and Type	Method and Description
void	close() Close the reader and any associated resources, such as database connections or files.
boolean	getBoolean(int columnIndex) Gets a boolean value for the specified column.
int	getColumnCount() Gets the number of columns (fields) in the data.
int	getColumnIndex(String columnName) Gets the zero based column index for a column name.
String	getColumnName(int columnIndex) Gets the name of the column at the specified index.
Class	getColumnType(int columnIndex) Get the data type for the specified column.
double	getDouble(int columnIndex) Gets a double value for the specified column.
float	getFloat(int columnIndex) Gets a float value for the specified column.
int	getInt(int columnIndex) Gets an integer value for the specified column.
long	getLong(int columnIndex) Gets a long value for the specified column.
Object	getObject(int columnIndex) Gets an Object representation for the value at the specified column.
String	getString(int columnIndex) Gets a string value for the specified column.
boolean	isNull(int columnIndex) Determines whether the value is null (missing) for the specified column.
boolean	read() Moves to the next record, if any exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowDataReader

public WindowDataReader(DataReader source,
                        WindowOptions windowOptions,
                        WindowDataReaderOptions readerOptions)

Initializes a new instance of the WindowDataReader class.

Parameters:

source - The source data to window over.

windowOptions - Options for the windows to create.

readerOptions - Options for the window reader, such as a derived column names.

Method Detail

read

public boolean read()

Moves to the next record, if any exist. This must be called to move to the first record.

Specified by:

read in interface DataReader

Returns:

true if the reader successfully moved to a new record, or false if no more records are present.

getColumnCount

public int getColumnCount()

Gets the number of columns (fields) in the data.

Specified by:

getColumnCount in interface DataRecord

Returns:

The column (field) count.

close

public void close()

Close the reader and any associated resources, such as database connections or files.

Specified by:

close in interface DataReader

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getColumnName

public String getColumnName(int columnIndex)

Gets the name of the column at the specified index.

Specified by:

getColumnName in interface DataRecord

Parameters:

columnIndex - The zero based index of the column.

Returns:

The name of the column at the specified index.

getColumnType

public Class getColumnType(int columnIndex)

Get the data type for the specified column. @param columnIndex the zero based index of the column @return

Specified by:

getColumnType in interface DataRecord

getObject

public Object getObject(int columnIndex)

Gets an Object representation for the value at the specified column.

Specified by:

getObject in interface DataRecord

Returns:

The value at the specified column, or null if the value is missing.

getColumnIndex

public int getColumnIndex(String columnName)

Gets the zero based column index for a column name.

Specified by:

getColumnIndex in interface DataRecord

Parameters:

columnName - The name of the column.

Returns:

A zero based index for the column.

getBoolean

public boolean getBoolean(int columnIndex)

Gets a boolean value for the specified column.

Specified by:

getBoolean in interface DataRecord

Parameters:

columnIndex - The zero based column index.

Returns:

The boolean value at the specified index.

getInt

public int getInt(int columnIndex)

Gets an integer value for the specified column.

Specified by:

getInt in interface DataRecord

Parameters:

columnIndex - The zero based column index.

Returns:

The integer value at the specified index.

getLong

public long getLong(int columnIndex)

Gets a long value for the specified column.

Specified by:

getLong in interface DataRecord

Parameters:

columnIndex - The zero based column index.

Returns:

The long value at the specified index.

getFloat

public float getFloat(int columnIndex)

Gets a float value for the specified column.

Specified by:

getFloat in interface DataRecord

Parameters:

columnIndex - The zero based column index.

Returns:

The float value at the specified index.

getDouble

public double getDouble(int columnIndex)

Gets a double value for the specified column.

Specified by:

getDouble in interface DataRecord

Parameters:

columnIndex - The zero based column index.

Returns:

The double value at the specified index.

getString

public String getString(int columnIndex)

Gets a string value for the specified column.

Specified by:

getString in interface DataRecord

Returns:

The string at the specified column index.

isNull

public boolean isNull(int columnIndex)

Determines whether the value is null (missing) for the specified column.

Specified by:

isNull in interface DataRecord

Returns:

true if the value is null (missing), false otherwise.