com.codingzero.utilities.pagination

Class PaginatedResult<T,P extends Paging>

java.lang.Object

com.codingzero.utilities.pagination.PaginatedResult<T,P>

Type Parameters:

T - type of data you're accessing

P - type of paging, like #OffsetPaging or #CursorPaging

Direct Known Subclasses:

CursorPaginatedResult, OffsetPaginatedResult

public class PaginatedResult<T,P extends Paging>
extends Object

This class define a protocol for you to access the data page by page. Remember that you don't actually access data until you invoke #getData() method. NOTE: 1) this is stateful object 2) Only serialize the result data returned from #getData() method, but this one.

Constructor Summary

Constructors

Constructor and Description
PaginatedResult(PaginatedResultDelegate<T,P> delegate, ResultCountDelegate resultCountDelegate, PagingDelegate<P> pagingDelegate, Object... arguments)

Method Summary

Modifier and Type	Method and Description
P	getCurrentPage() Returns the current page.
T	getData() Returns the data with the current page.
List<FieldSort>	getFieldSorts() Returns the current sorting conditions.
int	getTotalCount() Returns the total numbers of data is going to return.
boolean	isTotalCountAvailable() Can tell the total numbers of data.
<R extends PaginatedResult<T,P>> R	next() Move to next page based on the current page
<R extends PaginatedResult<T,P>> R	start(P paging) Initial the current page.
<R extends PaginatedResult<T,P>> R	start(P paging, FieldSort... fieldSort) Initial the current page and sorting conditions.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatedResult

public PaginatedResult(PaginatedResultDelegate<T,P> delegate,
                       ResultCountDelegate resultCountDelegate,
                       PagingDelegate<P> pagingDelegate,
                       Object... arguments)

Method Detail

start

public <R extends PaginatedResult<T,P>> R start(P paging)

Initial the current page.

Type Parameters:

R - R extends PaginatedResult%3CT, P%3E

Parameters:

paging - P

Returns:

R extends PaginatedResult%3CT, P%3E

start

public <R extends PaginatedResult<T,P>> R start(P paging,
                                                FieldSort... fieldSort)

Initial the current page and sorting conditions.

Type Parameters:

R - R extends PaginatedResult%3CT, P%3E

Parameters:

paging - P

fieldSort - array of FieldSort

Returns:

R extends PaginatedResult%3CT, P%3E

next

public <R extends PaginatedResult<T,P>> R next()

Move to next page based on the current page

Type Parameters:

R - PaginatedResult

Returns:

R extends PaginatedResult%3CT, P%3E

getData

public T getData()

Returns the data with the current page.

Returns:

T type of accessing data

getTotalCount

public int getTotalCount()

Returns the total numbers of data is going to return.

Returns:

long

isTotalCountAvailable

public boolean isTotalCountAvailable()

Can tell the total numbers of data. If you need this function, try to implement #ResultCountDelegate interface.

Returns:

boolean

getCurrentPage

public P getCurrentPage()

Returns the current page.

Returns:

P Paging

getFieldSorts

public List<FieldSort> getFieldSorts()

Returns the current sorting conditions.

Returns:

List%3CFieldSort%3E