Android - An Open Handset Alliance Project

android.database.sqlite
public class

android.database.sqlite.SQLiteCursor

java.lang.Object
	android.database.AbstractCursor			Cursor
		android.database.AbstractWindowedCursor
			android.database.sqlite.SQLiteCursor

A Cursor implementation that exposes results from a query on a SQLiteDatabase.

Known Direct Subclasses

DatabaseContentProvider.DcpCursor

Summary

Fields inherited from class android.database.AbstractWindowedCursor

mWindow

Fields inherited from class android.database.AbstractCursor

mContentResolver, mCurrentRowID, mPos, mRowIdColumnIndex, mUpdatedRows

Public Constructors

					SQLiteCursor(SQLiteDatabase db, SQLiteCursorDriver driver, String editTable, SQLiteQuery query, int count)
					Execute a query and provide access to its result set through a Cursor interface.

Public Methods

				void	close()
					Closes the Cursor, releasing all of its resources and making it completely invalid.
				boolean	commitUpdates(Map additionalValues)
					Atomically commits all updates to the backing store, as well as the updates included in values.
				int	count()
					Returns the numbers of rows in the cursor.
				void	deactivate()
					Deactivates the Cursor, making all calls on it fail until requery() is called.
				boolean	deleteRow()
					Removes the row at the current cursor position from the underlying data store.
				int	getColumnIndex(String columnName)
					Returns the zero-based index for the given column name.
				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.
				boolean	requery()
					Performs the query that created the cursor again, refreshing its contents.
				boolean	supportsUpdates()
					Returns `true` if the cursor supports updates.

Protected Methods

				boolean	commitUpdatesInternal(Map additionalValues, boolean useATransaction)
				void	finalize()
					Release the native resources, if they haven't been released yet.
				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	setSelectionArguments(String[] selectionArgs)
					Subclasses may change the selection arguments used by the cursor.

Methods inherited from class android.database.AbstractWindowedCursor

checkPosition, getDouble, getFloat, getInt, getLong, getShort, getString, isNull

Methods inherited from class android.database.AbstractCursor

abortUpdates, checkPosition, close, commitUpdates, commitUpdates, count, deactivate, deleteRow, finalize, first, getColumnIndex, getColumnName, getColumnNames, getDouble, getExtras, getFloat, getInt, getLong, getShort, getString, getUpdatedField, getWantsAllOnMoveCalls, hasUpdates, isAfterLast, isBeforeFirst, isFieldUpdated, isFirst, isLast, isNull, last, move, moveTo, next, onChange, onMove, position, prev, registerContentObserver, registerDataSetObserver, requery, respond, setNotificationUri, supportsUpdates, unregisterContentObserver, unregisterDataSetObserver, update, updateDouble, updateFloat, updateInt, updateLong, updateShort, updateString, updateToNull

		void	abortUpdates()
			Reverts all updates made to the cursor since the last call to commitUpdates.
		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.
		boolean	commitUpdates(Map values)
			Atomically commits all updates to the backing store, as well as the updates included in values.
		boolean	commitUpdates()
			Atomically commits all updates to the backing store.
abstract		int	count()
			Returns the numbers of rows in the cursor.
		void	deactivate()
			Deactivates the Cursor, making all calls on it fail until requery() is called.
		boolean	deleteRow()
			Removes the row at the current cursor position from the underlying data store.
		void	finalize()
			Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
	final	boolean	first()
			Move the cursor to the first row.
		int	getColumnIndex(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.
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		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.
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.
		boolean	hasUpdates()
			Returns `true` if there are pending updates that have not yet been committed.
	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	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	last()
			Move the cursor to the last row.
	final	boolean	move(int offset)
			Move the cursor by a relative amount, forward or backward, from the current position.
	final	boolean	moveTo(int position)
			Move the cursor to an absolute position.
	final	boolean	next()
			Move the cursor to the next 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.
	final	int	position()
			Returns the current position of the cursor in the row set.
	final	boolean	prev()
			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 notifyUri)
			Specifies a content URI to watch for changes.
		boolean	supportsUpdates()
			Returns `true` if the cursor supports updates.
		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).
		boolean	update(int columnIndex, Object obj)
		boolean	updateDouble(int columnIndex, double value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateFloat(int columnIndex, float value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateInt(int columnIndex, int value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateLong(int columnIndex, long value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateShort(int columnIndex, short value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateString(int columnIndex, String value)
			Updates the value for the given column in the row the cursor is currently pointing at.
		boolean	updateToNull(int columnIndex)
			Removes the value for the given column in the row the cursor is currently pointing at.

Methods inherited from class java.lang.Object

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.database.Cursor

				void	abortUpdates()
					Reverts all updates made to the cursor since the last call to commitUpdates.
				void	close()
					Closes the Cursor, releasing all of its resources and making it completely invalid.
				boolean	commitUpdates(Map values)
					Atomically commits all updates to the backing store, as well as the updates included in values.
				boolean	commitUpdates()
					Atomically commits all updates to the backing store.
				int	count()
					Returns the numbers of rows in the cursor.
				void	deactivate()
					Deactivates the Cursor, making all calls on it fail until requery() is called.
				boolean	deleteRow()
					Removes the row at the current cursor position from the underlying data store.
				boolean	first()
					Move the cursor to the first row.
				int	getColumnIndex(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.
				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.
				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	hasUpdates()
					Returns `true` if there are pending updates that have not yet been committed.
				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	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	last()
					Move the cursor to the last row.
				boolean	move(int offset)
					Move the cursor by a relative amount, forward or backward, from the current position.
				boolean	moveTo(int position)
					Move the cursor to an absolute position.
				boolean	next()
					Move the cursor to the next row.
				int	position()
					Returns the current position of the cursor in the row set.
				boolean	prev()
					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.
				boolean	supportsUpdates()
					Returns `true` if the cursor supports updates.
				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).
				boolean	updateDouble(int columnIndex, double value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateFloat(int columnIndex, float value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateInt(int columnIndex, int value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateLong(int columnIndex, long value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateShort(int columnIndex, short value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateString(int columnIndex, String value)
					Updates the value for the given column in the row the cursor is currently pointing at.
				boolean	updateToNull(int columnIndex)
					Removes the value for the given column in the row the cursor is currently pointing at.

Details

Public Constructors

public SQLiteCursor(SQLiteDatabase db, SQLiteCursorDriver driver, String editTable, SQLiteQuery query, int count)

Execute a query and provide access to its result set through a Cursor interface. For a query such as:

SELECT name, birth, phone FROM
 myTable WHERE ... LIMIT 1,20 ORDER BY...

the column names (name, birth, phone) would be in the projection argument and everything from FROM onward would be in the params argument. This constructor has package scope.

Parameters

db	a reference to a Database object that is already constructed and opened
editTable	the name of the table used for this query
query	the rest of the query terms cursor is finalized

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 boolean commitUpdates(Map additionalValues)

Atomically commits all updates to the backing store, as well as the updates included in values. After completion, this method leaves the data in an inconsistent state and you should call requery() before reading data from the cursor again.

public int count()

Returns the numbers of rows in the cursor.

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 boolean deleteRow()

Removes the row at the current cursor position from the underlying data store. After this method returns the cursor will be pointing to the row after the row that is deleted. This has the side effect of decrementing the result of count() by one.

public int getColumnIndex(String columnName)

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

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 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 boolean supportsUpdates()

Returns true if the cursor supports updates.

Protected Methods

protected boolean commitUpdatesInternal(Map additionalValues, boolean useATransaction)

protected void finalize()

Release the native resources, if they haven't been released yet.

protected 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. If it returns false the move function will also do so and the cursor will scroll to the beforeFirst position.

Parameters

oldPosition	the position that we're moving from
newPosition	the position that we're moving to

protected void setSelectionArguments(String[] selectionArgs)

Subclasses may change the selection arguments used by the cursor. The new values take effect after a call to requery().

Android - An Open Handset Alliance Project

Documentation

Goodies

android.database.sqlite.SQLiteCursor

Known Direct Subclasses

Summary

Fields inherited from class android.database.AbstractWindowedCursor

Fields inherited from class android.database.AbstractCursor

Public Constructors

Public Methods

Protected Methods

Methods inherited from class android.database.AbstractWindowedCursor

Methods inherited from class android.database.AbstractCursor

Methods inherited from class java.lang.Object

Methods inherited from interface android.database.Cursor

Details

Public Constructors

public SQLiteCursor(SQLiteDatabase db, SQLiteCursorDriver driver, String editTable, SQLiteQuery query, int count)

Parameters

Public Methods

public void close()

public boolean commitUpdates(Map additionalValues)

public int count()

public void deactivate()

public boolean deleteRow()

public int getColumnIndex(String columnName)

public String[] getColumnNames()

public boolean requery()

public boolean supportsUpdates()

Protected Methods

protected boolean commitUpdatesInternal(Map additionalValues, boolean useATransaction)

protected void finalize()

protected boolean onMove(int oldPosition, int newPosition)

Parameters

protected void setSelectionArguments(String[] selectionArgs)

protected	ContentResolver	mContentResolver
protected	Long	mCurrentRowID
protected	int	mPos
protected	int	mRowIdColumnIndex	This must be set to the index of the row ID column by any subclass that wishes to support updates.
protected	HashMap	mUpdatedRows	This HashMap contains a mapping from Long rowIDs to another Map that maps from String column names to new values.


e.g. "intent" or "activity"