Interface Page<T>

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

DocumentPage, PojoPage<T>

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  long

  getPageNumber()

  The page number within the count of all possible pages.

  long

  getPageSize()

  The page size which is the maximum number of items allowed in one page.

  long

  getStart()

  The start position of this page within all possible items.

  long

  getTotalPages()

  The number of pages covering all possible items.

  long

  getTotalSize()

  The total count (most likely an estimate) of all possible items in the set.

  boolean

  hasContent()

  Whether there are any items in this page.

  boolean

  hasNext()

  Returns true if internal iterator has more elements.

  boolean

  hasNextPage()

  Whether there are any items in the next page.

  boolean

  hasPreviousPage()

  Whether there is a previous page.

  boolean

  isFirstPage()

   

  boolean

  isLastPage()

   

  Iterator<T>

  iterator()

  The internal iterator of type T in this Page.

  T

  next()

  Returns the next element in the internal iterator, which is separate from any new iterator created by calls to iterator().

  long

  size()

  The count of items in this page, which is always less than getPageSize().

  Methods inherited from interface java.lang.Iterable

  forEach, spliterator

• Method Details

  • iterator

    Iterator<T> iterator()
    The internal iterator of type T in this Page. This iterator is the same one used for hasNext() and next().

    Specified by:

    iterator in interface Iterable<T>

  • hasNext

    boolean hasNext()
    Returns true if internal iterator has more elements. The internal iterator is separate from any new iterator created by calls to iterator().

    Returns:

    true if the internal iterator has more elements

  • next

    T next()
    Returns the next element in the internal iterator, which is separate from any new iterator created by calls to iterator().

    Returns:

    the next element in the iteration

  • getStart

    long getStart()
    The start position of this page within all possible items. For result sets this is the position of the first result within the result set.

    Returns:

    the start position

  • getPageSize

    long getPageSize()
    The page size which is the maximum number of items allowed in one page.

    Returns:

    the page size

  • getTotalSize

    long getTotalSize()
    The total count (most likely an estimate) of all possible items in the set. If this number is larger than getPageSize() then hasNextPage() should be true and you most likely can retrieve additional pages to get the remaining available items in the set. For result sets this is the number of items within the result set. For search result sets this is the estimated number of matching items. That means you may see this number change as you paginate through a search result set and the server updates the estimate with something more accurate.

    Returns:

    the total count of possible items

    See Also:

    • xdmp:estimate
    • search:estimate

  • size

    long size()
    The count of items in this page, which is always less than getPageSize(). If (getTotalSize() - getStart()) > getPageSize() then size() == getPageSize().

    Returns:

    the count of items in this page

  • getTotalPages

    long getTotalPages()
    The number of pages covering all possible items. Since this is calculated based on getTotalSize(), it is often an estimate just like getTotalSize(). That means you may see this number change as you paginate through a search result set and the server updates the estimate with something more accurate.

    Returns:

    the number of pages. In pseudo-code:

    if ( getPageSize() == 0 ) return 0;
    Math.ceil( getTotalSize() /  getPageSize() );
     
    

  • hasContent

    boolean hasContent()
    Whether there are any items in this page.

    Returns:

    true if size() > 0;

  • hasNextPage

    boolean hasNextPage()
    Whether there are any items in the next page.

    Returns:

    true if getPageNumber() < getTotalPages();

  • hasPreviousPage

    boolean hasPreviousPage()
    Whether there is a previous page.

    Returns:

    true if getPageNumber() > 0

  • getPageNumber

    long getPageNumber()
    The page number within the count of all possible pages.

    Returns:

    the page number. In pseudo-code:

    if ( getPageSize() == 0 ) return 0;
    if ( getStart() % getPageSize() == 0 ) return getStart() / getPageSize();
    else return Math.floor(getStart() / getPageSize()) + 1;
     
    

  • isFirstPage

    boolean isFirstPage()

    Returns:

    true if getPageSize()==0 or getPageNumber()==1

  • isLastPage

    boolean isLastPage()

    Returns:

    true if getPageSize()==0 or getPageNumber()==getTotalPages()

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.