Android
android.database
public class

android.database.CursorWrapper

java.lang.Object
android.database.CursorWrapper Cursor

Wrapper class for Cursor that delegates all calls to the actual cursor object

Summary

Public Constructors

            CursorWrapper(Cursor cursor)

Public Methods

          void  close()
Closes the Cursor, releasing all of its resources and making it completely invalid.
          void  copyStringToBuffer(int columnIndex, CharArrayBuffer buffer)
Retrieves the requested column text and stores it in the buffer provided.
          void  deactivate()
Deactivates the Cursor, making all calls on it fail until requery() is called.
          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.
          int  getColumnIndexOrThrow(String columnName)
Returns the zero-based index for the given column name.
          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.
          int  getCount()
Returns the numbers of rows in the cursor.
          double  getDouble(int columnIndex)
Returns the value of the requested column as a double.
          Bundle  getExtras()
Returns a bundle of extra values.
          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  getWantsAllOnMoveCalls()
onMove() will only be called across processes if this method returns true.
          boolean  isAfterLast()
Returns whether the cursor is pointing to the position after the last row.
          boolean  isBeforeFirst()
Returns whether the cursor is pointing to the position before the first row.
          boolean  isClosed()
return true if the cursor is closed
          boolean  isFirst()
Returns whether the cursor is pointing to the first row.
          boolean  isLast()
Returns whether the cursor is pointing to the last row.
          boolean  isNull(int columnIndex)
Returns true if the value in the indicated column is null.
          boolean  move(int offset)
Move the cursor by a relative amount, forward or backward, from the current position.
          boolean  moveToFirst()
Move the cursor to the first row.
          boolean  moveToLast()
Move the cursor to the last row.
          boolean  moveToNext()
Move the cursor to the next row.
          boolean  moveToPosition(int position)
Move the cursor to an absolute position.
          boolean  moveToPrevious()
Move the cursor to the previous row.
          void  registerContentObserver(ContentObserver observer)
Register an observer that is called when changes happen to the content backing this cursor.
          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().
          boolean  requery()
Performs the query that created the cursor again, refreshing its contents.
          Bundle  respond(Bundle extras)
This is an out-of-band way for the the user of a cursor to communicate with the cursor.
          void  setNotificationUri(ContentResolver cr, Uri uri)
Register to watch a content URI for changes.
          void  unregisterContentObserver(ContentObserver observer)
Unregister an observer that has previously been registered with this cursor via registerContentObserver(ContentObserver).
          void  unregisterDataSetObserver(DataSetObserver observer)
Unregister an observer that has previously been registered with this cursor via registerContentObserver(ContentObserver).
Methods inherited from class java.lang.Object
Methods inherited from interface android.database.Cursor

Details

Public Constructors

public CursorWrapper(Cursor cursor)

Public Methods

public 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.

public 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

public void deactivate()

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.

public byte[] getBlob(int columnIndex)

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

If the native content of that column is not blob exception may throw

public int getColumnCount()

Return total number of columns

public int getColumnIndex(String columnName)

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

public int getColumnIndexOrThrow(String columnName)

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

public String getColumnName(int columnIndex)

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

public 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.

public int getCount()

Returns the numbers of rows in the cursor.

public double getDouble(int columnIndex)

Returns the value of the requested column as a double.

If the native content of that column is not numeric the result will be the result of passing the column value to Double.valueOf(x).

public 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.

public float getFloat(int columnIndex)

Returns the value of the requested column as a float.

If the native content of that column is not numeric the result will be the result of passing the column value to Float.valueOf(x).

public int getInt(int columnIndex)

Returns the value of the requested column as an int.

If the native content of that column is not numeric the result will be the result of passing the column value to Integer.valueOf(x).

public long getLong(int columnIndex)

Returns the value of the requested column as a long.

If the native content of that column is not numeric the result will be the result of passing the column value to Long.valueOf(x).

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

public short getShort(int columnIndex)

Returns the value of the requested column as a short.

If the native content of that column is not numeric the result will be the result of passing the column value to Short.valueOf(x).

public String getString(int columnIndex)

Returns the value of the requested column as a String.

If the native content of that column is not text the result will be the result of passing the column value to String.valueOf(x).

public boolean getWantsAllOnMoveCalls()

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

public boolean isAfterLast()

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

public boolean isBeforeFirst()

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

public boolean isClosed()

return true if the cursor is closed

public boolean isFirst()

Returns whether the cursor is pointing to the first row.

public boolean isLast()

Returns whether the cursor is pointing to the last row.

public boolean isNull(int columnIndex)

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

public 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.

public boolean moveToFirst()

Move the cursor to the first row.

This method will return false if the cursor is empty.

public boolean moveToLast()

Move the cursor to the last row.

This method will return false if the cursor is empty.

public 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.

public 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.

public 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.

public 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.

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

public boolean requery()

Performs the query that created the cursor again, refreshing its contents. This may be done at any time, including after a call to deactivate().

public 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.

public 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.

public void unregisterContentObserver(ContentObserver observer)

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

public void unregisterDataSetObserver(DataSetObserver observer)

Unregister an observer that has previously been registered with this cursor via registerContentObserver(ContentObserver).
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48