Package com.aquima.web.rest.v1.paginator

Class Paginator<T>

java.lang.Object

com.aquima.web.rest.v1.paginator.Paginator<T>

Type Parameters:

T - the resource type this paginator can handle

All Implemented Interfaces:

IPaginator<T>

Direct Known Subclasses:

FilteringPaginator, NonFilteringPaginator

public abstract class Paginator<T>
extends Object
implements IPaginator<T>

Base class for paginators.

Author:

Radu Batori

Constructor Summary

Constructors

Constructor	Description
Paginator(List<T> list, Integer pageNumber, Integer pageSize, Integer itemCount)

Method Summary

Modifier and Type	Method	Description
Integer	getFirstPage()
Integer	getLastPage()
protected List<T>	getList()
Integer	getNextPage()	Returns the index of the next page.
Integer	getNumberOfItems()
Integer	getNumberOfPages()
Integer	getPageNumber()
Integer	getPageSize()
Integer	getPrevPage()	Returns the index of the previous page.
boolean	hasNextPage()
boolean	hasPrevPage()
protected void	paginate(PagedObject<T> pagedObject)	If paging is enabled, sets page-related properties of the given paged object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.web.rest.v1.paginator.IPaginator

paginateList

Constructor Details

Paginator

public Paginator(List<T> list,
 Integer pageNumber,
 Integer pageSize,
 Integer itemCount)

Parameters:

list - the resources to paginate (may be all resources or a page of resources)

pageNumber - the current page number (may be null - null disables pagination)

pageSize - the page size (may be null - disables pagination)

itemCount - the total item count (not necessarily equal to list size)

Method Details

getPageSize

public Integer getPageSize()

Specified by:

getPageSize in interface IPaginator<T>

Returns:

the page size (number of resources per page)

getPageNumber

public Integer getPageNumber()

Specified by:

getPageNumber in interface IPaginator<T>

Returns:

the index current page number

getFirstPage

public Integer getFirstPage()

Specified by:

getFirstPage in interface IPaginator<T>

Returns:

the index of the first page

getLastPage

public Integer getLastPage()

Specified by:

getLastPage in interface IPaginator<T>

Returns:

the index of the last page

getPrevPage

public Integer getPrevPage()

Description copied from interface: IPaginator

Returns the index of the previous page. If the current page is also the first page, the index of the previous page equals the index of the first page.

Specified by:

getPrevPage in interface IPaginator<T>

Returns:

the index of the previous page.

getNextPage

public Integer getNextPage()

Description copied from interface: IPaginator

Returns the index of the next page. If the current page is also the last page, the index of the next page equals the index of the last page.

Specified by:

getNextPage in interface IPaginator<T>

Returns:

the index of the next page

getNumberOfItems

public Integer getNumberOfItems()

Specified by:

getNumberOfItems in interface IPaginator<T>

Returns:

the total number of items (prior to pagination).

getNumberOfPages

public Integer getNumberOfPages()

Specified by:

getNumberOfPages in interface IPaginator<T>

Returns:

the total number of pages (after pagination).

hasPrevPage

public boolean hasPrevPage()

Specified by:

hasPrevPage in interface IPaginator<T>

Returns:

true if there is a previous page.

hasNextPage

public boolean hasNextPage()

Specified by:

hasNextPage in interface IPaginator<T>

Returns:

true if there is a next page.

paginate

protected void paginate(PagedObject<T> pagedObject)

If paging is enabled, sets page-related properties of the given paged object.

Parameters:

pagedObject - the resource where the paginated resources are placed

getList

protected List<T> getList()