com.yahoo.elide.core.pagination

Class PaginationImpl

java.lang.Object

com.yahoo.elide.core.pagination.PaginationImpl

All Implemented Interfaces:

Pagination

public class PaginationImpl
extends Object
implements Pagination

Holds state associated with pagination.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaginationImpl.PaginationKey Denotes the internal field names for paging.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,PaginationImpl.PaginationKey>	PAGE_KEYS
static String	PAGE_LIMIT_KEY
static String	PAGE_NUMBER_KEY
static String	PAGE_OFFSET_KEY
static String	PAGE_SIZE_KEY
static String	PAGE_TOTALS_KEY

Fields inherited from interface com.yahoo.elide.core.request.Pagination

DEFAULT_OFFSET, DEFAULT_PAGE_LIMIT, MAX_PAGE_LIMIT

Constructor Summary

Constructors

Constructor and Description
PaginationImpl(Class<?> entityClass, Integer clientOffset, Integer clientLimit, int systemDefaultLimit, int systemMaxLimit, Boolean generateTotals, Boolean pageByPages) Constructor.
PaginationImpl(Type<?> entityClass, Integer clientOffset, Integer clientLimit, int systemDefaultLimit, int systemMaxLimit, Boolean generateTotals, Boolean pageByPages) Constructor.

Method Summary

Modifier and Type	Method and Description
static PaginationImpl	getDefaultPagination(Type<?> entityClass) Default Instance.
static PaginationImpl	getDefaultPagination(Type<?> entityClass, ElideSettings elideSettings) Default Instance.
static PaginationImpl	parseQueryParams(Type<?> entityClass, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, ElideSettings elideSettings) Given json-api paging params, generate page and pageSize values from query params.
boolean	returnPageTotals() Whether or not the client requested to return page totals.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.elide.core.request.Pagination

getLimit, getOffset, getPageTotals, isDefaultInstance, setPageTotals

Field Detail

PAGE_NUMBER_KEY

public static final String PAGE_NUMBER_KEY

See Also:

Constant Field Values

PAGE_SIZE_KEY

public static final String PAGE_SIZE_KEY

See Also:

Constant Field Values

PAGE_OFFSET_KEY

public static final String PAGE_OFFSET_KEY

See Also:

Constant Field Values

PAGE_LIMIT_KEY

public static final String PAGE_LIMIT_KEY

See Also:

Constant Field Values

PAGE_TOTALS_KEY

public static final String PAGE_TOTALS_KEY

See Also:

Constant Field Values

PAGE_KEYS

public static final Map<String,PaginationImpl.PaginationKey> PAGE_KEYS

Constructor Detail

PaginationImpl

public PaginationImpl(Class<?> entityClass,
                      Integer clientOffset,
                      Integer clientLimit,
                      int systemDefaultLimit,
                      int systemMaxLimit,
                      Boolean generateTotals,
                      Boolean pageByPages)

Constructor.

Parameters:

entityClass - The type of collection we are paginating.

clientOffset - The client requested offset or null if not provided.

clientLimit - The client requested limit or null if not provided.

systemDefaultLimit - The system default limit (in terms of records).

systemMaxLimit - The system max limit (in terms of records).

generateTotals - Whether to return the total number of records.

pageByPages - Whether to page by pages or records.

PaginationImpl

public PaginationImpl(Type<?> entityClass,
                      Integer clientOffset,
                      Integer clientLimit,
                      int systemDefaultLimit,
                      int systemMaxLimit,
                      Boolean generateTotals,
                      Boolean pageByPages)

Constructor.

Parameters:

entityClass - The type of collection we are paginating.

clientOffset - The client requested offset or null if not provided.

clientLimit - The client requested limit or null if not provided.

systemDefaultLimit - The system default limit (in terms of records).

systemMaxLimit - The system max limit (in terms of records).

generateTotals - Whether to return the total number of records.

pageByPages - Whether to page by pages or records.

Method Detail

returnPageTotals

public boolean returnPageTotals()

Whether or not the client requested to return page totals.

Specified by:

returnPageTotals in interface Pagination

Returns:

true if page totals should be returned.

parseQueryParams

public static PaginationImpl parseQueryParams(Type<?> entityClass,
                                              javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                              ElideSettings elideSettings)
                                       throws InvalidValueException

Given json-api paging params, generate page and pageSize values from query params.

Parameters:

entityClass - The collection type.

queryParams - The page queryParams.

elideSettings - Elide settings containing pagination default limits

Returns:

The new Pagination object.

Throws:

InvalidValueException - invalid query parameter

getDefaultPagination

public static PaginationImpl getDefaultPagination(Type<?> entityClass,
                                                  ElideSettings elideSettings)

Default Instance.

Parameters:

elideSettings - general Elide settings

Returns:

The default instance.

getDefaultPagination

public static PaginationImpl getDefaultPagination(Type<?> entityClass)

Default Instance.

Returns:

The default instance.