CursorImpl

java.lang.Object
- com.healthmarketscience.jackcess.impl.CursorImpl

All Implemented Interfaces:

Cursor, java.lang.Iterable<Row>

Direct Known Subclasses:

IndexCursorImpl, TableScanCursor
```
public abstract class CursorImpl
extends java.lang.Object
implements Cursor
```
Manages iteration for a Table. Different cursors provide different methods of traversing a table. Cursors should be fairly robust in the face of table modification during traversal (although depending on how the table is traversed, row updates may or may not be seen). Multiple cursors may traverse the same table simultaneously.
The Cursor provides a variety of static utility methods to construct cursors with given characteristics or easily search for specific values. For even friendlier and more flexible construction, see CursorBuilder.
Is not thread-safe.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`CursorImpl.BaseIterator` Base implementation of iterator for this cursor, modifiable.
`private class`	`CursorImpl.ColumnMatchIterator` Row iterator for this cursor, modifiable.
`protected class`	`CursorImpl.DirHandler` Handles moving the cursor in a given direction.
`protected static class`	`CursorImpl.IdImpl` Identifier for a cursor.
`protected static class`	`CursorImpl.PositionImpl` Value object which maintains the current position of the cursor.
`private class`	`CursorImpl.RowIterator` Row iterator for this cursor, modifiable.
`private class`	`CursorImpl.RowMatchIterator` Row iterator for this cursor, modifiable.
`protected static class`	`CursorImpl.SavepointImpl` Value object which represents a complete save state of the cursor.

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
`protected ColumnMatcher`	`_columnMatcher` ColumnMatcher to be used when matching column values
`protected CursorImpl.PositionImpl`	`_curPos` the current row
`private CursorImpl.PositionImpl`	`_firstPos` the first (exclusive) row id for this cursor
`private CursorImpl.IdImpl`	`_id` identifier for this cursor
`private CursorImpl.PositionImpl`	`_lastPos` the last (exclusive) row id for this cursor
`protected CursorImpl.PositionImpl`	`_prevPos` the previous row
`private TableImpl.RowState`	`_rowState` State used for reading the table rows
`private TableImpl`	`_table` owning table
`private static org.apache.commons.logging.Log`	`LOG`
`static boolean`	`MOVE_FORWARD` boolean value indicating forward movement
`static boolean`	`MOVE_REVERSE` boolean value indicating reverse movement

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CursorImpl(CursorImpl.IdImpl id, TableImpl table, CursorImpl.PositionImpl firstPos, CursorImpl.PositionImpl lastPos)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterLast()` Resets this cursor for reverse traversal (sets cursor to after the last row).
`void`	`beforeFirst()` Resets this cursor for forward traversal (sets cursor to before the first row).
`static CursorImpl`	`createCursor(TableImpl table)` Creates a normal, un-indexed cursor for the given table.
`boolean`	`currentRowMatches(ColumnImpl columnPattern, java.lang.Object valuePattern)`
`boolean`	`currentRowMatches(Column columnPattern, java.lang.Object valuePattern)` Returns `true` if the current row matches the given pattern.
`boolean`	`currentRowMatches(java.util.Map<java.lang.String,?> rowPattern)` Returns `true` if the current row matches the given pattern.
`protected boolean`	`currentRowMatchesImpl(ColumnImpl columnPattern, java.lang.Object valuePattern, ColumnMatcher columnMatcher)`
`protected boolean`	`currentRowMatchesImpl(java.util.Map<java.lang.String,?> rowPattern, ColumnMatcher columnMatcher)`
`void`	`deleteCurrentRow()` Delete the current row.
`protected abstract 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 boolean`	`findAnotherRow(ColumnImpl columnPattern, java.lang.Object valuePattern, boolean reset, boolean moveForward, ColumnMatcher columnMatcher, java.lang.Object searchInfo)`
`protected boolean`	`findAnotherRow(java.util.Map<java.lang.String,?> rowPattern, boolean reset, boolean moveForward, ColumnMatcher columnMatcher, java.lang.Object searchInfo)`
`protected boolean`	`findAnotherRowImpl(ColumnImpl columnPattern, java.lang.Object valuePattern, boolean moveForward, ColumnMatcher columnMatcher, java.lang.Object searchInfo)` Moves to the next row (as defined by the cursor) where the given column has the given value.
`protected boolean`	`findAnotherRowImpl(java.util.Map<java.lang.String,?> rowPattern, boolean moveForward, ColumnMatcher columnMatcher, java.lang.Object searchInfo)` Moves to the next row (as defined by the cursor) where the given columns have the given values.
`boolean`	`findFirstRow(ColumnImpl columnPattern, java.lang.Object valuePattern)`
`boolean`	`findFirstRow(Column columnPattern, java.lang.Object valuePattern)` Moves to the first row (as defined by the cursor) where the given column has the given value.
`boolean`	`findFirstRow(java.util.Map<java.lang.String,?> rowPattern)` Moves to the first row (as defined by the cursor) where the given columns have the given values.
`boolean`	`findNextRow(ColumnImpl columnPattern, java.lang.Object valuePattern)`
`boolean`	`findNextRow(Column columnPattern, java.lang.Object valuePattern)` Moves to the next row (as defined by the cursor) where the given column has the given value.
`boolean`	`findNextRow(java.util.Map<java.lang.String,?> rowPattern)` Moves to the next row (as defined by the cursor) where the given columns have the given values.
`boolean`	`findRow(RowId rowId)` Moves to the row with the given rowId.
`private Row`	`getAnotherRow(java.util.Collection<java.lang.String> columnNames, boolean moveForward)` Moves to another row in the table based on the given direction and returns it.
`ColumnMatcher`	`getColumnMatcher()` Returns the currently configured ColumnMatcher, always non-`null`.
`Row`	`getCurrentRow()` Returns the current row in this cursor (Column name -> Column value).
`Row`	`getCurrentRow(java.util.Collection<java.lang.String> columnNames)` Returns the current row in this cursor (Column name -> Column value).
`java.lang.Object`	`getCurrentRowValue(Column column)` Returns the given column from the current row.
`java.lang.Object`	`getCurrentRowValue(ColumnImpl column)`
`protected ColumnMatcher`	`getDefaultColumnMatcher()` Returns the default ColumnMatcher for this Cursor.
`protected abstract CursorImpl.DirHandler`	`getDirHandler(boolean moveForward)` Returns the DirHandler for the given movement direction.
`ErrorHandler`	`getErrorHandler()` Gets the currently configured ErrorHandler (always non-`null`).
`protected CursorImpl.PositionImpl`	`getFirstPosition()` Returns the first row id (exclusive) as defined by this cursor.
`JetFormat`	`getFormat()`
`CursorImpl.IdImpl`	`getId()`
`protected CursorImpl.PositionImpl`	`getLastPosition()` Returns the last row id (exclusive) as defined by this cursor.
`Row`	`getNextRow()` Moves to the next row in the table and returns it.
`Row`	`getNextRow(java.util.Collection<java.lang.String> columnNames)` Moves to the next row in the table and returns it.
`PageChannel`	`getPageChannel()`
`Row`	`getPreviousRow()` Moves to the previous row in the table and returns it.
`Row`	`getPreviousRow(java.util.Collection<java.lang.String> columnNames)` Moves to the previous row in the table and returns it.
`protected abstract CursorImpl.PositionImpl`	`getRowPosition(RowIdImpl rowId)` Returns the appropriate position information for the given row (which is the current row and is valid).
`TableImpl.RowState`	`getRowState()`
`CursorImpl.SavepointImpl`	`getSavepoint()` Returns the current state of the cursor which can be restored at a future point in time by a call to `Cursor.restoreSavepoint(com.healthmarketscience.jackcess.Cursor.Savepoint)`.
`TableImpl`	`getTable()`
`boolean`	`isAfterLast()` Returns `true` if the cursor is currently positioned after the last row, `false` otherwise.
`protected boolean`	`isAtBeginning(boolean moveForward)`
`boolean`	`isBeforeFirst()` Returns `true` if the cursor is currently positioned before the first row, `false` otherwise.
`boolean`	`isCurrentRowDeleted()` Returns `true` if the row at which the cursor is currently positioned is deleted, `false` otherwise (including invalid rows).
`protected boolean`	`isCurrentRowValid()` Returns `true` of the current row is valid, `false` otherwise.
`protected boolean`	`isUpToDate()` Returns `true` if this cursor is up-to-date with respect to the relevant table and related table objects, `false` otherwise.
`java.util.Iterator<Row>`	`iterator()` Calls `Cursor.beforeFirst()` on this cursor and returns a modifiable Iterator which will iterate through all the rows of this table.
`java.util.Iterator<Row>`	`iterator(IterableBuilder iterBuilder)`
`protected boolean`	`keepSearching(ColumnMatcher columnMatcher, java.lang.Object searchInfo)` Called by findAnotherRowImpl to determine if the search should continue after finding a row which does not match the current pattern.
`int`	`moveNextRows(int numRows)` Moves forward as many rows as possible up to the given number of rows.
`int`	`movePreviousRows(int numRows)` Moves backward as many rows as possible up to the given number of rows.
`private int`	`moveSomeRows(int numRows, boolean moveForward)` Moves as many rows as possible in the given direction up to the given number of rows.
`protected boolean`	`moveToAnotherRow(boolean moveForward)` Moves to another row in the given direction as defined by this cursor.
`private boolean`	`moveToAnotherRowImpl(boolean moveForward)` Does the grunt work of moving the cursor to another position in the given direction.
`boolean`	`moveToNextRow()` Moves to the next row as defined by this cursor.
`boolean`	`moveToPreviousRow()` Moves to the previous row as defined by this cursor.
`IterableBuilder`	`newIterable()` Convenience method for constructing a new IterableBuilder for this cursor.
`protected java.lang.Object`	`prepareSearchInfo(ColumnImpl columnPattern, java.lang.Object valuePattern)` Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
`protected java.lang.Object`	`prepareSearchInfo(java.util.Map<java.lang.String,?> rowPattern)` Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
`private boolean`	`recheckPosition(boolean moveForward)` Rechecks the current position if the underlying data structures have been modified.
`void`	`reset()` Resets this cursor for forward traversal.
`protected void`	`reset(boolean moveForward)` Resets this cursor for traversing the given direction.
`protected void`	`restorePosition(CursorImpl.PositionImpl curPos)` Restores a current position for the cursor (current position becomes previous position).
`protected void`	`restorePosition(CursorImpl.PositionImpl curPos, CursorImpl.PositionImpl prevPos)` Restores a current and previous position for the cursor if the given positions are different from the current positions.
`protected void`	`restorePositionImpl(CursorImpl.PositionImpl curPos, CursorImpl.PositionImpl prevPos)` Restores a current and previous position for the cursor.
`void`	`restoreSavepoint(Cursor.Savepoint savepoint)` Moves the cursor to a savepoint previously returned from `Cursor.getSavepoint()`.
`void`	`restoreSavepoint(CursorImpl.SavepointImpl savepoint)`
`void`	`setColumnMatcher(ColumnMatcher columnMatcher)` Sets a new ColumnMatcher.
`void`	`setCurrentRowValue(ColumnImpl column, java.lang.Object value)`
`void`	`setCurrentRowValue(Column column, java.lang.Object value)` Updates a single value in the current row.
`void`	`setErrorHandler(ErrorHandler newErrorHandler)` Sets a new ErrorHandler.
`java.lang.String`	`toString()`
`java.lang.Object[]`	`updateCurrentRow(java.lang.Object... row)` Update the current row.
`<M extends java.util.Map<java.lang.String,java.lang.Object>> M`	`updateCurrentRowFromMap(M row)` Update the current row.

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
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - MOVE_FORWARD
```
public static final boolean MOVE_FORWARD
```
    boolean value indicating forward movement
    
    See Also:
    
    Constant Field Values
  - MOVE_REVERSE
```
public static final boolean MOVE_REVERSE
```
    boolean value indicating reverse movement
    
    See Also:
    
    Constant Field Values
  - _id
```
private final CursorImpl.IdImpl _id
```
    identifier for this cursor
  - _table
```
private final TableImpl _table
```
    owning table
  - _rowState
```
private final TableImpl.RowState _rowState
```
    State used for reading the table rows
  - _firstPos
```
private final CursorImpl.PositionImpl _firstPos
```
    the first (exclusive) row id for this cursor
  - _lastPos
```
private final CursorImpl.PositionImpl _lastPos
```
    the last (exclusive) row id for this cursor
  - _prevPos
```
protected CursorImpl.PositionImpl _prevPos
```
    the previous row
  - _curPos
```
protected CursorImpl.PositionImpl _curPos
```
    the current row
  - _columnMatcher
```
protected ColumnMatcher _columnMatcher
```
    ColumnMatcher to be used when matching column values
- Constructor Detail
  - CursorImpl
```
protected CursorImpl(CursorImpl.IdImpl id,
                     TableImpl table,
                     CursorImpl.PositionImpl firstPos,
                     CursorImpl.PositionImpl lastPos)
```
- Method Detail
  - createCursor
```
public static CursorImpl createCursor(TableImpl table)
```
    Creates a normal, un-indexed cursor for the given table.
    
    Parameters:
    
    table - the table over which this cursor will traverse
  - getRowState
```
public TableImpl.RowState getRowState()
```
  - getId
```
public CursorImpl.IdImpl getId()
```
    Specified by:
    
    getId in interface Cursor
  - getTable
```
public TableImpl getTable()
```
    Specified by:
    
    getTable in interface Cursor
  - getFormat
```
public JetFormat getFormat()
```
  - getPageChannel
```
public PageChannel getPageChannel()
```
  - getErrorHandler
```
public ErrorHandler getErrorHandler()
```
    Description copied from interface: Cursor
    
    Gets the currently configured ErrorHandler (always non-null). This will be used to handle all errors.
    
    Specified by:
    
    getErrorHandler in interface Cursor
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler newErrorHandler)
```
    Description copied from interface: Cursor
    
    Sets a new ErrorHandler. If null, resets to using the ErrorHandler configured at the Table level.
    
    Specified by:
    
    setErrorHandler in interface Cursor
  - getColumnMatcher
```
public ColumnMatcher getColumnMatcher()
```
    Description copied from interface: Cursor
    
    Returns the currently configured ColumnMatcher, always non-null.
    
    Specified by:
    
    getColumnMatcher in interface Cursor
  - setColumnMatcher
```
public void setColumnMatcher(ColumnMatcher columnMatcher)
```
    Description copied from interface: Cursor
    
    Sets a new ColumnMatcher. If null, resets to using the default matcher (default depends on Cursor type).
    
    Specified by:
    
    setColumnMatcher in interface Cursor
  - getDefaultColumnMatcher
```
protected ColumnMatcher getDefaultColumnMatcher()
```
    Returns the default ColumnMatcher for this Cursor.
  - getSavepoint
```
public CursorImpl.SavepointImpl getSavepoint()
```
    Description copied from interface: Cursor
    
    Returns the current state of the cursor which can be restored at a future point in time by a call to Cursor.restoreSavepoint(com.healthmarketscience.jackcess.Cursor.Savepoint).
    Savepoints may be used across different cursor instances for the same table, but they must have the same Cursor.Id.
    
    Specified by:
    
    getSavepoint in interface Cursor
  - restoreSavepoint
```
public void restoreSavepoint(Cursor.Savepoint savepoint)
                      throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves the cursor to a savepoint previously returned from Cursor.getSavepoint().
    
    Specified by:
    
    restoreSavepoint in interface Cursor
    
    Throws:
    
    java.io.IOException
  - restoreSavepoint
```
public void restoreSavepoint(CursorImpl.SavepointImpl savepoint)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getFirstPosition
```
protected CursorImpl.PositionImpl getFirstPosition()
```
    Returns the first row id (exclusive) as defined by this cursor.
  - getLastPosition
```
protected CursorImpl.PositionImpl getLastPosition()
```
    Returns the last row id (exclusive) as defined by this cursor.
  - reset
```
public void reset()
```
    Description copied from interface: Cursor
    
    Resets this cursor for forward traversal. Calls Cursor.beforeFirst().
    
    Specified by:
    
    reset in interface Cursor
  - beforeFirst
```
public void beforeFirst()
```
    Description copied from interface: Cursor
    
    Resets this cursor for forward traversal (sets cursor to before the first row).
    
    Specified by:
    
    beforeFirst in interface Cursor
  - afterLast
```
public void afterLast()
```
    Description copied from interface: Cursor
    
    Resets this cursor for reverse traversal (sets cursor to after the last row).
    
    Specified by:
    
    afterLast in interface Cursor
  - isBeforeFirst
```
public boolean isBeforeFirst()
                      throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns true if the cursor is currently positioned before the first row, false otherwise.
    
    Specified by:
    
    isBeforeFirst in interface Cursor
    
    Throws:
    
    java.io.IOException
  - isAfterLast
```
public boolean isAfterLast()
                    throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns true if the cursor is currently positioned after the last row, false otherwise.
    
    Specified by:
    
    isAfterLast in interface Cursor
    
    Throws:
    
    java.io.IOException
  - isAtBeginning
```
protected boolean isAtBeginning(boolean moveForward)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isCurrentRowDeleted
```
public boolean isCurrentRowDeleted()
                            throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns true if the row at which the cursor is currently positioned is deleted, false otherwise (including invalid rows).
    
    Specified by:
    
    isCurrentRowDeleted in interface Cursor
    
    Throws:
    
    java.io.IOException
  - reset
```
protected void reset(boolean moveForward)
```
    Resets this cursor for traversing the given direction.
  - iterator
```
public java.util.Iterator<Row> iterator()
```
    Description copied from interface: Cursor
    
    Calls Cursor.beforeFirst() on this cursor and returns a modifiable Iterator which will iterate through all the rows of this table. Use of the Iterator follows the same restrictions as a call to Cursor.getNextRow().
    For more flexible iteration see Cursor.newIterable().
    
    Specified by:
    
    iterator in interface Cursor
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Row>
  - newIterable
```
public IterableBuilder newIterable()
```
    Description copied from interface: Cursor
    
    Convenience method for constructing a new IterableBuilder for this cursor. An IterableBuilder provides a variety of options for more flexible iteration.
    
    Specified by:
    
    newIterable in interface Cursor
  - iterator
```
public java.util.Iterator<Row> iterator(IterableBuilder iterBuilder)
```
  - deleteCurrentRow
```
public void deleteCurrentRow()
                      throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Delete the current row.
    Note, re-deleting an already deleted row is allowed (it does nothing).
    
    Specified by:
    
    deleteCurrentRow in interface Cursor
    
    Throws:
    
    java.io.IOException
  - updateCurrentRow
```
public java.lang.Object[] updateCurrentRow(java.lang.Object... row)
                                    throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Update the current row.
    
    Specified by:
    
    updateCurrentRow in interface Cursor
    
    Returns:
    
    the given row values if long enough, otherwise a new array, updated with the current row values
    
    Throws:
    
    java.io.IOException
  - updateCurrentRowFromMap
```
public <M extends java.util.Map<java.lang.String,java.lang.Object>> M updateCurrentRowFromMap(M row)
                                                                                       throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Update the current row.
    
    Specified by:
    
    updateCurrentRowFromMap in interface Cursor
    
    Returns:
    
    the given row, updated with the current row values
    
    Throws:
    
    java.io.IOException
  - getNextRow
```
public Row getNextRow()
               throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the next row in the table and returns it.
    
    Specified by:
    
    getNextRow in interface Cursor
    
    Returns:
    
    The next row in this table (Column name -> Column value), or null if no next row is found
    
    Throws:
    
    java.io.IOException
  - getNextRow
```
public Row getNextRow(java.util.Collection<java.lang.String> columnNames)
               throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the next row in the table and returns it.
    
    Specified by:
    
    getNextRow in interface Cursor
    
    Parameters:
    
    columnNames - Only column names in this collection will be returned
    
    Returns:
    
    The next row in this table (Column name -> Column value), or null if no next row is found
    
    Throws:
    
    java.io.IOException
  - getPreviousRow
```
public Row getPreviousRow()
                   throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the previous row in the table and returns it.
    
    Specified by:
    
    getPreviousRow in interface Cursor
    
    Returns:
    
    The previous row in this table (Column name -> Column value), or null if no previous row is found
    
    Throws:
    
    java.io.IOException
  - getPreviousRow
```
public Row getPreviousRow(java.util.Collection<java.lang.String> columnNames)
                   throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the previous row in the table and returns it.
    
    Specified by:
    
    getPreviousRow in interface Cursor
    
    Parameters:
    
    columnNames - Only column names in this collection will be returned
    
    Returns:
    
    The previous row in this table (Column name -> Column value), or null if no previous row is found
    
    Throws:
    
    java.io.IOException
  - getAnotherRow
```
private Row getAnotherRow(java.util.Collection<java.lang.String> columnNames,
                          boolean moveForward)
                   throws java.io.IOException
```
    Moves to another row in the table based on the given direction and returns it.
    
    Parameters:
    
    columnNames - Only column names in this collection will be returned
    
    Returns:
    
    another row in this table (Column name -> Column value), where "next" may be backwards if moveForward is false, or null if there is not another row in the given direction.
    
    Throws:
    
    java.io.IOException
  - moveToNextRow
```
public boolean moveToNextRow()
                      throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the next row as defined by this cursor.
    
    Specified by:
    
    moveToNextRow in interface Cursor
    
    Returns:
    
    true if a valid next row was found, false otherwise
    
    Throws:
    
    java.io.IOException
  - moveToPreviousRow
```
public boolean moveToPreviousRow()
                          throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the previous row as defined by this cursor.
    
    Specified by:
    
    moveToPreviousRow in interface Cursor
    
    Returns:
    
    true if a valid previous row was found, false otherwise
    
    Throws:
    
    java.io.IOException
  - moveToAnotherRow
```
protected boolean moveToAnotherRow(boolean moveForward)
                            throws java.io.IOException
```
    Moves to another row in the given direction as defined by this cursor.
    
    Returns:
    
    true if another valid row was found in the given direction, false otherwise
    
    Throws:
    
    java.io.IOException
  - restorePosition
```
protected void restorePosition(CursorImpl.PositionImpl curPos)
                        throws java.io.IOException
```
    Restores a current position for the cursor (current position becomes previous position).
    
    Throws:
    
    java.io.IOException
  - restorePosition
```
protected final void restorePosition(CursorImpl.PositionImpl curPos,
                                     CursorImpl.PositionImpl prevPos)
                              throws java.io.IOException
```
    Restores a current and previous position for the cursor if the given positions are different from the current positions.
    
    Throws:
    
    java.io.IOException
  - restorePositionImpl
```
protected void restorePositionImpl(CursorImpl.PositionImpl curPos,
                                   CursorImpl.PositionImpl prevPos)
                            throws java.io.IOException
```
    Restores a current and previous position for the cursor.
    
    Throws:
    
    java.io.IOException
  - recheckPosition
```
private boolean recheckPosition(boolean moveForward)
                         throws java.io.IOException
```
    Rechecks the current position if the underlying data structures have been modified.
    
    Returns:
    
    true if the cursor ended up in a new position, false otherwise.
    
    Throws:
    
    java.io.IOException
  - moveToAnotherRowImpl
```
private boolean moveToAnotherRowImpl(boolean moveForward)
                              throws java.io.IOException
```
    Does the grunt work of moving the cursor to another position in the given direction.
    
    Throws:
    
    java.io.IOException
  - findRow
```
public boolean findRow(RowId rowId)
                throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the row with the given rowId. If the row is not found (or an exception is thrown), the cursor is restored to its previous state.
    
    Specified by:
    
    findRow in interface Cursor
    
    Returns:
    
    true if a valid row was found with the given id, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findFirstRow
```
public boolean findFirstRow(Column columnPattern,
                            java.lang.Object valuePattern)
                     throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the first row (as defined by the cursor) where the given column has the given value. This may be more efficient on some cursors than others. 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).
    
    Specified by:
    
    findFirstRow in interface Cursor
    
    Parameters:
    
    columnPattern - column from the table for this cursor which is being matched by the valuePattern
    
    valuePattern - value which is equal to the corresponding value in the matched row
    
    Returns:
    
    true if a valid row was found with the given value, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findFirstRow
```
public boolean findFirstRow(ColumnImpl columnPattern,
                            java.lang.Object valuePattern)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - findNextRow
```
public boolean findNextRow(Column columnPattern,
                           java.lang.Object valuePattern)
                    throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the next row (as defined by the cursor) where the given column has the given value. This may be more efficient on some cursors than others. If a match is not found (or an exception is thrown), the cursor is restored to its previous state.
    
    Specified by:
    
    findNextRow in interface Cursor
    
    Parameters:
    
    columnPattern - column from the table for this cursor which is being matched by the valuePattern
    
    valuePattern - value which is equal to the corresponding value in the matched row
    
    Returns:
    
    true if a valid row was found with the given value, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findNextRow
```
public boolean findNextRow(ColumnImpl columnPattern,
                           java.lang.Object valuePattern)
                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - findAnotherRow
```
protected boolean findAnotherRow(ColumnImpl columnPattern,
                                 java.lang.Object valuePattern,
                                 boolean reset,
                                 boolean moveForward,
                                 ColumnMatcher columnMatcher,
                                 java.lang.Object searchInfo)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - findFirstRow
```
public boolean findFirstRow(java.util.Map<java.lang.String,?> rowPattern)
                     throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the first row (as defined by the cursor) where the given columns have the given values. This may be more efficient on some cursors than others. 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).
    
    Specified by:
    
    findFirstRow in interface Cursor
    
    Parameters:
    
    rowPattern - column names and values which must be equal to the corresponding values in the matched row
    
    Returns:
    
    true if a valid row was found with the given values, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findNextRow
```
public boolean findNextRow(java.util.Map<java.lang.String,?> rowPattern)
                    throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves to the next row (as defined by the cursor) where the given columns have the given values. This may be more efficient on some cursors than others. If a match is not found (or an exception is thrown), the cursor is restored to its previous state.
    
    Specified by:
    
    findNextRow in interface Cursor
    
    Parameters:
    
    rowPattern - column names and values which must be equal to the corresponding values in the matched row
    
    Returns:
    
    true if a valid row was found with the given values, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findAnotherRow
```
protected boolean findAnotherRow(java.util.Map<java.lang.String,?> rowPattern,
                                 boolean reset,
                                 boolean moveForward,
                                 ColumnMatcher columnMatcher,
                                 java.lang.Object searchInfo)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - currentRowMatches
```
public boolean currentRowMatches(Column columnPattern,
                                 java.lang.Object valuePattern)
                          throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns true if the current row matches the given pattern.
    
    Specified by:
    
    currentRowMatches in interface Cursor
    
    Parameters:
    
    columnPattern - column from the table for this cursor which is being matched by the valuePattern
    
    valuePattern - value which is tested for equality with the corresponding value in the current row
    
    Throws:
    
    java.io.IOException
  - currentRowMatches
```
public boolean currentRowMatches(ColumnImpl columnPattern,
                                 java.lang.Object valuePattern)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - currentRowMatchesImpl
```
protected boolean currentRowMatchesImpl(ColumnImpl columnPattern,
                                        java.lang.Object valuePattern,
                                        ColumnMatcher columnMatcher)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - currentRowMatches
```
public boolean currentRowMatches(java.util.Map<java.lang.String,?> rowPattern)
                          throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns true if the current row matches the given pattern.
    
    Specified by:
    
    currentRowMatches in interface Cursor
    
    Parameters:
    
    rowPattern - column names and values which must be equal to the corresponding values in the current row
    
    Throws:
    
    java.io.IOException
  - currentRowMatchesImpl
```
protected boolean currentRowMatchesImpl(java.util.Map<java.lang.String,?> rowPattern,
                                        ColumnMatcher columnMatcher)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - findAnotherRowImpl
```
protected boolean findAnotherRowImpl(ColumnImpl columnPattern,
                                     java.lang.Object valuePattern,
                                     boolean moveForward,
                                     ColumnMatcher columnMatcher,
                                     java.lang.Object searchInfo)
                              throws java.io.IOException
```
    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.
    
    Parameters:
    
    columnPattern - column from the table for this cursor which is being matched by the valuePattern
    
    valuePattern - value which is equal to the corresponding value in the matched row
    
    Returns:
    
    true if a valid row was found with the given value, false if no row was found
    
    Throws:
    
    java.io.IOException
  - findAnotherRowImpl
```
protected boolean findAnotherRowImpl(java.util.Map<java.lang.String,?> rowPattern,
                                     boolean moveForward,
                                     ColumnMatcher columnMatcher,
                                     java.lang.Object searchInfo)
                              throws java.io.IOException
```
    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.
    
    Parameters:
    
    rowPattern - column names and values which must be equal to the corresponding values in the matched row
    
    Returns:
    
    true if a valid row was found with the given values, false if no row was found
    
    Throws:
    
    java.io.IOException
  - prepareSearchInfo
```
protected java.lang.Object prepareSearchInfo(ColumnImpl columnPattern,
                                             java.lang.Object valuePattern)
```
    Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
  - prepareSearchInfo
```
protected java.lang.Object prepareSearchInfo(java.util.Map<java.lang.String,?> rowPattern)
```
    Called before a search commences to allow for search specific data to be generated (which is cached for re-use by the iterators).
  - keepSearching
```
protected boolean keepSearching(ColumnMatcher columnMatcher,
                                java.lang.Object searchInfo)
                         throws java.io.IOException
```
    Called by findAnotherRowImpl to determine if the search should continue after finding a row which does not match the current pattern.
    
    Throws:
    
    java.io.IOException
  - moveNextRows
```
public int moveNextRows(int numRows)
                 throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves forward as many rows as possible up to the given number of rows.
    
    Specified by:
    
    moveNextRows in interface Cursor
    
    Returns:
    
    the number of rows moved.
    
    Throws:
    
    java.io.IOException
  - movePreviousRows
```
public int movePreviousRows(int numRows)
                     throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Moves backward as many rows as possible up to the given number of rows.
    
    Specified by:
    
    movePreviousRows in interface Cursor
    
    Returns:
    
    the number of rows moved.
    
    Throws:
    
    java.io.IOException
  - moveSomeRows
```
private int moveSomeRows(int numRows,
                         boolean moveForward)
                  throws java.io.IOException
```
    Moves as many rows as possible in the given direction up to the given number of rows.
    
    Returns:
    
    the number of rows moved.
    
    Throws:
    
    java.io.IOException
  - getCurrentRow
```
public Row getCurrentRow()
                  throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns the current row in this cursor (Column name -> Column value).
    
    Specified by:
    
    getCurrentRow in interface Cursor
    
    Throws:
    
    java.io.IOException
  - getCurrentRow
```
public Row getCurrentRow(java.util.Collection<java.lang.String> columnNames)
                  throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns the current row in this cursor (Column name -> Column value).
    
    Specified by:
    
    getCurrentRow in interface Cursor
    
    Parameters:
    
    columnNames - Only column names in this collection will be returned
    
    Throws:
    
    java.io.IOException
  - getCurrentRowValue
```
public java.lang.Object getCurrentRowValue(Column column)
                                    throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Returns the given column from the current row.
    
    Specified by:
    
    getCurrentRowValue in interface Cursor
    
    Throws:
    
    java.io.IOException
  - getCurrentRowValue
```
public java.lang.Object getCurrentRowValue(ColumnImpl column)
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setCurrentRowValue
```
public void setCurrentRowValue(Column column,
                               java.lang.Object value)
                        throws java.io.IOException
```
    Description copied from interface: Cursor
    
    Updates a single value in the current row.
    
    Specified by:
    
    setCurrentRowValue in interface Cursor
    
    Throws:
    
    java.io.IOException
  - setCurrentRowValue
```
public void setCurrentRowValue(ColumnImpl column,
                               java.lang.Object value)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isUpToDate
```
protected boolean isUpToDate()
```
    Returns true if this cursor is up-to-date with respect to the relevant table and related table objects, false otherwise.
  - isCurrentRowValid
```
protected boolean isCurrentRowValid()
                             throws java.io.IOException
```
    Returns true of the current row is valid, false otherwise.
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getRowPosition
```
protected abstract CursorImpl.PositionImpl getRowPosition(RowIdImpl rowId)
                                                   throws java.io.IOException
```
    Returns the appropriate position information for the given row (which is the current row and is valid).
    
    Throws:
    
    java.io.IOException
  - findAnotherPosition
```
protected abstract CursorImpl.PositionImpl findAnotherPosition(TableImpl.RowState rowState,
                                                               CursorImpl.PositionImpl curPos,
                                                               boolean moveForward)
                                                        throws java.io.IOException
```
    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.
    
    Throws:
    
    java.io.IOException
  - getDirHandler
```
protected abstract CursorImpl.DirHandler getDirHandler(boolean moveForward)
```
    Returns the DirHandler for the given movement direction.

Class CursorImpl

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

LOG

MOVE_FORWARD

MOVE_REVERSE

_id

_table

_rowState

_firstPos

_lastPos

_prevPos

_curPos

_columnMatcher

Constructor Detail

CursorImpl

Method Detail

createCursor

getRowState

getId

getTable

getFormat

getPageChannel

getErrorHandler

setErrorHandler

getColumnMatcher

setColumnMatcher

getDefaultColumnMatcher

getSavepoint

restoreSavepoint

restoreSavepoint

getFirstPosition

getLastPosition

reset

beforeFirst

afterLast

isBeforeFirst

isAfterLast

isAtBeginning

isCurrentRowDeleted

reset

iterator

newIterable

iterator

deleteCurrentRow

updateCurrentRow

updateCurrentRowFromMap

getNextRow

getNextRow

getPreviousRow

getPreviousRow

getAnotherRow

moveToNextRow

moveToPreviousRow

moveToAnotherRow

restorePosition

restorePosition

restorePositionImpl

recheckPosition

moveToAnotherRowImpl

findRow

findFirstRow

findFirstRow

findNextRow

findNextRow

findAnotherRow

findFirstRow

findNextRow

findAnotherRow

currentRowMatches

currentRowMatches

currentRowMatchesImpl

currentRowMatches

currentRowMatchesImpl