com.healthmarketscience.jackcess.impl
Class IndexData.EntryCursor

java.lang.Object
  extended by com.healthmarketscience.jackcess.impl.IndexData.EntryCursor
Enclosing class:
IndexData

public final class IndexData.EntryCursor
extends Object

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


Method Summary
 void afterEntry(Object[] row)
          Repositions the cursor so that the previous row will be the first entry <= the given row.
 void afterLast()
           
 void beforeEntry(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()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, 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()

beforeEntry

public void beforeEntry(Object[] row)
                 throws IOException
Repositions the cursor so that the next row will be the first entry >= the given row.

Throws:
IOException

afterEntry

public void afterEntry(Object[] row)
                throws IOException
Repositions the cursor so that the previous row will be the first entry <= the given row.

Throws:
IOException

getNextEntry

public IndexData.Entry getNextEntry()
                             throws IOException
Returns:
valid entry if there was a next entry, #getLastEntry otherwise
Throws:
IOException

getPreviousEntry

public IndexData.Entry getPreviousEntry()
                                 throws IOException
Returns:
valid entry if there was a next entry, #getFirstEntry otherwise
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2005–2017 Health Market Science. All rights reserved.