com.yahoo.bard.webservice.util

Class AllPagesPagination<T>

java.lang.Object

com.yahoo.bard.webservice.util.AllPagesPagination<T>

Type Parameters:

T - collection type

All Implemented Interfaces:

Pagination<T>, Serializable

public class AllPagesPagination<T>
extends Object
implements Pagination<T>

Pagination class that contains all matching results of a query. An instance of AllPagesPagination is responsible for performing pagination, expects the full data set, and perform the trimming itself. This is different from SinglePagePagination which expects an already paginated result set.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.yahoo.bard.webservice.util.Pagination

FIRST_PAGE, serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AllPagesPagination(Collection<T> entireCollection, PaginationParameters paginationParameters) Constructor.

Method Summary

Modifier and Type	Method and Description
OptionalInt	getFirstPage() Gets the number of the first page if this is not the current page.
OptionalInt	getLastPage() Gets the number of the last page if this is not the current page.
OptionalInt	getNextPage() Gets next page if it exists.
int	getNumResults() Get the size of all the data.
int	getPage() Gets the number of the current page.
List<T>	getPageOfData() Get a list of results corresponding to the current page of data.
int	getPerPage() Gets the maximum size of a page.
OptionalInt	getPreviousPage() Gets previous page if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllPagesPagination

public AllPagesPagination(Collection<T> entireCollection,
                          PaginationParameters paginationParameters)
                   throws PageNotFoundException

Constructor.

Parameters:

entireCollection - Collection of entries to be paginated. We guarantee consistent pagination (requesting page 2 of the same collection always returns the same sublist) if and only if the Collection guarantees a consistent iteration order.

paginationParameters - The parameters needed for pagination.

Throws:

PageNotFoundException - if pageToFetch is greater than the number of pages.

Method Detail

getPage

public int getPage()

Description copied from interface: Pagination

Gets the number of the current page.

Specified by:

getPage in interface Pagination<T>

Returns:

The current page

getPerPage

public int getPerPage()

Description copied from interface: Pagination

Gets the maximum size of a page.

Specified by:

getPerPage in interface Pagination<T>

Returns:

The maximum page size

getFirstPage

public OptionalInt getFirstPage()

Description copied from interface: Pagination

Gets the number of the first page if this is not the current page.

Specified by:

getFirstPage in interface Pagination<T>

Returns:

The first page

getLastPage

public OptionalInt getLastPage()

Description copied from interface: Pagination

Gets the number of the last page if this is not the current page.

Specified by:

getLastPage in interface Pagination<T>

Returns:

The last page

getNextPage

public OptionalInt getNextPage()

Description copied from interface: Pagination

Gets next page if it exists.

Specified by:

getNextPage in interface Pagination<T>

Returns:

The next page

getPreviousPage

public OptionalInt getPreviousPage()

Description copied from interface: Pagination

Gets previous page if it exists.

Specified by:

getPreviousPage in interface Pagination<T>

Returns:

The previous page

getPageOfData

public List<T> getPageOfData()

Description copied from interface: Pagination

Get a list of results corresponding to the current page of data.

Specified by:

getPageOfData in interface Pagination<T>

Returns:

The List of paginated results

getNumResults

public int getNumResults()

Description copied from interface: Pagination

Get the size of all the data.

Specified by:

getNumResults in interface Pagination<T>

Returns:

The data size