com.avaje.ebeaninternal.server.query

Class LimitOffsetPagingQuery<T>

java.lang.Object

com.avaje.ebeaninternal.server.query.LimitOffsetPagingQuery<T>

All Implemented Interfaces:

PagingList<T>

public class LimitOffsetPagingQuery<T>
extends Object
implements PagingList<T>

Constructor Summary

Constructors

Constructor and Description
LimitOffsetPagingQuery(EbeanServer server, SpiQuery<T> query, int pageSize)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fetchAheadIfRequired(int pageIndex)
protected T	get(int rowIndex)
List<T>	getAsList() Return the data for all the pages in the form of a single List.
Future<Integer>	getFutureRowCount() Return the Future for getting the total row count.
Page<T>	getPage(int i) Return the page for a given page position (starting at 0).
int	getPageSize() Return the page size.
EbeanServer	getServer()
SpiQuery<T>	getSpiQuery()
int	getTotalPageCount() Return the total page count.
int	getTotalRowCount() Return the total row count.
protected boolean	hasNext(int position)
void	refresh() Refresh will clear all the pages and row count forcing them to be re-fetched when next required.
PagingList<T>	setFetchAhead(boolean fetchAhead) By default fetchAhead is true so use this to turn off fetchAhead.
void	setServer(EbeanServer server)

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitOffsetPagingQuery

public LimitOffsetPagingQuery(EbeanServer server,
                      SpiQuery<T> query,
                      int pageSize)

Method Detail

getServer

public EbeanServer getServer()

setServer

public void setServer(EbeanServer server)

getSpiQuery

public SpiQuery<T> getSpiQuery()

setFetchAhead

public PagingList<T> setFetchAhead(boolean fetchAhead)

Description copied from interface: PagingList

By default fetchAhead is true so use this to turn off fetchAhead.

Set this to false if you don't want to fetch ahead using background fetching.

If set to true (or left as to default) then the next page is fetched in the background as soon as the list is accessed.

Specified by:

setFetchAhead in interface PagingList<T>

getAsList

public List<T> getAsList()

Description copied from interface: PagingList

Return the data for all the pages in the form of a single List.

Iterating through this list will automatically fire the paging queries as required.

Specified by:

getAsList in interface PagingList<T>

getFutureRowCount

public Future<Integer> getFutureRowCount()

Description copied from interface: PagingList

Return the Future for getting the total row count.

Specified by:

getFutureRowCount in interface PagingList<T>

fetchAheadIfRequired

protected void fetchAheadIfRequired(int pageIndex)

refresh

public void refresh()

Description copied from interface: PagingList

Refresh will clear all the pages and row count forcing them to be re-fetched when next required.

Specified by:

refresh in interface PagingList<T>

getPage

public Page<T> getPage(int i)

Description copied from interface: PagingList

Return the page for a given page position (starting at 0).

Specified by:

getPage in interface PagingList<T>

hasNext

protected boolean hasNext(int position)

get

protected T get(int rowIndex)

getTotalPageCount

public int getTotalPageCount()

Description copied from interface: PagingList

Return the total page count.

This is based on the total row count. This will wait until the row count has returned if it has not already.

Specified by:

getTotalPageCount in interface PagingList<T>

getPageSize

public int getPageSize()

Description copied from interface: PagingList

Return the page size. This is the number of rows per page.

Specified by:

getPageSize in interface PagingList<T>

getTotalRowCount

public int getTotalRowCount()

Description copied from interface: PagingList

Return the total row count.

This gets the result from getFutureRowCount and will wait until that query has completed.

Specified by:

getTotalRowCount in interface PagingList<T>