com.healthmarketscience.jackcess.impl

Class TableScanCursor

java.lang.Object

com.healthmarketscience.jackcess.impl.CursorImpl

com.healthmarketscience.jackcess.impl.TableScanCursor

All Implemented Interfaces:

Cursor, java.lang.Iterable<Row>

public class TableScanCursor
extends CursorImpl

Simple un-indexed cursor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TableScanCursor.ForwardScanDirHandler Handles moving the table scan cursor forward.
private class	TableScanCursor.ReverseScanDirHandler Handles moving the table scan cursor backward.
private class	TableScanCursor.ScanDirHandler Handles moving the table scan cursor in a given direction.
private static class	TableScanCursor.ScanPosition Value object which maintains the current position of a TableScanCursor.

Nested classes/interfaces inherited from class com.healthmarketscience.jackcess.impl.CursorImpl

CursorImpl.BaseIterator, CursorImpl.DirHandler, CursorImpl.IdImpl, CursorImpl.PositionImpl, CursorImpl.SavepointImpl

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.Cursor

Cursor.Id, Cursor.Position, Cursor.Savepoint

Field Summary

Fields

Modifier and Type	Field and Description
private TableScanCursor.ScanDirHandler	_forwardDirHandler ScanDirHandler for forward traversal
private UsageMap.PageCursor	_ownedPagesCursor Cursor over the pages that this table owns
private TableScanCursor.ScanDirHandler	_reverseDirHandler ScanDirHandler for backward traversal
private static TableScanCursor.ScanPosition	FIRST_SCAN_POSITION first position for the TableScanCursor
private static TableScanCursor.ScanPosition	LAST_SCAN_POSITION last position for the TableScanCursor

Fields inherited from class com.healthmarketscience.jackcess.impl.CursorImpl

_columnMatcher, _curPos, _prevPos, MOVE_FORWARD, MOVE_REVERSE

Constructor Summary

Constructors

Constructor and Description
TableScanCursor(TableImpl table)

Method Summary

Modifier and Type	Method and Description
protected CursorImpl.PositionImpl	findAnotherPosition(TableImpl.RowState rowState, CursorImpl.PositionImpl curPos, boolean moveForward) Finds the next non-deleted row after the given row (as defined by this cursor) and returns the id of the row, where "next" may be backwards if moveForward is false.
protected TableScanCursor.ScanDirHandler	getDirHandler(boolean moveForward) Returns the DirHandler for the given movement direction.
protected CursorImpl.PositionImpl	getRowPosition(RowIdImpl rowId) Returns the appropriate position information for the given row (which is the current row and is valid).
protected boolean	isUpToDate() Returns true if this cursor is up-to-date with respect to the relevant table and related table objects, false otherwise.
protected void	reset(boolean moveForward) Resets this cursor for traversing the given direction.
protected void	restorePositionImpl(CursorImpl.PositionImpl curPos, CursorImpl.PositionImpl prevPos) Restores a current and previous position for the cursor.

Methods inherited from class com.healthmarketscience.jackcess.impl.CursorImpl

afterLast, beforeFirst, createCursor, currentRowMatches, currentRowMatches, currentRowMatches, currentRowMatchesImpl, currentRowMatchesImpl, deleteCurrentRow, findAnotherRow, findAnotherRow, findAnotherRowImpl, findAnotherRowImpl, findFirstRow, findFirstRow, findFirstRow, findNextRow, findNextRow, findNextRow, findRow, getColumnMatcher, getCurrentRow, getCurrentRow, getCurrentRowValue, getCurrentRowValue, getDefaultColumnMatcher, getErrorHandler, getFirstPosition, getFormat, getId, getLastPosition, getNextRow, getNextRow, getPageChannel, getPreviousRow, getPreviousRow, getRowState, getSavepoint, getTable, isAfterLast, isAtBeginning, isBeforeFirst, isCurrentRowDeleted, isCurrentRowValid, iterator, iterator, keepSearching, moveNextRows, movePreviousRows, moveToAnotherRow, moveToNextRow, moveToPreviousRow, newIterable, prepareSearchInfo, prepareSearchInfo, reset, restorePosition, restorePosition, restoreSavepoint, restoreSavepoint, setColumnMatcher, setCurrentRowValue, setCurrentRowValue, setErrorHandler, toString, updateCurrentRow, updateCurrentRowFromMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

FIRST_SCAN_POSITION

private static final TableScanCursor.ScanPosition FIRST_SCAN_POSITION

first position for the TableScanCursor

LAST_SCAN_POSITION

private static final TableScanCursor.ScanPosition LAST_SCAN_POSITION

last position for the TableScanCursor

_forwardDirHandler

private final TableScanCursor.ScanDirHandler _forwardDirHandler

ScanDirHandler for forward traversal

_reverseDirHandler

private final TableScanCursor.ScanDirHandler _reverseDirHandler

ScanDirHandler for backward traversal

_ownedPagesCursor

private final UsageMap.PageCursor _ownedPagesCursor

Cursor over the pages that this table owns

Constructor Detail

TableScanCursor

public TableScanCursor(TableImpl table)

Method Detail

getDirHandler

protected TableScanCursor.ScanDirHandler getDirHandler(boolean moveForward)

Description copied from class: CursorImpl

Returns the DirHandler for the given movement direction.

Specified by:

getDirHandler in class CursorImpl

isUpToDate

protected boolean isUpToDate()

Description copied from class: CursorImpl

Returns true if this cursor is up-to-date with respect to the relevant table and related table objects, false otherwise.

Overrides:

isUpToDate in class CursorImpl

reset

protected void reset(boolean moveForward)

Description copied from class: CursorImpl

Resets this cursor for traversing the given direction.

Overrides:

reset in class CursorImpl

restorePositionImpl

protected void restorePositionImpl(CursorImpl.PositionImpl curPos,
                                   CursorImpl.PositionImpl prevPos)
                            throws java.io.IOException

Description copied from class: CursorImpl

Restores a current and previous position for the cursor.

Overrides:

restorePositionImpl in class CursorImpl

Throws:

java.io.IOException

getRowPosition

protected CursorImpl.PositionImpl getRowPosition(RowIdImpl rowId)
                                          throws java.io.IOException

Description copied from class: CursorImpl

Returns the appropriate position information for the given row (which is the current row and is valid).

Specified by:

getRowPosition in class CursorImpl

Throws:

java.io.IOException

findAnotherPosition

protected CursorImpl.PositionImpl findAnotherPosition(TableImpl.RowState rowState,
                                                      CursorImpl.PositionImpl curPos,
                                                      boolean moveForward)
                                               throws java.io.IOException

Description copied from class: CursorImpl

Finds the next non-deleted row after the given row (as defined by this cursor) and returns the id of the row, where "next" may be backwards if moveForward is false. If there are no more rows, the returned rowId should equal the value returned by CursorImpl.getLastPosition() if moving forward and CursorImpl.getFirstPosition() if moving backward.

Specified by:

findAnotherPosition in class CursorImpl

Throws:

java.io.IOException