Cursor

FIELD_TYPE_BLOB

int FIELD_TYPE_BLOB

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

Constant Value: 4 (0x00000004)

FIELD_TYPE_FLOAT

int FIELD_TYPE_FLOAT

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

Constant Value: 2 (0x00000002)

FIELD_TYPE_INTEGER

int FIELD_TYPE_INTEGER

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

Constant Value: 1 (0x00000001)

FIELD_TYPE_NULL

int FIELD_TYPE_NULL

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

Constant Value: 0 (0x00000000)

FIELD_TYPE_STRING

int FIELD_TYPE_STRING

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

Constant Value: 3 (0x00000003)

close

void close ()

Closes the Cursor, releasing all of its resources and making it completely invalid. Unlike deactivate() a call to requery() will not make the Cursor valid again.

copyStringToBuffer

void copyStringToBuffer (int columnIndex, 
                CharArrayBuffer 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

deactivate

void deactivate ()

This method was deprecated in API level 16.
Since requery() is deprecated, so too is this.

Deactivates the Cursor, making all calls on it fail until requery() is called. Inactive Cursors use fewer resources than active Cursors. Calling requery() will make the cursor active again.

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.

getColumnCount

int getColumnCount ()

Return total number of columns

getColumnIndex

int getColumnIndex (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.

getColumnIndexOrThrow

int getColumnIndexOrThrow (String columnName)

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.

getColumnName

String getColumnName (int columnIndex)

Returns the column name at the given zero-based 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.

getCount

int getCount ()

Returns the numbers of rows in the cursor.

getDouble

double getDouble (int columnIndex)

Returns the value of the requested column as a double.

The result and whether this method throws an exception when the column value is null, the column type is not a floating-point type, or the floating-point value is not representable as a double value is implementation-defined.

getExtras

Bundle getExtras ()

Returns a bundle of extra values. This is an optional way for cursors to provide out-of-band metadata to their users. One use of this is for reporting on the progress of network requests that are required to fetch data for the cursor.

These values may only change when requery is called.

getFloat

float getFloat (int columnIndex)

Returns the value of the requested column as a float.

The result and whether this method throws an exception when the column value is null, the column type is not a floating-point type, or the floating-point value is not representable as a float value is implementation-defined.

getInt

int getInt (int columnIndex)

Returns the value of the requested column as an int.

The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Integer.MIN_VALUE, Integer.MAX_VALUE] is implementation-defined.

getLong

long getLong (int columnIndex)

Returns the value of the requested column as a long.

The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Long.MIN_VALUE, Long.MAX_VALUE] is implementation-defined.

getNotificationUri

Uri getNotificationUri ()

Return the URI at which notifications of changes in this Cursor's data will be delivered, as previously set by setNotificationUri(ContentResolver, Uri).

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().

getShort

short getShort (int columnIndex)

Returns the value of the requested column as a short.

The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Short.MIN_VALUE, Short.MAX_VALUE] is implementation-defined.

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.

getType

int getType (int columnIndex)

Returns data type of the given column's value. The preferred type of the column is returned but the data may be converted to other types as documented in the get-type methods such as getInt(int), getFloat(int) etc.

Returned column types are

• FIELD_TYPE_NULL
• FIELD_TYPE_INTEGER
• FIELD_TYPE_FLOAT
• FIELD_TYPE_STRING
• FIELD_TYPE_BLOB

getWantsAllOnMoveCalls

boolean getWantsAllOnMoveCalls ()

onMove() will only be called across processes if this method returns true.

isAfterLast

boolean isAfterLast ()

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

isBeforeFirst

boolean isBeforeFirst ()

Returns whether the cursor is pointing to the position before the first row.

isClosed

boolean isClosed ()

return true if the cursor is closed

isFirst

boolean isFirst ()

Returns whether the cursor is pointing to the first row.

isLast

boolean isLast ()

Returns whether the cursor is pointing to the last row.

isNull

boolean isNull (int columnIndex)

Returns true if the value in the indicated column is null.

move

boolean move (int offset)

Move the cursor by a relative amount, forward or backward, from the current position. Positive offsets move forwards, negative offsets move backwards. If the final position is outside of the bounds of the result set then the resultant position will be pinned to -1 or count() depending on whether the value is off the front or end of the set, respectively.

This method will return true if the requested destination was reachable, otherwise, it returns false. For example, if the cursor is at currently on the second entry in the result set and move(-5) is called, the position will be pinned at -1, and false will be returned.

moveToFirst

boolean moveToFirst ()

Move the cursor to the first row.

This method will return false if the cursor is empty.

moveToLast

boolean moveToLast ()

Move the cursor to the last row.

This method will return false if the cursor is empty.

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.

moveToPosition

boolean moveToPosition (int position)

Move the cursor to an absolute position. The valid range of values is -1 <= position <= count.

This method will return true if the request destination was reachable, otherwise, it returns false.

moveToPrevious

boolean moveToPrevious ()

Move the cursor to the previous row.

This method will return false if the cursor is already before the first entry in the result set.

registerContentObserver

void registerContentObserver (ContentObserver observer)

Register an observer that is called when changes happen to the content backing this cursor. Typically the data set won't change until requery() is called.

registerDataSetObserver

void registerDataSetObserver (DataSetObserver observer)

Register an observer that is called when changes happen to the contents of the this cursors data set, for example, when the data set is changed via requery(), deactivate(), or close().

requery

boolean requery ()

This method was deprecated in API level 11.
Don't use this. Just request a new cursor, so you can do this asynchronously and update your list view once the new cursor comes back.

Performs the query that created the cursor again, refreshing its contents. This may be done at any time, including after a call to deactivate(). Since this method could execute a query on the database and potentially take a while, it could cause ANR if it is called on Main (UI) thread. A warning is printed if this method is being executed on Main thread.

respond

Bundle respond (Bundle extras)

This is an out-of-band way for the the user of a cursor to communicate with the cursor. The structure of each bundle is entirely defined by the cursor.

One use of this is to tell a cursor that it should retry its network request after it reported an error.

setExtras

void setExtras (Bundle extras)

Sets a Bundle that will be returned by getExtras().

setNotificationUri

void setNotificationUri (ContentResolver cr, 
                Uri uri)

Register to watch a content URI for changes. This can be the URI of a specific data row (for example, "content://my_provider_type/23"), or a a generic URI for a content type.

unregisterContentObserver

void unregisterContentObserver (ContentObserver observer)

Unregister an observer that has previously been registered with this cursor via registerContentObserver(ContentObserver).

unregisterDataSetObserver

void unregisterDataSetObserver (DataSetObserver observer)

Unregister an observer that has previously been registered with this cursor via registerContentObserver(ContentObserver).