com.yahoo.bard.webservice.web.util

Class PaginationParameters

java.lang.Object

com.yahoo.bard.webservice.web.util.PaginationParameters

public class PaginationParameters
extends Object

A wrapper around the pagination parameters ('perPage' and 'page') to simplify working with pagination requests. This class is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static PaginationParameters	EVERYTHING_IN_ONE_PAGE The common pagination parameter object used by non-paginating method in search providers.
static PaginationParameters	ONE_RESULT Return only the first result.

Constructor Summary

Constructors

Constructor and Description
PaginationParameters(int perPage, int page) Constructor for already-parsed pagination parameters.
PaginationParameters(String perPage, String page) Given a pair of strings, attempts to parse them into ints representing the pagination parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getPage(int resultSize) Returns the requested page number.
int	getPerPage()
int	hashCode()
String	toString()
PaginationParameters	withPage(String page) Returns a new PaginationParameters object with the specified page value.
PaginationParameters	withPerPage(String perPage) Returns a new PaginationParameters object with the specified perPage value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVERYTHING_IN_ONE_PAGE

public static final PaginationParameters EVERYTHING_IN_ONE_PAGE

The common pagination parameter object used by non-paginating method in search providers.

ONE_RESULT

public static final PaginationParameters ONE_RESULT

Return only the first result.

Constructor Detail

PaginationParameters

public PaginationParameters(String perPage,
                            String page)
                     throws BadPaginationException

Given a pair of strings, attempts to parse them into ints representing the pagination parameters.

Parameters:

perPage - The number of rows on each page of results.

page - The requested page of data

Throws:

BadPaginationException - If at least one of 'perPage' or 'page' is not a positive integer.

PaginationParameters

public PaginationParameters(int perPage,
                            int page)

Constructor for already-parsed pagination parameters.

Parameters:

perPage - The number of rows to be displayed on each page.

page - The page to be displayed

Method Detail

getPerPage

public int getPerPage()

getPage

public int getPage(int resultSize)

Returns the requested page number.

Parameters:

resultSize - The number of rows in the result set

Returns:

The request page number

withPage

public PaginationParameters withPage(String page)
                              throws BadPaginationException

Returns a new PaginationParameters object with the specified page value.

Parameters:

page - The new page to retrieve.

Returns:

A new PaginationParameters object with the same state as this object, except with the specified page.

Throws:

BadPaginationException - If page is not a positive Java int.

withPerPage

public PaginationParameters withPerPage(String perPage)
                                 throws BadPaginationException

Returns a new PaginationParameters object with the specified perPage value.

Parameters:

perPage - The new number of rows per page.

Returns:

A new PaginationParameters object with the same state as this object, except with the specified page.

Throws:

BadPaginationException - If page is not a positive Java int.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object