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 abstract static 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.

Field Summary

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

Inherited from io.github.spannm.jackcess.impl.CursorImpl:: mcolumnMatcher mcurPos MOVE_FORWARD MOVE_REVERSE mprevPos

Access	Constructor and Description
public	TableScanCursor(TableImpl table)

Modifier and Type	Method and Description
protected CursorImpl.PositionImpl	findAnotherPosition(TableImpl.RowState rowState, CursorImpl.PositionImpl curPos, boolean moveForward) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.findAnotherPosition. 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) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getDirHandler. Returns the DirHandler for the given movement direction.
protected CursorImpl.PositionImpl	getRowPosition(RowIdImpl rowId) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getRowPosition. Returns the appropriate position information for the given row (which is the current row and is valid).
protected boolean	isUpToDate() Overrides io.github.spannm.jackcess.impl.CursorImpl.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) Overrides io.github.spannm.jackcess.impl.CursorImpl.reset. Resets this cursor for traversing the given direction.
protected void	restorePositionImpl(CursorImpl.PositionImpl curPos, CursorImpl.PositionImpl prevPos) Overrides io.github.spannm.jackcess.impl.CursorImpl.restorePositionImpl. Restores a current and previous position for the cursor.

Field Detail

FIRST_SCAN_POSITION	back to summary
private static final TableScanCursor.ScanPosition FIRST_SCAN_POSITION first position for the TableScanCursor

forwardDirHandler	back to summary
private final TableScanCursor.ScanDirHandler forwardDirHandler ScanDirHandler for forward traversal

LAST_SCAN_POSITION	back to summary
private static final TableScanCursor.ScanPosition LAST_SCAN_POSITION last position for the TableScanCursor

ownedPagesCursor	back to summary
private final UsageMap.PageCursor ownedPagesCursor Cursor over the pages that this table owns

reverseDirHandler	back to summary
private final TableScanCursor.ScanDirHandler reverseDirHandler ScanDirHandler for backward traversal

TableScanCursor	back to summary
public TableScanCursor(TableImpl table)

Method Detail

findAnotherPosition back to summary

findAnotherPosition	back to summary
protected CursorImpl.PositionImpl findAnotherPosition(TableImpl.RowState rowState, CursorImpl.PositionImpl curPos, boolean moveForward) throws IOException Implements abstract io.github.spannm.jackcess.impl.CursorImpl.findAnotherPosition. Doc from io.github.spannm.jackcess.impl.CursorImpl.findAnotherPosition. 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 `getLastPosition` if moving forward and `getFirstPosition` if moving backward. Annotations @Override

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

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.findAnotherPosition.

Doc from io.github.spannm.jackcess.impl.CursorImpl.findAnotherPosition.

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 getLastPosition if moving forward and getFirstPosition if moving backward.

Annotations

@Override

getDirHandler	back to summary
protected TableScanCursor.ScanDirHandler getDirHandler(boolean moveForward) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getDirHandler. Doc from io.github.spannm.jackcess.impl.CursorImpl.getDirHandler. Returns the DirHandler for the given movement direction. Annotations @Override

getDirHandler

back to summary

protected TableScanCursor.ScanDirHandler getDirHandler(boolean moveForward)

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getDirHandler.

Doc from io.github.spannm.jackcess.impl.CursorImpl.getDirHandler.

Returns the DirHandler for the given movement direction.

Annotations

@Override

getRowPosition	back to summary
protected CursorImpl.PositionImpl getRowPosition(RowIdImpl rowId) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getRowPosition. Doc from io.github.spannm.jackcess.impl.CursorImpl.getRowPosition. Returns the appropriate position information for the given row (which is the current row and is valid). Annotations @Override

getRowPosition

back to summary

protected CursorImpl.PositionImpl getRowPosition(RowIdImpl rowId)

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getRowPosition.

Doc from io.github.spannm.jackcess.impl.CursorImpl.getRowPosition.

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

Annotations

@Override

isUpToDate back to summary

isUpToDate	back to summary
protected boolean isUpToDate() Overrides io.github.spannm.jackcess.impl.CursorImpl.isUpToDate. Doc from io.github.spannm.jackcess.impl.CursorImpl.isUpToDate. Returns `true` if this cursor is up-to-date with respect to the relevant table and related table objects, `false` otherwise. Annotations @Override

protected boolean isUpToDate()

Overrides io.github.spannm.jackcess.impl.CursorImpl.isUpToDate.

Doc from io.github.spannm.jackcess.impl.CursorImpl.isUpToDate.

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

Annotations

@Override

reset	back to summary
protected void reset(boolean moveForward) Overrides io.github.spannm.jackcess.impl.CursorImpl.reset. Doc from io.github.spannm.jackcess.impl.CursorImpl.reset. Resets this cursor for traversing the given direction. Annotations @Override

reset

back to summary

protected void reset(boolean moveForward)

Overrides io.github.spannm.jackcess.impl.CursorImpl.reset.

Doc from io.github.spannm.jackcess.impl.CursorImpl.reset.

Resets this cursor for traversing the given direction.

Annotations

@Override

restorePositionImpl	back to summary
protected void restorePositionImpl(CursorImpl.PositionImpl curPos, CursorImpl.PositionImpl prevPos) throws IOException Overrides io.github.spannm.jackcess.impl.CursorImpl.restorePositionImpl. Doc from io.github.spannm.jackcess.impl.CursorImpl.restorePositionImpl. Restores a current and previous position for the cursor. Annotations @Override

restorePositionImpl

back to summary

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

Overrides io.github.spannm.jackcess.impl.CursorImpl.restorePositionImpl.

Doc from io.github.spannm.jackcess.impl.CursorImpl.restorePositionImpl.

Restores a current and previous position for the cursor.

Annotations

@Override

io.github.spannm.jackcess.impl back to summary

private final Class TableScanCursor.ForwardScanDirHandler

Class Inheritance

extends ScanDirHandler

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.DirHandler
io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler
io.github.spannm.jackcess.impl.TableScanCursor.ForwardScanDirHandler

Handles moving the table scan cursor forward.

Constructor Summary

Access	Constructor and Description
private	ForwardScanDirHandler()

Method Summary

Modifier and Type	Method and Description
public int	getAnotherPageNumber() Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber.
public int	getAnotherRowNumber(int curRowNumber) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber.
public CursorImpl.PositionImpl	getBeginningPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition.
public CursorImpl.PositionImpl	getEndPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition.
public int	getInitialRowNumber(int rowsOnPage) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber.

Constructor Detail

ForwardScanDirHandler	back to summary
private ForwardScanDirHandler()

Method Detail

getAnotherPageNumber	back to summary
public int getAnotherPageNumber() Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber. Annotations @Override

getAnotherPageNumber

back to summary

public int getAnotherPageNumber()

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber.

Annotations

@Override

getAnotherRowNumber	back to summary
public int getAnotherRowNumber(int curRowNumber) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber. Annotations @Override

getAnotherRowNumber

back to summary

public int getAnotherRowNumber(int curRowNumber)

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber.

Annotations

@Override

getBeginningPosition	back to summary
public CursorImpl.PositionImpl getBeginningPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition. Annotations @Override

getBeginningPosition

back to summary

public CursorImpl.PositionImpl getBeginningPosition()

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition.

Annotations

@Override

getEndPosition	back to summary
public CursorImpl.PositionImpl getEndPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition. Annotations @Override

getEndPosition

back to summary

public CursorImpl.PositionImpl getEndPosition()

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition.

Annotations

@Override

getInitialRowNumber	back to summary
public int getInitialRowNumber(int rowsOnPage) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber. Annotations @Override

getInitialRowNumber

back to summary

public int getInitialRowNumber(int rowsOnPage)

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber.

Annotations

@Override

io.github.spannm.jackcess.impl back to summary

private final Class TableScanCursor.ReverseScanDirHandler

Class Inheritance

extends ScanDirHandler

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.DirHandler
io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler
io.github.spannm.jackcess.impl.TableScanCursor.ReverseScanDirHandler

Handles moving the table scan cursor backward.

Constructor Summary

Access	Constructor and Description
private	ReverseScanDirHandler()

Method Summary

Modifier and Type	Method and Description
public int	getAnotherPageNumber() Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber.
public int	getAnotherRowNumber(int curRowNumber) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber.
public CursorImpl.PositionImpl	getBeginningPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition.
public CursorImpl.PositionImpl	getEndPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition.
public int	getInitialRowNumber(int rowsOnPage) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber.

Constructor Detail

ReverseScanDirHandler	back to summary
private ReverseScanDirHandler()

Method Detail

getAnotherPageNumber	back to summary
public int getAnotherPageNumber() Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber. Annotations @Override

getAnotherPageNumber

back to summary

public int getAnotherPageNumber()

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherPageNumber.

Annotations

@Override

getAnotherRowNumber	back to summary
public int getAnotherRowNumber(int curRowNumber) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber. Annotations @Override

getAnotherRowNumber

back to summary

public int getAnotherRowNumber(int curRowNumber)

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getAnotherRowNumber.

Annotations

@Override

getBeginningPosition	back to summary
public CursorImpl.PositionImpl getBeginningPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition. Annotations @Override

getBeginningPosition

back to summary

public CursorImpl.PositionImpl getBeginningPosition()

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getBeginningPosition.

Annotations

@Override

getEndPosition	back to summary
public CursorImpl.PositionImpl getEndPosition() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition. Annotations @Override

getEndPosition

back to summary

public CursorImpl.PositionImpl getEndPosition()

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.DirHandler.getEndPosition.

Annotations

@Override

getInitialRowNumber	back to summary
public int getInitialRowNumber(int rowsOnPage) Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber. Annotations @Override

getInitialRowNumber

back to summary

public int getInitialRowNumber(int rowsOnPage)

Implements abstract io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler.getInitialRowNumber.

Annotations

@Override

io.github.spannm.jackcess.impl back to summary

private abstract Class TableScanCursor.ScanDirHandler

Class Inheritance

extends DirHandler

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.DirHandler
io.github.spannm.jackcess.impl.TableScanCursor.ScanDirHandler

Known Direct Subclasses

io.github.spannm.jackcess.impl.TableScanCursor.ForwardScanDirHandler, io.github.spannm.jackcess.impl.TableScanCursor.ReverseScanDirHandler

Handles moving the table scan cursor in a given direction. Separates cursor logic from value storage.

Constructor Summary

Access	Constructor and Description
private	ScanDirHandler()

Method Summary

Modifier and Type	Method and Description
public abstract int	getAnotherPageNumber()
public abstract int	getAnotherRowNumber(int curRowNumber)
public abstract int	getInitialRowNumber(int rowsOnPage)

Inherited from io.github.spannm.jackcess.impl.CursorImpl.DirHandler:: getBeginningPosition getEndPosition

Constructor Detail

ScanDirHandler	back to summary
private ScanDirHandler()

Method Detail

getAnotherPageNumber	back to summary
public abstract int getAnotherPageNumber()

getAnotherRowNumber	back to summary
public abstract int getAnotherRowNumber(int curRowNumber)

getInitialRowNumber	back to summary
public abstract int getInitialRowNumber(int rowsOnPage)

io.github.spannm.jackcess.impl back to summary

private final Class TableScanCursor.ScanPosition

Class Inheritance

extends PositionImpl

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.PositionImpl
io.github.spannm.jackcess.impl.TableScanCursor.ScanPosition

Value object which maintains the current position of a TableScanCursor.

Field Summary

Modifier and Type	Field and Description
private final RowIdImpl	rowId

Constructor Summary

Access	Constructor and Description
private	ScanPosition(RowIdImpl rowId)

Method Summary

Modifier and Type	Method and Description
protected boolean	equalsImpl(Object o) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.equalsImpl. Returns `true` if the subclass specific info in a Position is equal, `false` otherwise.
public RowIdImpl	getRowId() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.getRowId. Implements io.github.spannm.jackcess.Cursor.Position.getRowId. Returns the unique RowId of the position of the cursor.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from io.github.spannm.jackcess.impl.CursorImpl.PositionImpl:: equals hashCode

Field Detail

rowId	back to summary
private final RowIdImpl rowId

Constructor Detail

ScanPosition	back to summary
private ScanPosition(RowIdImpl rowId)

Method Detail

equalsImpl back to summary

equalsImpl	back to summary
protected boolean equalsImpl(Object o) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.equalsImpl. Doc from io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.equalsImpl. Returns `true` if the subclass specific info in a Position is equal, `false` otherwise. Annotations @Override

protected boolean equalsImpl(Object o)

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.equalsImpl.

Doc from io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.equalsImpl.

Returns true if the subclass specific info in a Position is equal, false otherwise.

Annotations

@Override

getRowId	back to summary
public RowIdImpl getRowId() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.getRowId. Implements io.github.spannm.jackcess.Cursor.Position.getRowId. Doc from io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.getRowId. Returns the unique RowId of the position of the cursor. Annotations @Override

getRowId

back to summary

public RowIdImpl getRowId()

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.getRowId.

Implements io.github.spannm.jackcess.Cursor.Position.getRowId.

Doc from io.github.spannm.jackcess.impl.CursorImpl.PositionImpl.getRowId.

Returns the unique RowId of the position of the cursor.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class TableScanCursor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class TableScanCursor.ForwardScanDirHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class TableScanCursor.ReverseScanDirHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private abstract Class TableScanCursor.ScanDirHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class TableScanCursor.ScanPosition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail