au.com.cybersearch2.classyjpa.query

Interface ResultRow

All Known Implementing Classes:

AndroidResultRow, SqliteResultRow

public interface ResultRow

ResultRow Subset of Cursor interface to use for row mapping

Author:

Andrew Bowley 30/05/2014

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResultRow.FunctionSpec FunctionSpec Indicates type of operation and related parameters
static class	ResultRow.op op Enumeration of operation to perform on query result row

Method Summary

Methods

Modifier and Type	Method and Description
void	copyStringToBuffer(int columnIndex, StringBuffer buffer) Retrieves the requested column text and stores it in the buffer provided.
byte[]	getBlob(int columnIndex) Returns the value of the requested column as a byte array.
int	getColumnCount() Return total number of columns
int	getColumnIndex(String columnName) Returns the zero-based index for the given column name, or -1 if the column doesn't exist.
String	getColumnName(int columnIndex) Returns the column name at the given zero-based column index.
String[]	getColumnNames() Returns a string array holding the names of all of the columns in the result set in the order in which they were listed in the result.
double	getDouble(int columnIndex) Returns the value of the requested column as a double.
float	getFloat(int columnIndex) Returns the value of the requested column as a float.
int	getInt(int columnIndex) Returns the value of the requested column as an int.
long	getLong(int columnIndex) Returns the value of the requested column as a long.
int	getPosition() Returns the current position of the cursor in the row set.
short	getShort(int columnIndex) Returns the value of the requested column as a short.
String	getString(int columnIndex) Returns the value of the requested column as a String.
boolean	isNull(int columnIndex) (Android SQLite only) Returns true if the value in the indicated column is null.

Method Detail

getPosition

int getPosition()

Returns the current position of the cursor in the row set. The value is zero-based. When the row set is first returned the cursor will be at positon -1, which is before the first row. After the last row is returned another call to next() will leave the cursor past the last entry, at a position of count().

Returns:

The current cursor position.

getColumnIndex

int getColumnIndex(String columnName)

Returns the zero-based index for the given column name, or -1 if the column doesn't exist.

Parameters:

columnName - the name of the target column.

Returns:

The zero-based column index for the given column name, or -1 if the column name does not exist.

getColumnName

String getColumnName(int columnIndex)

Returns the column name at the given zero-based column index.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The column name for the given column index.

getColumnNames

String[] getColumnNames()

Returns a string array holding the names of all of the columns in the result set in the order in which they were listed in the result.

Returns:

The names of the columns returned in this query.

getColumnCount

int getColumnCount()

Return total number of columns

Returns:

number of columns

getBlob

byte[] getBlob(int columnIndex)

Returns the value of the requested column as a byte array.

The result and whether this method throws an exception when the column value is null or the column type is not a blob type is implementation-defined.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a byte array.

getString

String getString(int columnIndex)

Returns the value of the requested column as a String.

The result and whether this method throws an exception when the column value is null or the column type is not a string type is implementation-defined.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a String.

copyStringToBuffer

void copyStringToBuffer(int columnIndex,
                      StringBuffer buffer)

Retrieves the requested column text and stores it in the buffer provided. If the buffer size is not sufficient, a new char buffer will be allocated and assigned to CharArrayBuffer.data

Parameters:

columnIndex - the zero-based index of the target column. if the target column is null, return buffer

buffer - the buffer to copy the text into.

getShort

short getShort(int columnIndex)

Returns the value of the requested column as a short.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a short.

getInt

int getInt(int columnIndex)

Returns the value of the requested column as an int.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as an int.

getLong

long getLong(int columnIndex)

Returns the value of the requested column as a long.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a long.

getFloat

float getFloat(int columnIndex)

Returns the value of the requested column as a float.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a float.

getDouble

double getDouble(int columnIndex)

Returns the value of the requested column as a double.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

The value of that column as a double.

isNull

boolean isNull(int columnIndex)

(Android SQLite only) Returns true if the value in the indicated column is null. Returns true if the last object returned with the column index is null.

Parameters:

columnIndex - the zero-based index of the target column.

Returns:

Whether the column value is null.