org.tmatesoft.sqljet.core.internal.table

Class SqlJetIndexScopeCursor

java.lang.Object

org.tmatesoft.sqljet.core.internal.table.SqlJetCursor

org.tmatesoft.sqljet.core.internal.table.SqlJetRowNumCursor

org.tmatesoft.sqljet.core.internal.table.SqlJetTableDataCursor

org.tmatesoft.sqljet.core.internal.table.SqlJetIndexOrderCursor

org.tmatesoft.sqljet.core.internal.table.SqlJetIndexScopeCursor

All Implemented Interfaces:

ISqlJetCursor

public class SqlJetIndexScopeCursor
extends SqlJetIndexOrderCursor

Constructor Summary

Constructors

Constructor and Description
SqlJetIndexScopeCursor(ISqlJetBtreeDataTable table, SqlJetDb db, java.lang.String indexName, java.lang.Object[] firstKey, java.lang.Object[] lastKey)
SqlJetIndexScopeCursor(ISqlJetBtreeDataTable table, SqlJetDb db, java.lang.String indexName, SqlJetScope scope)

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the current record.
boolean	eof() Tests whether this cursor is positioned behind the last record.
boolean	first() Goes to the first record.
long	getRowId() Gets row Id of the current record.
boolean	goTo(long rowId) Goes to the record with the specified row Id.
boolean	last() Goes to the last record.
boolean	next() Goes to the next record.
boolean	previous() Goes to the previous record.

Methods inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetTableDataCursor

getBlobAsArray, getBlobAsStream, getBoolean, getFieldType, getFloat, getInteger, getRowValues, getString, getValue, isNull, update, updateByFieldNames, updateByFieldNamesOr, updateOr, updateWithRowId, updateWithRowIdOr

Methods inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetRowNumCursor

getLimit, getRowCount, getRowIndex, goToRow, setLimit

Methods inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetCursor

close, getBlobAsArray, getBlobAsStream, getBoolean, getFieldsCount, getFieldType, getFloat, getInteger, getString, getValue, isNull, reverse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tmatesoft.sqljet.core.table.ISqlJetCursor

close, getBlobAsArray, getBlobAsArray, getBlobAsStream, getBlobAsStream, getBoolean, getBoolean, getFieldsCount, getFieldType, getFieldType, getFloat, getFloat, getInteger, getInteger, getLimit, getRowCount, getRowIndex, getRowValues, getString, getString, getValue, getValue, goToRow, isNull, isNull, reverse, setLimit, update, updateByFieldNames, updateByFieldNamesOr, updateOr, updateWithRowId, updateWithRowIdOr

Constructor Detail

SqlJetIndexScopeCursor

public SqlJetIndexScopeCursor(ISqlJetBtreeDataTable table,
                              SqlJetDb db,
                              java.lang.String indexName,
                              java.lang.Object[] firstKey,
                              java.lang.Object[] lastKey)
                       throws SqlJetException

Parameters:

table -

db -

indexName -

firstKey -

lastKey -

Throws:

SqlJetException

SqlJetIndexScopeCursor

public SqlJetIndexScopeCursor(ISqlJetBtreeDataTable table,
                              SqlJetDb db,
                              java.lang.String indexName,
                              SqlJetScope scope)
                       throws SqlJetException

Parameters:

table -

db -

indexName -

scope -

Throws:

SqlJetException

Method Detail

goTo

public boolean goTo(long rowId)
             throws SqlJetException

Description copied from interface: ISqlJetCursor

Goes to the record with the specified row Id.

Specified by:

goTo in interface ISqlJetCursor

Overrides:

goTo in class SqlJetTableDataCursor

Parameters:

rowId - row Id

Returns:

true if cursor was moved successfully.

Throws:

SqlJetException

first

public boolean first()
              throws SqlJetException

Description copied from interface: ISqlJetCursor

Goes to the first record.

Specified by:

first in interface ISqlJetCursor

Overrides:

first in class SqlJetIndexOrderCursor

Returns:

true if there is at least one record.

Throws:

SqlJetException

next

public boolean next()
             throws SqlJetException

Description copied from interface: ISqlJetCursor

Goes to the next record.

Specified by:

next in interface ISqlJetCursor

Overrides:

next in class SqlJetIndexOrderCursor

Returns:

true if there is at least one record and end of cursor is not reached yet

Throws:

SqlJetException

previous

public boolean previous()
                 throws SqlJetException

Description copied from interface: ISqlJetCursor

Goes to the previous record.

Specified by:

previous in interface ISqlJetCursor

Overrides:

previous in class SqlJetIndexOrderCursor

Returns:

true if there is at least one record and begin of cursor is not reached yet

Throws:

SqlJetException

eof

public boolean eof()
            throws SqlJetException

Description copied from interface: ISqlJetCursor

Tests whether this cursor is positioned behind the last record.

Specified by:

eof in interface ISqlJetCursor

Overrides:

eof in class SqlJetIndexOrderCursor

Returns:

true if the cursor is not on a record and fields can't be read.

Throws:

SqlJetException

last

public boolean last()
             throws SqlJetException

Description copied from interface: ISqlJetCursor

Goes to the last record.

Specified by:

last in interface ISqlJetCursor

Overrides:

last in class SqlJetIndexOrderCursor

Returns:

true if there is at least one record.

Throws:

SqlJetException

delete

public void delete()
            throws SqlJetException

Description copied from interface: ISqlJetCursor

Deletes the current record.

Specified by:

delete in interface ISqlJetCursor

Overrides:

delete in class SqlJetIndexOrderCursor

Throws:

SqlJetException

getRowId

public long getRowId()
              throws SqlJetException

Description copied from interface: ISqlJetCursor

Gets row Id of the current record.

Specified by:

getRowId in interface ISqlJetCursor

Overrides:

getRowId in class SqlJetTableDataCursor

Returns:

row Id of the current record.

Throws:

SqlJetException