com.healthmarketscience.jackcess
Class IndexData.EntryCursor

java.lang.Object
  com.healthmarketscience.jackcess.IndexData.EntryCursor

Enclosing class:

IndexData

public final class IndexData.EntryCursor
extends java.lang.Object

Utility class to traverse the entries in the Index. Remains valid in the face of index entry modifications.

Method Summary

void	afterEntry(java.lang.Object[] row) Repositions the cursor so that the previous row will be the first entry <= the given row.
void	afterLast()
void	beforeEntry(java.lang.Object[] row) Repositions the cursor so that the next row will be the first entry >= the given row.
void	beforeFirst()
IndexData.Entry	getFirstEntry() Returns the first entry (exclusive) as defined by this cursor.
IndexData	getIndexData()
IndexData.Entry	getLastEntry() Returns the last entry (exclusive) as defined by this cursor.
IndexData.Entry	getNextEntry()
IndexData.Entry	getPreviousEntry()
boolean	isUpToDate() Returns true if this cursor is up-to-date with respect to its index.
void	reset()
protected void	reset(boolean moveForward)
protected void	restorePosition(IndexData.Entry curEntry) Restores a current position for the cursor (current position becomes previous position).
protected void	restorePosition(IndexData.Entry curEntry, IndexData.Entry prevEntry) Restores a current and previous position for the cursor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getIndexData

public IndexData getIndexData()

getFirstEntry

public IndexData.Entry getFirstEntry()

Returns the first entry (exclusive) as defined by this cursor.

getLastEntry

public IndexData.Entry getLastEntry()

Returns the last entry (exclusive) as defined by this cursor.

isUpToDate

public boolean isUpToDate()

Returns true if this cursor is up-to-date with respect to its index.

reset

public void reset()

beforeFirst

public void beforeFirst()

afterLast

public void afterLast()

reset

protected void reset(boolean moveForward)

beforeEntry

public void beforeEntry(java.lang.Object[] row)
                 throws java.io.IOException

Repositions the cursor so that the next row will be the first entry >= the given row.

Throws:

java.io.IOException

afterEntry

public void afterEntry(java.lang.Object[] row)
                throws java.io.IOException

Repositions the cursor so that the previous row will be the first entry <= the given row.

Throws:

java.io.IOException

getNextEntry

public IndexData.Entry getNextEntry()
                             throws java.io.IOException

Returns:

valid entry if there was a next entry, #getLastEntry otherwise

Throws:

java.io.IOException

getPreviousEntry

public IndexData.Entry getPreviousEntry()
                                 throws java.io.IOException

Returns:

valid entry if there was a next entry, #getFirstEntry otherwise

Throws:

java.io.IOException

restorePosition

protected void restorePosition(IndexData.Entry curEntry)
                        throws java.io.IOException

Restores a current position for the cursor (current position becomes previous position).

Throws:

java.io.IOException

restorePosition

protected void restorePosition(IndexData.Entry curEntry,
                               IndexData.Entry prevEntry)
                        throws java.io.IOException

Restores a current and previous position for the cursor.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object