com.iphrase.runtime.query.result
Class PageContext

java.lang.Object
  |
  +--com.iphrase.runtime.query.result.PageContext

public class PageContext
extends java.lang.Object

Represents the page context associated with a result set.

See Also:
ResultSet

Method Summary
 int getCurrentPage()
          Get the current page number for this query result, starting at 0.
 int getEndRow()
          Get the 0-based number of the row AFTER the last row of this query result.
 int getStartRow()
          Get the 0-based number of the first row of this query result.
 Feature getSummarizationAttribute()
          Get the summarization feature for this query result.
 int getTotalItems()
          Get the total number of items for the entire query result.
 int getTotalPages()
          Get the total number of pages for the entire query result.
 int getTotalRows()
          Get the total number of rows for the entire query result.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCurrentPage

public int getCurrentPage()
Get the current page number for this query result, starting at 0.
Returns:
positive int 0-based page number

getTotalPages

public int getTotalPages()
Get the total number of pages for the entire query result.
Returns:
positive int total number of pages

getStartRow

public int getStartRow()
Get the 0-based number of the first row of this query result.
Returns:
positive int 0-based row number

getEndRow

public int getEndRow()
Get the 0-based number of the row AFTER the last row of this query result. Note that getEndRow() - getStartRow() == the number of rows in this query result.
Returns:
positive int 0-based row number

getTotalRows

public int getTotalRows()
Get the total number of rows for the entire query result.
Returns:
positive int total number of rows

getTotalItems

public int getTotalItems()
Get the total number of items for the entire query result. The total number of items can exceed the total number of rows when summarization is in effect, which can cause more than one item to be summarized into a single row.
Returns:
positive int total number of items

getSummarizationAttribute

public Feature getSummarizationAttribute()
Get the summarization feature for this query result.
Returns:
Feature value

© Copyright 2005, 2006. IBM Corporation. All rights reserved.