com.cloudant.sync.sqlite

Interface Cursor

All Known Implementing Classes:

AndroidSQLiteCursor, SQLiteCursor

public interface Cursor

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_TYPE_BLOB Value returned by columnType(int) if the specified column type is blob
static int	FIELD_TYPE_FLOAT Value returned by columnType(int) if the specified column type is float
static int	FIELD_TYPE_INTEGER Value returned by columnType(int) if the specified column type is integer
static int	FIELD_TYPE_NULL Value returned by columnType(int) if the specified column is null
static int	FIELD_TYPE_STRING Value returned by columnType(int) if the specified column type is string

Method Summary

Modifier and Type	Method and Description
void	close() Close the cursor and release all resource associated
java.lang.String	columnName(int index) Returns the column name at the given zero-based column index
int	columnType(int index) Returns data type of the given column's value.
byte[]	getBlob(int index) Returns the value of the requested column as a byte array.
int	getColumnCount() Return total number of columns
int	getColumnIndex(java.lang.String columnName) Returns the zero-based index for the given column name, or -1 if the column doesn't exist.
int	getColumnIndexOrThrow(java.lang.String columnName) Returns the zero-based index for the given column name, or throws IllegalArgumentException if the column doesn't exist.
int	getCount()
float	getFloat(int index) Returns the value of the requested column as a float.
int	getInt(int index) Returns the value of the requested column as a long.
long	getLong(int index) Returns the value of the requested column as a long.
java.lang.String	getString(int index) Returns the value of the requested column as a String.
boolean	isAfterLast() Returns whether the cursor is pointing to the position after the last row.
boolean	moveToFirst() Move the cursor to the first row.
boolean	moveToNext() Move the cursor to the next row.

Field Detail

FIELD_TYPE_NULL

static final int FIELD_TYPE_NULL

Value returned by columnType(int) if the specified column is null

See Also:

Constant Field Values

FIELD_TYPE_INTEGER

static final int FIELD_TYPE_INTEGER

Value returned by columnType(int) if the specified column type is integer

See Also:

Constant Field Values

FIELD_TYPE_FLOAT

static final int FIELD_TYPE_FLOAT

Value returned by columnType(int) if the specified column type is float

See Also:

Constant Field Values

FIELD_TYPE_STRING

static final int FIELD_TYPE_STRING

Value returned by columnType(int) if the specified column type is string

See Also:

Constant Field Values

FIELD_TYPE_BLOB

static final int FIELD_TYPE_BLOB

Value returned by columnType(int) if the specified column type is blob

See Also:

Constant Field Values

Method Detail

getCount

int getCount()

getColumnCount

int getColumnCount()

Return total number of columns

columnType

int columnType(int index)

Returns data type of the given column's value.

columnName

java.lang.String columnName(int index)

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

moveToFirst

boolean moveToFirst()

Move the cursor to the first row. This method will return false if the cursor is empty.

Returns:

whether the move succeeded.

getString

java.lang.String getString(int index)

Returns the value of the requested column as a String. Throws an exception when the column value is null or the column type is not a string type is implementation-defined.

getInt

int getInt(int index)

Returns the value of the requested column as a long.

getLong

long getLong(int index)

Returns the value of the requested column as a long.

getFloat

float getFloat(int index)

Returns the value of the requested column as a float.

getBlob

byte[] getBlob(int index)

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

isAfterLast

boolean isAfterLast()

Returns whether the cursor is pointing to the position after the last row.

moveToNext

boolean moveToNext()

Move the cursor to the next row. This method will return false if the cursor is already past the last entry in the result set.

close

void close()

Close the cursor and release all resource associated

getColumnIndex

int getColumnIndex(java.lang.String columnName)

Returns the zero-based index for the given column name, or -1 if the column doesn't exist. If you expect the column to exist use getColumnIndexOrThrow(String) instead, which will make the error more clear.

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.

See Also:

getColumnIndexOrThrow(String)

getColumnIndexOrThrow

int getColumnIndexOrThrow(java.lang.String columnName)
                   throws java.lang.IllegalArgumentException

Returns the zero-based index for the given column name, or throws IllegalArgumentException if the column doesn't exist. If you're not sure if a column will exist or not use getColumnIndex(String) and check for -1, which is more efficient than catching the exceptions.

Parameters:

columnName - the name of the target column.

Returns:

the zero-based column index for the given column name

Throws:

java.lang.IllegalArgumentException - if the column does not exist

See Also:

getColumnIndex(String)