com.neovisionaries.android.database

Class BaseCursor

java.lang.Object

android.database.CursorWrapper

com.neovisionaries.android.database.BaseCursor

All Implemented Interfaces:

android.database.Cursor

public class BaseCursor
extends android.database.CursorWrapper

A cursor wrapper that provides some utility methods such as getXxxByName(String columnName).

Since:

1.3

Author:

Takahiko Kawasaki

Constructor Summary

Constructors

Constructor and Description
BaseCursor(android.database.Cursor cursor) Constructor that just calls super(cursor).

Method Summary

Modifier and Type	Method and Description
void	copyStringToBufferByName(String columnName, android.database.CharArrayBuffer buffer) Copy the value of the requested column to the given buffer.
byte[]	getBlobByName(String columnName) Get the value of the requested column as a byte array.
boolean	getBoolean(int columnIndex) Get the value of the requested column as a boolean.
boolean	getBooleanByName(String columnName) Get the value of the requested column as a boolean.
double	getDoubleByName(String columnName) Get the value of the requested column as a double.
float	getFloatByName(String columnName) Get the value of the requested column as a float.
int	getIntByName(String columnName) Get the value of the requested column as an int.
long	getLongByName(String columnName) Get the value of the requested column as a long.
short	getShortByName(String columnName) Get the value of the requested column as a short.
String	getStringByName(String columnName) Get the value of the requested column as a String.
boolean	isNullByName(String columnName) Check if the value of the requested column is null.
boolean	join() Wait until this cursor finishes fetching data from the database.

Methods inherited from class android.database.CursorWrapper

close, copyStringToBuffer, deactivate, getBlob, getColumnCount, getColumnIndex, getColumnIndexOrThrow, getColumnName, getColumnNames, getCount, getDouble, getExtras, getFloat, getInt, getLong, getPosition, getShort, getString, getWantsAllOnMoveCalls, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, isNull, move, moveToFirst, moveToLast, moveToNext, moveToPosition, moveToPrevious, registerContentObserver, registerDataSetObserver, requery, respond, setNotificationUri, unregisterContentObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCursor

public BaseCursor(android.database.Cursor cursor)

Constructor that just calls super(cursor).

Parameters:

cursor - The wrapped cursor.

Method Detail

copyStringToBufferByName

public void copyStringToBufferByName(String columnName,
                                     android.database.CharArrayBuffer buffer)

Copy the value of the requested column to the given buffer.

Parameters:

columnName - Column name.

buffer - Destination buffer to copy data to.

getBlobByName

public byte[] getBlobByName(String columnName)

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

This method is equivalent to getBlob(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getDoubleByName

public double getDoubleByName(String columnName)

Get the value of the requested column as a double.

This method is equivalent to getDouble(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getFloatByName

public float getFloatByName(String columnName)

Get the value of the requested column as a float.

This method is equivalent to getFloat(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getIntByName

public int getIntByName(String columnName)

Get the value of the requested column as an int.

This method is equivalent to getInt(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getLongByName

public long getLongByName(String columnName)

Get the value of the requested column as a long.

This method is equivalent to getLong(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getShortByName

public short getShortByName(String columnName)

Get the value of the requested column as a short.

This method is equivalent to getShort(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getStringByName

public String getStringByName(String columnName)

Get the value of the requested column as a String.

This method is equivalent to getString(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

isNullByName

public boolean isNullByName(String columnName)

Check if the value of the requested column is null.

This method is equivalent to isNull(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

getBoolean

public boolean getBoolean(int columnIndex)

Get the value of the requested column as a boolean.

This method is equivalent to Boolean.valueOf(getString(columnIndex)).booleanValue().

Parameters:

columnIndex - Column index.

Returns:

The value of the column.

getBooleanByName

public boolean getBooleanByName(String columnName)

Get the value of the requested column as a boolean.

This method is equivalent to getBoolean(getColumnIndex(columnName)).

Parameters:

columnName - Column name.

Returns:

The value of the column.

join

public boolean join()

Wait until this cursor finishes fetching data from the database.

The specification allows data fetch to be performed asynchronously. As a matter of fact, the cursor implementation for SQLite may behave asynchronously. Asynchronous implementations of Cursor.getCount() return a negative value instead of 0 until they finish fetching data.

Returns:

True if this cursor finished data retrieval. False if the internal thread was interrupted for some reasons.