public abstract class

AbstractWindowedCursor

extends AbstractCursor

java.lang.Object
↳	android.database.AbstractCursor
	↳	android.database.AbstractWindowedCursor

Known Direct Subclasses

SQLiteCursor

Class Overview

A base class for Cursors that store their data in CursorWindows.

Summary

Fields
protected CursorWindow	mWindow	This needs be updated in `onMove(int, int)` by subclasses, and needs to be set to NULL when the contents of the cursor change.

[Expand]

Inherited Fields

From class android.database.AbstractCursor

Public Constructors
	AbstractWindowedCursor()

Public Methods
void	copyStringToBuffer(int columnIndex, CharArrayBuffer 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.
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.
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.
CursorWindow	getWindow() returns a pre-filled window, return NULL if no such window
boolean	hasWindow()
boolean	isBlob(int columnIndex)
boolean	isFloat(int columnIndex)
boolean	isLong(int columnIndex)
boolean	isNull(int columnIndex) Returns `true` if the value in the indicated column is null.
boolean	isString(int columnIndex)
void	setWindow(CursorWindow window) Set a new cursor window to cursor, usually set a remote cursor window

Protected Methods
void	checkPosition() This function throws CursorIndexOutOfBoundsException if the cursor position is out of bounds.

[Expand]

Inherited Methods

From class android.database.AbstractCursor

void	checkPosition() This function throws CursorIndexOutOfBoundsException if the cursor position is out of bounds.
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.
void	fillWindow(int position, CursorWindow window) Copy data from cursor to CursorWindow
void	finalize() Is called before the object's memory is being reclaimed by the VM.
byte[]	getBlob(int column) 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.
int	getColumnIndexOrThrow(String columnName) Returns the zero-based index for the given column name, or throws `IllegalArgumentException` if the column doesn't exist.
String	getColumnName(int columnIndex) Returns the column name at the given zero-based column index.
abstract 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.
abstract int	getCount() Returns the numbers of rows in the cursor.
abstract double	getDouble(int column) Returns the value of the requested column as a double.
Bundle	getExtras() Returns a bundle of extra values.
abstract float	getFloat(int column) Returns the value of the requested column as a float.
abstract int	getInt(int column) Returns the value of the requested column as an int.
abstract long	getLong(int column) Returns the value of the requested column as a long.
final int	getPosition() Returns the current position of the cursor in the row set.
abstract short	getShort(int column) Returns the value of the requested column as a short.
abstract String	getString(int column) Returns the value of the requested column as a String.
Object	getUpdatedField(int columnIndex) This function returns the uncommitted updated value for the field at columnIndex.
boolean	getWantsAllOnMoveCalls() onMove() will only be called across processes if this method returns true.
CursorWindow	getWindow() returns a pre-filled window, return NULL if no such window
final boolean	isAfterLast() Returns whether the cursor is pointing to the position after the last row.
final 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	isFieldUpdated(int columnIndex) This function returns true if the field has been updated and is used in conjunction with `getUpdatedField(int)` to allow subclasses to support reading uncommitted updates.
final boolean	isFirst() Returns whether the cursor is pointing to the first row.
final boolean	isLast() Returns whether the cursor is pointing to the last row.
abstract boolean	isNull(int column) Returns `true` if the value in the indicated column is null.
final boolean	move(int offset) Move the cursor by a relative amount, forward or backward, from the current position.
final boolean	moveToFirst() Move the cursor to the first row.
final boolean	moveToLast() Move the cursor to the last row.
final boolean	moveToNext() Move the cursor to the next row.
final boolean	moveToPosition(int position) Move the cursor to an absolute position.
final boolean	moveToPrevious() Move the cursor to the previous row.
void	onChange(boolean selfChange) Subclasses must call this method when they finish committing updates to notify all observers.
boolean	onMove(int oldPosition, int newPosition) This function is called every time the cursor is successfully scrolled to a new position, giving the subclass a chance to update any state it may have.
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 notifyUri) Specifies a content URI to watch 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)`.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface android.database.CrossProcessCursor

From interface android.database.Cursor

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

Fields

protected CursorWindow mWindow

Since: API Level 1

This needs be updated in onMove(int, int) by subclasses, and needs to be set to NULL when the contents of the cursor change.

Public Constructors

public AbstractWindowedCursor ()

Since: API Level 1

Public Methods

public void copyStringToBuffer (int columnIndex, CharArrayBuffer buffer)

Since: API Level 1

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.

public byte[] getBlob (int columnIndex)

Since: API Level 1

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

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a byte array.

public double getDouble (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a double.

public float getFloat (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a float.

public int getInt (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as an int.

public long getLong (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a long.

public short getShort (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a short.

public String getString (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

the value of that column as a String.

public CursorWindow getWindow ()

Since: API Level 1

returns a pre-filled window, return NULL if no such window

public boolean hasWindow ()

Since: API Level 1

public boolean isBlob (int columnIndex)

Since: API Level 1

public boolean isFloat (int columnIndex)

Since: API Level 5

public boolean isLong (int columnIndex)

Since: API Level 5

public boolean isNull (int columnIndex)

Since: API Level 1

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

Parameters

columnIndex	the zero-based index of the target column.

Returns

whether the column value is null.

public boolean isString (int columnIndex)

Since: API Level 5

public void setWindow (CursorWindow window)

Since: API Level 1

Set a new cursor window to cursor, usually set a remote cursor window

Parameters

window	cursor window

Protected Methods

protected void checkPosition ()

Since: API Level 1

This function throws CursorIndexOutOfBoundsException if the cursor position is out of bounds. Subclass implementations of the get functions should call this before attempting to retrieve data.

Interfaces

Classes

Enums

Exceptions

AbstractWindowedCursor

Class Overview

Summary

Fields

protected CursorWindow mWindow

Public Constructors

public AbstractWindowedCursor ()

Public Methods

public void copyStringToBuffer (int columnIndex, CharArrayBuffer buffer)

Parameters

public byte[] getBlob (int columnIndex)

Parameters

Returns

public double getDouble (int columnIndex)

Parameters

Returns

public float getFloat (int columnIndex)

Parameters

Returns

public int getInt (int columnIndex)

Parameters

Returns

public long getLong (int columnIndex)

Parameters

Returns

public short getShort (int columnIndex)

Parameters

Returns

public String getString (int columnIndex)

Parameters

Returns

public CursorWindow getWindow ()

public boolean hasWindow ()

public boolean isBlob (int columnIndex)

public boolean isFloat (int columnIndex)

public boolean isLong (int columnIndex)

public boolean isNull (int columnIndex)

Parameters

Returns

public boolean isString (int columnIndex)

public void setWindow (CursorWindow window)

Parameters

Protected Methods

protected void checkPosition ()