com.softwareag.mobile.runtime.database

Class Cursor

java.lang.Object

com.softwareag.mobile.runtime.database.Cursor

public class Cursor
extends java.lang.Object

This interface provides read-only access to results returned by a database query. Note that on some platforms the meta information such as column names, amount of column etc are available only, if the Cursor has at least one row. This class is not thread safe.

Constructor Summary

Constructors

Constructor and Description
Cursor()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the cursor.
boolean	first() Moves the cursor to the first row.
byte[]	getBlob(int index) Returns the value of requested column as a byte array.
int	getColumnIndex(java.lang.String columnName) Note that on some platforms the meta information are available only, if the Cursor has at least one row.
java.lang.String	getColumnName(int columnIndex) Returns the column name of the given zero-based index.
java.lang.String[]	getColumnNames() Note that on some platforms the meta information are available only, if the Cursor has at least one row.
int	getCount() Note that on some platforms the meta information are available only, if the Cursor has at least one row.
double	getDouble(int index) Return the value of requested column as a double.
long	getLong(int index) Returns the value of requested column as a long.
int	getPosition()
java.lang.String	getString(int index) Returns the value of requested column as a String.
boolean	last() Moves the cursor to the last row.
boolean	moveTo(int rowIndex) Moves the cursor to an absolute postion.
boolean	next() Moves the cursor to the next row.
boolean	prev() Moves the cursor to the previous row.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cursor

public Cursor()

Method Detail

first

public boolean first()
              throws DatabaseException

Moves the cursor to the first row.

Returns:

false if the cursor is empty.

Throws:

DatabaseException - if the cursor is closed.

last

public boolean last()
             throws DatabaseException

Moves the cursor to the last row.

Returns:

false if the cursor is empty.

Throws:

DatabaseException - if the cursor is closed.

next

public boolean next()
             throws DatabaseException

Moves the cursor to the next row.

Returns:

false if the cursor is already past the last row.

Throws:

DatabaseException - if the cursor is closed.

prev

public boolean prev()
             throws DatabaseException

Moves the cursor to the previous row.

Returns:

false if the cursor is already past the first row.

Throws:

DatabaseException - if the cursor is closed.

moveTo

public boolean moveTo(int rowIndex)
               throws DatabaseException

Moves the cursor to an absolute postion. The valid range is -1<= position <= count.

Parameters:

rowIndex -

Returns:

false if the request destination was not reachable.

Throws:

DatabaseException - if the cursor is closed.

getPosition

public int getPosition()
                throws DatabaseException

Returns:

the current row index

Throws:

DatabaseException - if the cursor is closed.

getColumnIndex

public int getColumnIndex(java.lang.String columnName)
                   throws DatabaseException

Note that on some platforms the meta information are available only, if the Cursor has at least one row.

Parameters:

columnName -

Returns:

the zero-based index of the given column name, or -1 if the column doesn't exist

Throws:

DatabaseException

getColumnName

public java.lang.String getColumnName(int columnIndex)
                               throws DatabaseException

Returns the column name of the given zero-based index. Note that on some platforms the meta information are available only, if the Cursor has at least one row.

Parameters:

columnIndex -

Returns:

null if the index was larger then number of columns.

Throws:

DatabaseException

getCount

public int getCount()
             throws DatabaseException

Note that on some platforms the meta information are available only, if the Cursor has at least one row.

Returns:

number of columns.

Throws:

DatabaseException

getColumnNames

public java.lang.String[] getColumnNames()
                                  throws DatabaseException

Note that on some platforms the meta information are available only, if the Cursor has at least one row. returns an array of column names

Returns:

an array of column names

Throws:

DatabaseException

getBlob

public byte[] getBlob(int index)
               throws DatabaseException

Returns the value of requested column as a byte array.

Parameters:

index - - zero-based index

Returns:

an array of bytes or null.

Throws:

DatabaseException

getDouble

public double getDouble(int index)
                 throws DatabaseException

Return the value of requested column as a double.

Parameters:

index - - the zero-based index

Returns:

a double value

Throws:

DatabaseException

getLong

public long getLong(int index)
             throws DatabaseException

Returns the value of requested column as a long.

Parameters:

index - - the zero-based index

Returns:

a long value

Throws:

DatabaseException

getString

public java.lang.String getString(int index)
                           throws DatabaseException

Returns the value of requested column as a String.

Parameters:

index - - the zero-based index

Returns:

a string or null.

Throws:

DatabaseException

close

public void close()
           throws DatabaseException

Closes the cursor.

Throws:

DatabaseException - if the Cursor is already closed.