com.avaje.ebeaninternal.server.query

Class LimitOffsetPage<T>

java.lang.Object

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

Type Parameters:

T - the entity bean type

All Implemented Interfaces:

BeanCollectionTouched, Page<T>

public class LimitOffsetPage<T>
extends Object
implements Page<T>, BeanCollectionTouched

Page implementation based on limit offset types of queries.

Author:

rbygrave

Constructor Summary

Constructors

Constructor and Description
LimitOffsetPage(int pageIndex, LimitOffsetPagingQuery<T> owner)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayXtoYofZ(String to, String of) Helper method to return a "X to Y of Z" string for this page where X is the first row, Y the last row and Z the total row count.
FutureList<T>	getFutureList()
List<T>	getList() Return the list of entities for this page.
int	getPageIndex() Return the index position of this page.
int	getTotalPageCount() Return the total number of pages.
int	getTotalRowCount() Return the total row count for all pages.
boolean	hasNext() Return true if there is a next page.
boolean	hasPrev() Return true if there is a previous page.
Page<T>	next() Return the next page.
void	notifyTouched(BeanCollection<?> c) Perform fetch ahead when the list is first accessed.
Page<T>	prev() Return the previous page.

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitOffsetPage

public LimitOffsetPage(int pageIndex,
               LimitOffsetPagingQuery<T> owner)

Method Detail

getFutureList

public FutureList<T> getFutureList()

notifyTouched

public void notifyTouched(BeanCollection<?> c)

Perform fetch ahead when the list is first accessed.

Specified by:

notifyTouched in interface BeanCollectionTouched

getList

public List<T> getList()

Description copied from interface: Page

Return the list of entities for this page.

Specified by:

getList in interface Page<T>

hasNext

public boolean hasNext()

Description copied from interface: Page

Return true if there is a next page.

Specified by:

hasNext in interface Page<T>

hasPrev

public boolean hasPrev()

Description copied from interface: Page

Return true if there is a previous page.

Specified by:

hasPrev in interface Page<T>

next

public Page<T> next()

Description copied from interface: Page

Return the next page.

Specified by:

next in interface Page<T>

prev

public Page<T> prev()

Description copied from interface: Page

Return the previous page.

Specified by:

prev in interface Page<T>

getPageIndex

public int getPageIndex()

Description copied from interface: Page

Return the index position of this page.

Specified by:

getPageIndex in interface Page<T>

getTotalPageCount

public int getTotalPageCount()

Description copied from interface: Page

Return the total number of pages.

Specified by:

getTotalPageCount in interface Page<T>

getTotalRowCount

public int getTotalRowCount()

Description copied from interface: Page

Return the total row count for all pages.

Specified by:

getTotalRowCount in interface Page<T>

getDisplayXtoYofZ

public String getDisplayXtoYofZ(String to,
                       String of)

Description copied from interface: Page

Helper method to return a "X to Y of Z" string for this page where X is the first row, Y the last row and Z the total row count.

Specified by:

getDisplayXtoYofZ in interface Page<T>

Parameters:

to - String to put between the first and last row

of - String to put between the last row and the total row count

Returns:

String of the format XtoYofZ.