com.healthmarketscience.jackcess
Class UsageMap.PageCursor

java.lang.Object
  extended by com.healthmarketscience.jackcess.UsageMap.PageCursor
Enclosing class:
UsageMap

public final class UsageMap.PageCursor
extends Object

Utility class to traverse over the pages in the UsageMap. Remains valid in the face of usage map modifications.


Method Summary
 void afterLast()
          After calling this method, getPreviousPage() will return the last page in the map
 void beforeFirst()
          After calling this method, getNextPage() will return the first page in the map
 int getNextPage()
           
 int getPreviousPage()
           
 UsageMap getUsageMap()
           
 boolean isUpToDate()
          Returns true if this cursor is up-to-date with respect to its usage map.
 void reset()
          After calling this method, getNextPage will return the first page in the map
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getUsageMap

public UsageMap getUsageMap()

isUpToDate

public boolean isUpToDate()
Returns true if this cursor is up-to-date with respect to its usage map.


getNextPage

public int getNextPage()
Returns:
valid page number if there was another page to read, RowId.LAST_PAGE_NUMBER otherwise

getPreviousPage

public int getPreviousPage()
Returns:
valid page number if there was another page to read, RowId.FIRST_PAGE_NUMBER otherwise

reset

public void reset()
After calling this method, getNextPage will return the first page in the map


beforeFirst

public void beforeFirst()
After calling this method, getNextPage() will return the first page in the map


afterLast

public void afterLast()
After calling this method, getPreviousPage() will return the last page in the map


toString

public String toString()
Overrides:
toString in class Object


Copyright © 2005-2013 Health Market Science. All Rights Reserved.