com.cloudant.sync.sqlite.android

Class AndroidSQLiteCursor

java.lang.Object

com.cloudant.sync.sqlite.android.AndroidSQLiteCursor

All Implemented Interfaces:

Cursor

public class AndroidSQLiteCursor
extends java.lang.Object
implements 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 inherited from interface com.cloudant.sync.sqlite.Cursor

FIELD_TYPE_BLOB, FIELD_TYPE_FLOAT, FIELD_TYPE_INTEGER, FIELD_TYPE_NULL, FIELD_TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
AndroidSQLiteCursor(android.database.Cursor cursor)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidSQLiteCursor

public AndroidSQLiteCursor(android.database.Cursor cursor)

Method Detail

getCount

public int getCount()

Specified by:

getCount in interface Cursor

columnType

public int columnType(int index)

Description copied from interface: Cursor

Returns data type of the given column's value.

Specified by:

columnType in interface Cursor

columnName

public java.lang.String columnName(int index)

Description copied from interface: Cursor

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

Specified by:

columnName in interface Cursor

moveToFirst

public boolean moveToFirst()

Description copied from interface: Cursor

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

Specified by:

moveToFirst in interface Cursor

Returns:

whether the move succeeded.

getString

public java.lang.String getString(int index)

Description copied from interface: Cursor

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.

Specified by:

getString in interface Cursor

getInt

public int getInt(int index)

Description copied from interface: Cursor

Returns the value of the requested column as a long.

Specified by:

getInt in interface Cursor

getLong

public long getLong(int index)

Description copied from interface: Cursor

Returns the value of the requested column as a long.

Specified by:

getLong in interface Cursor

getFloat

public float getFloat(int index)

Description copied from interface: Cursor

Returns the value of the requested column as a float.

Specified by:

getFloat in interface Cursor

getBlob

public byte[] getBlob(int index)

Description copied from interface: Cursor

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

Specified by:

getBlob in interface Cursor

isAfterLast

public boolean isAfterLast()

Description copied from interface: Cursor

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

Specified by:

isAfterLast in interface Cursor

moveToNext

public boolean moveToNext()

Description copied from interface: Cursor

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.

Specified by:

moveToNext in interface Cursor

close

public void close()

Description copied from interface: Cursor

Close the cursor and release all resource associated

Specified by:

close in interface Cursor

getColumnCount

public int getColumnCount()

Description copied from interface: Cursor

Return total number of columns

Specified by:

getColumnCount in interface Cursor

getColumnIndex

public int getColumnIndex(java.lang.String columnName)

Description copied from interface: Cursor

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 Cursor.getColumnIndexOrThrow(String) instead, which will make the error more clear.

Specified by:

getColumnIndex in interface Cursor

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:

Cursor.getColumnIndexOrThrow(String)

getColumnIndexOrThrow

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

Description copied from interface: Cursor

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 Cursor.getColumnIndex(String) and check for -1, which is more efficient than catching the exceptions.

Specified by:

getColumnIndexOrThrow in interface Cursor

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:

Cursor.getColumnIndex(String)