com.revolsys.collection

Interface ResultPager<T>

Type Parameters:

T - The type of object to page.

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

JdbcQueryResultPager, ListResultPager, OracleJdbcQueryResultPager, PostgreSQLJdbcQueryResultPager

public interface ResultPager<T>
extends AutoCloseable

The ResultPager defines an interface for paging through the results of a query. Methods are provided to set the number of objects to display per page and the current page number. When these values change the implementation will update the information about the number of pages and if the current page is the first/last page or has previous/next pages that allow user interfaces to display the appropriate navigation controls. The getList() method is used to return the List of objects in the current page.

Author:

Paul Austin

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
int	getEndIndex() Get the index of the last object in the current page.
List<T>	getList() Get the list of objects in the current page.
int	getNextPageNumber() Get the page number of the next page.
int	getNumPages() Get the number of pages.
int	getNumResults() Get the total number of results returned.
int	getPageNumber() Get the page number of the current page.
int	getPageSize() Get the number of objects to display in a page.
int	getPreviousPageNumber() Get the page number of the previous page.
int	getStartIndex() Get the index of the first object in the current page.
boolean	hasNextPage() Check to see if there is a next page.
boolean	hasPreviousPage() Check to see if there is a previous page.
boolean	isFirstPage() Check to see if this is the first page.
boolean	isLastPage() Check to see if this is the last page.
void	setPageNumber(int pageNumber) Set the current page number.
void	setPageNumberAndSize(int pageSize, int pageNumber)
void	setPageSize(int pageSize) Set the number of objects per page.

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

getEndIndex

int getEndIndex()

Get the index of the last object in the current page.

Returns:

The index of the last object in the current page.

getList

List<T> getList()

Get the list of objects in the current page.

Returns:

The list of objects in the current page.

getNextPageNumber

int getNextPageNumber()

Get the page number of the next page.

Returns:

Thepage number of the next page.

getNumPages

int getNumPages()

Get the number of pages.

Returns:

The number of pages.

getNumResults

int getNumResults()

Get the total number of results returned.

Returns:

The total number of results returned.

getPageNumber

int getPageNumber()

Get the page number of the current page.

Returns:

Thepage number of the current page.

getPageSize

int getPageSize()

Get the number of objects to display in a page.

Returns:

The number of objects to display in a page.

getPreviousPageNumber

int getPreviousPageNumber()

Get the page number of the previous page.

Returns:

Thepage number of the previous page.

getStartIndex

int getStartIndex()

Get the index of the first object in the current page.

Returns:

The index of the first object in the current page.

hasNextPage

boolean hasNextPage()

Check to see if there is a next page.

Returns:

True if there is a next page.

hasPreviousPage

boolean hasPreviousPage()

Check to see if there is a previous page.

Returns:

True if there is a previous page.

isFirstPage

boolean isFirstPage()

Check to see if this is the first page.

Returns:

True if this is the first page.

isLastPage

boolean isLastPage()

Check to see if this is the last page.

Returns:

True if this is the last page.

setPageNumber

void setPageNumber(int pageNumber)

Set the current page number.

Parameters:

pageNumber - The current page number.

setPageNumberAndSize

void setPageNumberAndSize(int pageSize,
                        int pageNumber)

setPageSize

void setPageSize(int pageSize)

Set the number of objects per page.

Parameters:

pageSize - The number of objects per page.