Modifier and Type	Class and Description
private class	IndexCursorImpl.EntryIterator Row iterator (by matching entry) for this cursor, modifiable.
private class	IndexCursorImpl.ForwardIndexDirHandler Handles moving the table index cursor forward.
private abstract static class	IndexCursorImpl.IndexDirHandler Handles moving the table index cursor in a given direction.
private static class	IndexCursorImpl.IndexPosition Value object which maintains the current position of an IndexCursor.
private class	IndexCursorImpl.ReverseIndexDirHandler Handles moving the table index cursor backward.

Modifier and Type	Field and Description
private static final Logger	LOGGER Hides io.github.spannm.jackcess.impl.CursorImpl.LOGGER.
private final IndexData.EntryCursor	mentryCursor Cursor over the entries of the relevant index
private final IndexCursorImpl.IndexDirHandler	mforwardDirHandler IndexDirHandler for forward traversal
private final IndexImpl	mindex logical index which this cursor is using
private Set<String>	mindexEntryPattern column names for the index entry columns
private final IndexCursorImpl.IndexDirHandler	mreverseDirHandler IndexDirHandler for backward traversal

Access	Constructor and Description
private	IndexCursorImpl(TableImpl _table, IndexImpl _index, IndexData.EntryCursor _entryCursor)

Method Summary

Modifier and Type	Method and Description
public static IndexCursorImpl	createCursor(TableImpl the table over which this cursor will traverse _table, IndexImpl index for the table which will define traversal order as well as enhance certain lookups _index, Object[] the first row of data for the cursor, or `null` for the first entry _startRow, boolean whether or not startRow is inclusive or exclusive _startInclusive, Object[] the last row of data for the cursor, or `null` for the last entry _endRow, boolean whether or not endRow is inclusive or exclusive _endInclusive) Creates an indexed cursor for the given table, narrowed to the given range.
public boolean	currentRowMatchesEntry(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.currentRowMatchesEntry. Returns `true` if the current row matches the given index entries.
private boolean	currentRowMatchesEntryImpl(Object[] rowValues, ColumnMatcher columnMatcher)
public Iterator<Row>	entryIterator(EntryIterableBuilder iterBuilder)
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 boolean	findAnotherRowImpl(ColumnImpl columnPattern, Object valuePattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) Overrides io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Moves to the next row (as defined by the cursor) where the given column has the given value.
protected boolean	findAnotherRowImpl(Map<String, ?> rowPattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) Overrides io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Moves to the next row (as defined by the cursor) where the given columns have the given values.
public void	findClosestRowByEntry(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.findClosestRowByEntry. Moves to the first row (as defined by the cursor) where the index entries are >= the given values.
public boolean	findFirstRowByEntry(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.findFirstRowByEntry. Moves to the first row (as defined by the cursor) where the index entries match the given values.
pack-priv boolean	Returns: `true` if a valid row was found with the given values, `false` if no row was found findFirstRowByEntryImpl(Object[] the column values built from the index column values rowValues, boolean whether or not an exact match is desired requireMatch, ColumnMatcher columnMatcher) Moves to the first row (as defined by the cursor) where the index entries match the given values.
private boolean	findPotentialRow(Object[] rowValues, boolean requireMatch)
public Row	findRowByEntry(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.findRowByEntry. Finds the first row (as defined by the cursor) where the index entries match the given values.
protected ColumnMatcher	getDefaultColumnMatcher() Overrides io.github.spannm.jackcess.impl.CursorImpl.getDefaultColumnMatcher. Returns the default ColumnMatcher for this Cursor.
protected IndexCursorImpl.IndexDirHandler	getDirHandler(boolean moveForward) Implements abstract io.github.spannm.jackcess.impl.CursorImpl.getDirHandler. Returns the DirHandler for the given movement direction.
public IndexImpl	getIndex() Implements io.github.spannm.jackcess.IndexCursor.getIndex.
private Set<String>	getIndexEntryPattern()
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 boolean	keepSearching(ColumnMatcher columnMatcher, Object searchInfo) Overrides io.github.spannm.jackcess.impl.CursorImpl.keepSearching. Called by findAnotherRowImpl to determine if the search should continue after finding a row which does not match the current pattern.
public EntryIterableBuilder	newEntryIterable(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.newEntryIterable. Convenience method for constructing a new EntryIterableBuilder for this cursor.
protected Object	prepareSearchInfo(ColumnImpl columnPattern, Object valuePattern) Overrides io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
protected Object	prepareSearchInfo(Map<String, ?> rowPattern) Overrides io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
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.
private Object[]	toRowValues(Object[] entryValues)

Inherited from io.github.spannm.jackcess.impl.CursorImpl:: afterLast beforeFirst createCursor currentRowMatches currentRowMatches currentRowMatches currentRowMatchesImpl currentRowMatchesImpl currentRowMatchesPattern deleteCurrentRow findAnotherRow findAnotherRow findFirstRow findFirstRow findFirstRow findNextRow findNextRow findNextRow findRow getColumnMatcher getCurrentRow getCurrentRow getCurrentRowValue getCurrentRowValue getErrorHandler getFirstPosition getFormat getId getLastPosition getNextRow getNextRow getPageChannel getPreviousRow getPreviousRow getRowState getSavepoint getTable isAfterLast isAtBeginning isBeforeFirst isCurrentRowDeleted isCurrentRowValid iterator iterator moveNextRows movePreviousRows moveToAnotherRow moveToNextRow moveToPreviousRow newIterable reset restorePosition restorePosition restoreSavepoint restoreSavepoint setColumnMatcher setCurrentRowValue setCurrentRowValue setErrorHandler toString updateCurrentRow updateCurrentRowFromMap

Field Detail

LOGGER	back to summary
private static final Logger LOGGER Hides io.github.spannm.jackcess.impl.CursorImpl.LOGGER.

mentryCursor	back to summary
private final IndexData.EntryCursor mentryCursor Cursor over the entries of the relevant index

mforwardDirHandler	back to summary
private final IndexCursorImpl.IndexDirHandler mforwardDirHandler IndexDirHandler for forward traversal

mindex	back to summary
private final IndexImpl mindex logical index which this cursor is using

mindexEntryPattern	back to summary
private Set<String> mindexEntryPattern column names for the index entry columns

mreverseDirHandler	back to summary
private final IndexCursorImpl.IndexDirHandler mreverseDirHandler IndexDirHandler for backward traversal

Constructor Detail

IndexCursorImpl	back to summary
private IndexCursorImpl(TableImpl _table, IndexImpl _index, IndexData.EntryCursor _entryCursor) throws IOException

Method Detail

createCursor back to summary

createCursor	back to summary
public static IndexCursorImpl createCursor(TableImpl _table, IndexImpl _index, Object[] _startRow, boolean _startInclusive, Object[] _endRow, boolean _endInclusive) throws IOException Creates an indexed cursor for the given table, narrowed to the given range. Note, index based table traversal may not include all rows, as certain types of indexes do not include all entries (namely, some indexes ignore null entries, see `Index#shouldIgnoreNulls`). Parameters _table:TableImpl the table over which this cursor will traverse _index:IndexImpl index for the table which will define traversal order as well as enhance certain lookups _startRow:Object[] the first row of data for the cursor, or `null` for the first entry _startInclusive:boolean whether or not startRow is inclusive or exclusive _endRow:Object[] the last row of data for the cursor, or `null` for the last entry _endInclusive:boolean whether or not endRow is inclusive or exclusive

public static IndexCursorImpl createCursor(TableImpl _table, IndexImpl _index, Object[] _startRow, boolean _startInclusive, Object[] _endRow, boolean _endInclusive) throws IOException

Creates an indexed cursor for the given table, narrowed to the given range.

Note, index based table traversal may not include all rows, as certain types of indexes do not include all entries (namely, some indexes ignore null entries, see Index#shouldIgnoreNulls).

Parameters

_table:TableImpl: the table over which this cursor will traverse
_index:IndexImpl: index for the table which will define traversal order as well as enhance certain lookups
_startRow:Object[]: the first row of data for the cursor, or null for the first entry
_startInclusive:boolean: whether or not startRow is inclusive or exclusive
_endRow:Object[]: the last row of data for the cursor, or null for the last entry
_endInclusive:boolean: whether or not endRow is inclusive or exclusive

currentRowMatchesEntry back to summary

currentRowMatchesEntry	back to summary
public boolean currentRowMatchesEntry(Object... entryValues) throws IOException Implements io.github.spannm.jackcess.IndexCursor.currentRowMatchesEntry. Doc from io.github.spannm.jackcess.IndexCursor.currentRowMatchesEntry. Returns `true` if the current row matches the given index entries. Annotations @Override

public boolean currentRowMatchesEntry(Object... entryValues) throws IOException

Implements io.github.spannm.jackcess.IndexCursor.currentRowMatchesEntry.

Doc from io.github.spannm.jackcess.IndexCursor.currentRowMatchesEntry.

Returns true if the current row matches the given index entries.

Annotations

@Override

currentRowMatchesEntryImpl	back to summary
private boolean currentRowMatchesEntryImpl(Object[] rowValues, ColumnMatcher columnMatcher) throws IOException

entryIterator	back to summary
public Iterator<Row> entryIterator(EntryIterableBuilder iterBuilder)

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

findAnotherRowImpl	back to summary
protected boolean findAnotherRowImpl(ColumnImpl columnPattern, Object valuePattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) throws IOException Overrides io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Doc from io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Moves to the next row (as defined by the cursor) where the given column has the given value. Caller manages save/restore on failure. Default implementation scans the table from beginning to end. Annotations @SuppressWarnings:PMD.SimplifyBooleanReturns @Override

findAnotherRowImpl

back to summary

protected boolean findAnotherRowImpl(ColumnImpl columnPattern, Object valuePattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) throws IOException

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

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

Moves to the next row (as defined by the cursor) where the given column has the given value. Caller manages save/restore on failure.

Default implementation scans the table from beginning to end.

Annotations

@SuppressWarnings:PMD.SimplifyBooleanReturns
@Override

findAnotherRowImpl	back to summary
protected boolean findAnotherRowImpl(Map<String, ?> rowPattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) throws IOException Overrides io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Doc from io.github.spannm.jackcess.impl.CursorImpl.findAnotherRowImpl. Moves to the next row (as defined by the cursor) where the given columns have the given values. Caller manages save/restore on failure. Default implementation scans the table from beginning to end. Annotations @Override

findAnotherRowImpl

back to summary

protected boolean findAnotherRowImpl(Map<String, ?> rowPattern, boolean moveForward, ColumnMatcher columnMatcher, Object searchInfo) throws IOException

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

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

Moves to the next row (as defined by the cursor) where the given columns have the given values. Caller manages save/restore on failure.

Default implementation scans the table from beginning to end.

Annotations

@Override

findClosestRowByEntry	back to summary
public void findClosestRowByEntry(Object... entryValues) throws IOException Implements io.github.spannm.jackcess.IndexCursor.findClosestRowByEntry. Doc from io.github.spannm.jackcess.IndexCursor.findClosestRowByEntry. Moves to the first row (as defined by the cursor) where the index entries are >= the given values. If a an exception is thrown, the cursor is restored to its previous state. Annotations @Override

findClosestRowByEntry

back to summary

public void findClosestRowByEntry(Object... entryValues) throws IOException

Implements io.github.spannm.jackcess.IndexCursor.findClosestRowByEntry.

Doc from io.github.spannm.jackcess.IndexCursor.findClosestRowByEntry.

Moves to the first row (as defined by the cursor) where the index entries are >= the given values. If a an exception is thrown, the cursor is restored to its previous state.

Annotations

@Override

findFirstRowByEntry	back to summary
public boolean findFirstRowByEntry(Object... entryValues) throws IOException Implements io.github.spannm.jackcess.IndexCursor.findFirstRowByEntry. Doc from io.github.spannm.jackcess.IndexCursor.findFirstRowByEntry. Moves to the first row (as defined by the cursor) where the index entries match the given values. If a match is not found (or an exception is thrown), the cursor is restored to its previous state. Warning, this method always starts searching from the beginning of the Table (you cannot use it to find successive matches). Annotations @Override

findFirstRowByEntry

back to summary

public boolean findFirstRowByEntry(Object... entryValues) throws IOException

Implements io.github.spannm.jackcess.IndexCursor.findFirstRowByEntry.

Doc from io.github.spannm.jackcess.IndexCursor.findFirstRowByEntry.

Moves to the first row (as defined by the cursor) where the index entries match the given values. If a match is not found (or an exception is thrown), the cursor is restored to its previous state.

Warning, this method always starts searching from the beginning of the Table (you cannot use it to find successive matches).

Annotations

@Override

findFirstRowByEntryImpl back to summary

findFirstRowByEntryImpl	back to summary
pack-priv boolean findFirstRowByEntryImpl(Object[] rowValues, boolean requireMatch, ColumnMatcher columnMatcher) throws IOException Moves to the first row (as defined by the cursor) where the index entries match the given values. Caller manages save/restore on failure. Parameters rowValues:Object[] the column values built from the index column values requireMatch:boolean whether or not an exact match is desired Returns:boolean `true` if a valid row was found with the given values, `false` if no row was found

pack-priv boolean findFirstRowByEntryImpl(Object[] rowValues, boolean requireMatch, ColumnMatcher columnMatcher) throws IOException

Moves to the first row (as defined by the cursor) where the index entries match the given values. Caller manages save/restore on failure.

Parameters

rowValues:Object[]: the column values built from the index column values
requireMatch:boolean: whether or not an exact match is desired

Returns:boolean

true if a valid row was found with the given values, false if no row was found

findPotentialRow	back to summary
private boolean findPotentialRow(Object[] rowValues, boolean requireMatch) throws IOException

findRowByEntry	back to summary
public Row findRowByEntry(Object... entryValues) throws IOException Implements io.github.spannm.jackcess.IndexCursor.findRowByEntry. Doc from io.github.spannm.jackcess.IndexCursor.findRowByEntry. Finds the first row (as defined by the cursor) where the index entries match the given values. If a match is not found (or an exception is thrown), the cursor is restored to its previous state. Annotations @Override

findRowByEntry

back to summary

public Row findRowByEntry(Object... entryValues) throws IOException

Implements io.github.spannm.jackcess.IndexCursor.findRowByEntry.

Doc from io.github.spannm.jackcess.IndexCursor.findRowByEntry.

Finds the first row (as defined by the cursor) where the index entries match the given values. If a match is not found (or an exception is thrown), the cursor is restored to its previous state.

Annotations

@Override

getDefaultColumnMatcher	back to summary
protected ColumnMatcher getDefaultColumnMatcher() Overrides io.github.spannm.jackcess.impl.CursorImpl.getDefaultColumnMatcher. Doc from io.github.spannm.jackcess.impl.CursorImpl.getDefaultColumnMatcher. Returns the default ColumnMatcher for this Cursor. Annotations @Override

getDefaultColumnMatcher

back to summary

protected ColumnMatcher getDefaultColumnMatcher()

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

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

Returns the default ColumnMatcher for this Cursor.

Annotations

@Override

getDirHandler	back to summary
protected IndexCursorImpl.IndexDirHandler 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 IndexCursorImpl.IndexDirHandler 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

getIndex	back to summary
public IndexImpl getIndex() Implements io.github.spannm.jackcess.IndexCursor.getIndex. Annotations @Override

getIndex

back to summary

public IndexImpl getIndex()

Implements io.github.spannm.jackcess.IndexCursor.getIndex.

Annotations

@Override

getIndexEntryPattern	back to summary
private Set<String> getIndexEntryPattern()

getRowPosition	back to summary
protected CursorImpl.PositionImpl getRowPosition(RowIdImpl rowId) throws IOException 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) throws IOException

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

keepSearching	back to summary
protected boolean keepSearching(ColumnMatcher columnMatcher, Object searchInfo) throws IOException Overrides io.github.spannm.jackcess.impl.CursorImpl.keepSearching. Doc from io.github.spannm.jackcess.impl.CursorImpl.keepSearching. Called by findAnotherRowImpl to determine if the search should continue after finding a row which does not match the current pattern. Annotations @Override

keepSearching

back to summary

protected boolean keepSearching(ColumnMatcher columnMatcher, Object searchInfo) throws IOException

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

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

Called by findAnotherRowImpl to determine if the search should continue after finding a row which does not match the current pattern.

Annotations

@Override

newEntryIterable	back to summary
public EntryIterableBuilder newEntryIterable(Object... entryValues) Implements io.github.spannm.jackcess.IndexCursor.newEntryIterable. Doc from io.github.spannm.jackcess.IndexCursor.newEntryIterable. Convenience method for constructing a new EntryIterableBuilder for this cursor. An EntryIterableBuilder provides a variety of options for more flexible iteration based on a specific index entry. Annotations @Override

newEntryIterable

back to summary

public EntryIterableBuilder newEntryIterable(Object... entryValues)

Implements io.github.spannm.jackcess.IndexCursor.newEntryIterable.

Doc from io.github.spannm.jackcess.IndexCursor.newEntryIterable.

Convenience method for constructing a new EntryIterableBuilder for this cursor. An EntryIterableBuilder provides a variety of options for more flexible iteration based on a specific index entry.

Annotations

@Override

prepareSearchInfo	back to summary
protected Object prepareSearchInfo(ColumnImpl columnPattern, Object valuePattern) Overrides io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Doc from io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators). Annotations @Override

prepareSearchInfo

back to summary

protected Object prepareSearchInfo(ColumnImpl columnPattern, Object valuePattern)

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

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

Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).

Annotations

@Override

prepareSearchInfo	back to summary
protected Object prepareSearchInfo(Map<String, ?> rowPattern) Overrides io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Doc from io.github.spannm.jackcess.impl.CursorImpl.prepareSearchInfo. Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators). Annotations @Override

prepareSearchInfo

back to summary

protected Object prepareSearchInfo(Map<String, ?> rowPattern)

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

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

Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).

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

toRowValues	back to summary
private Object[] toRowValues(Object[] entryValues)

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

private final Class IndexCursorImpl.EntryIterator

Class Inheritance

extends BaseIterator

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.BaseIterator
io.github.spannm.jackcess.impl.IndexCursorImpl.EntryIterator

Row iterator (by matching entry) for this cursor, modifiable.

Field Summary

Modifier and Type	Field and Description
private final Object[]	mrowValues

Inherited from io.github.spannm.jackcess.impl.CursorImpl.BaseIterator:: cachedHasNext colMatcher columnNames moveForward validRow

Constructor Summary

Access	Constructor and Description
private	EntryIterator(Collection<String> _columnNames, Object[] _rowValues, ColumnMatcher columnMatcher)

Method Summary

Modifier and Type	Method and Description
protected boolean	findNext() Implements abstract io.github.spannm.jackcess.impl.CursorImpl.BaseIterator.findNext.

Inherited from io.github.spannm.jackcess.impl.CursorImpl.BaseIterator:: hasNext next remove

Field Detail

mrowValues	back to summary
private final Object[] mrowValues

Constructor Detail

EntryIterator	back to summary
private EntryIterator(Collection<String> _columnNames, Object[] _rowValues, ColumnMatcher columnMatcher)

Method Detail

findNext	back to summary
protected boolean findNext() throws IOException Implements abstract io.github.spannm.jackcess.impl.CursorImpl.BaseIterator.findNext. Annotations @Override

findNext

back to summary

protected boolean findNext() throws IOException

Implements abstract io.github.spannm.jackcess.impl.CursorImpl.BaseIterator.findNext.

Annotations

@Override

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

private final Class IndexCursorImpl.ForwardIndexDirHandler

Class Inheritance

extends IndexDirHandler

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.DirHandler
io.github.spannm.jackcess.impl.IndexCursorImpl.IndexDirHandler
io.github.spannm.jackcess.impl.IndexCursorImpl.ForwardIndexDirHandler

Handles moving the table index cursor forward.

Constructor Summary

Access	Constructor and Description
private	ForwardIndexDirHandler()

Method Summary

Modifier and Type	Method and Description
public IndexData.Entry	getAnotherEntry() Implements abstract io.github.spannm.jackcess.impl.IndexCursorImpl.IndexDirHandler.getAnotherEntry.
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.

Constructor Detail

ForwardIndexDirHandler	back to summary
private ForwardIndexDirHandler()

Method Detail

getAnotherEntry	back to summary
public IndexData.Entry getAnotherEntry() throws IOException Implements abstract io.github.spannm.jackcess.impl.IndexCursorImpl.IndexDirHandler.getAnotherEntry. Annotations @Override

getAnotherEntry

back to summary

public IndexData.Entry getAnotherEntry() throws IOException

Implements abstract io.github.spannm.jackcess.impl.IndexCursorImpl.IndexDirHandler.getAnotherEntry.

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

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

private abstract Class IndexCursorImpl.IndexDirHandler

Class Inheritance

extends DirHandler

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.DirHandler
io.github.spannm.jackcess.impl.IndexCursorImpl.IndexDirHandler

Known Direct Subclasses

io.github.spannm.jackcess.impl.IndexCursorImpl.ForwardIndexDirHandler, io.github.spannm.jackcess.impl.IndexCursorImpl.ReverseIndexDirHandler

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

Constructor Summary

Access	Constructor and Description
private	IndexDirHandler()

Method Summary

Modifier and Type	Method and Description
public abstract IndexData.Entry	getAnotherEntry()

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

Constructor Detail

IndexDirHandler	back to summary
private IndexDirHandler()

Method Detail

getAnotherEntry	back to summary
public abstract IndexData.Entry getAnotherEntry() throws IOException

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

private final Class IndexCursorImpl.IndexPosition

Class Inheritance

extends PositionImpl

java.lang.Object
io.github.spannm.jackcess.impl.CursorImpl.PositionImpl
io.github.spannm.jackcess.impl.IndexCursorImpl.IndexPosition

Value object which maintains the current position of an IndexCursor.

Field Summary

Modifier and Type	Field and Description
private final IndexData.Entry	entry

Constructor Summary

Access	Constructor and Description
private	IndexPosition(IndexData.Entry entry)

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 IndexData.Entry	getEntry()
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.