com.epimorphics.webapi

Class PageInfo

java.lang.Object

com.epimorphics.webapi.PageInfo

public class PageInfo
extends Object

Support for interpreting paging requests on paged results lists.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGESIZE
static String	PAGE_PARAM
protected int	pageNumber
protected int	pageSize
static String	PAGESIZE_PARAM
protected javax.ws.rs.core.UriInfo	requestURI

Constructor Summary

Constructors

Constructor and Description
PageInfo(javax.ws.rs.core.UriInfo requestURI)

Method Summary

Modifier and Type	Method and Description
String	getAbsoluteRequestURI() Return the request URI with query parameters stripped off.
int	getOffset() Return the index of the first result that is requested.
int	getPageNumber() Return the page number requested, default is 0.
int	getPageSize() Return the page size for this request.
String	getPageURI() Return the page URI, this is the request URI with appropriate page and pagesize query parameters added.
String	getPageURI(int pn) Return the page URI for a specific numbered page.
String	getRequestRootURI() Return the request URI incluiding query parameters but not page control parameters

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGESIZE

public static int DEFAULT_PAGESIZE

PAGESIZE_PARAM

public static final String PAGESIZE_PARAM

See Also:

Constant Field Values

PAGE_PARAM

public static final String PAGE_PARAM

See Also:

Constant Field Values

requestURI

protected javax.ws.rs.core.UriInfo requestURI

pageSize

protected int pageSize

pageNumber

protected int pageNumber

Constructor Detail

PageInfo

public PageInfo(javax.ws.rs.core.UriInfo requestURI)

Method Detail

getOffset

public int getOffset()

Return the index of the first result that is requested.

getPageNumber

public int getPageNumber()

Return the page number requested, default is 0.

getPageSize

public int getPageSize()

Return the page size for this request.

getAbsoluteRequestURI

public String getAbsoluteRequestURI()

Return the request URI with query parameters stripped off.

getRequestRootURI

public String getRequestRootURI()

Return the request URI incluiding query parameters but not page control parameters

getPageURI

public String getPageURI()

Return the page URI, this is the request URI with appropriate page and pagesize query parameters added.

getPageURI

public String getPageURI(int pn)

Return the page URI for a specific numbered page.