com.healthmarketscience.jackcess
Class Index.EntryCursor

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

Enclosing class:

Index

public final class Index.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()
Index.Entry	getFirstEntry() Returns the first entry (exclusive) as defined by this cursor.
Index	getIndex()
Index.Entry	getLastEntry() Returns the last entry (exclusive) as defined by this cursor.
Index.Entry	getNextEntry()
Index.Entry	getPreviousEntry()
boolean	isUpToDate() Returns true if this cursor is up-to-date with respect to its index.
void	reset()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getIndex

public Index getIndex()

getFirstEntry

public Index.Entry getFirstEntry()

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

getLastEntry

public Index.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()

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 Index.Entry getNextEntry()
                         throws java.io.IOException

Returns:

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

Throws:

java.io.IOException

getPreviousEntry

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

Returns:

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

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object