io.stallion.dataAccess.filtering

Class Pager<T>

java.lang.Object

io.stallion.dataAccess.filtering.Pager<T>

Type Parameters:

T -

public class Pager<T>
extends Object

A class holding the paged results from a filter operation.

Constructor Summary

Constructors

Constructor and Description
Pager()

Method Summary

Modifier and Type	Method and Description
List<T>	getCurrentItems() Alias for getItems()
int	getCurrentPage() The current page number of data, starting at 1
List<T>	getItems() All the returned items.
int	getItemsPerPage() The number of items per page
int	getNextPageNumber() The page number for the next page
int	getPageCount() The total available pages of items matching the filterchain
int	getPreviousPageNumber() The page number for the previous page.
List<Integer>	getSurroundingPages()
boolean	isHasNextPage() True if there is a next page of data.
boolean	isHasPreviousPage() True if there is a previous page of data (false if the page number is 1)
Pager	setCurrentItems(List<T> currentItems)
Pager	setCurrentPage(int currentPage)
Pager	setHasNextPage(boolean hasNextPage)
Pager	setHasPreviousPage(boolean hasPreviousPage)
Pager	setItemsPerPage(int itemsPerPage)
Pager	setNextPageNumber(int nextPageNumber)
Pager	setPageCount(int pageCount)
Pager	setPreviousPageNumber(int previousPageNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pager

public Pager()

Method Detail

getItems

public List<T> getItems()

All the returned items.

Returns:

getCurrentItems

public List<T> getCurrentItems()

Alias for getItems()

Returns:

getPageCount

public int getPageCount()

The total available pages of items matching the filterchain

Returns:

getCurrentPage

public int getCurrentPage()

The current page number of data, starting at 1

Returns:

getItemsPerPage

public int getItemsPerPage()

The number of items per page

Returns:

isHasNextPage

public boolean isHasNextPage()

True if there is a next page of data.

Returns:

isHasPreviousPage

public boolean isHasPreviousPage()

True if there is a previous page of data (false if the page number is 1)

Returns:

getNextPageNumber

public int getNextPageNumber()

The page number for the next page

Returns:

getPreviousPageNumber

public int getPreviousPageNumber()

The page number for the previous page.

Returns:

setCurrentItems

public Pager setCurrentItems(List<T> currentItems)

setPageCount

public Pager setPageCount(int pageCount)

setCurrentPage

public Pager setCurrentPage(int currentPage)

setItemsPerPage

public Pager setItemsPerPage(int itemsPerPage)

setHasNextPage

public Pager setHasNextPage(boolean hasNextPage)

setHasPreviousPage

public Pager setHasPreviousPage(boolean hasPreviousPage)

setNextPageNumber

public Pager setNextPageNumber(int nextPageNumber)

setPreviousPageNumber

public Pager setPreviousPageNumber(int previousPageNumber)

getSurroundingPages

public List<Integer> getSurroundingPages()