org.exoplatform.commons.utils
Class PageList<E>

java.lang.Object
  org.exoplatform.commons.utils.PageList<E>

Direct Known Subclasses:

LazyPageList, ObjectPageList

Deprecated.

public abstract class PageList<E>
extends Object

Subclasses of this object should be replaced by the subclass and an implementation of the ListAccess interface.

Since:

Oct 21, 2004

Version:

$Id: PageList.java,v 1.2 2004/10/25 03:36:58 tuan08 Exp $

Author:

Tuan Nguyen (tuan08@users.sourceforge.net)

Field Summary

protected int	available_ Deprecated.
protected int	availablePage_ Deprecated.
protected List<E>	currentListPage_ Deprecated.
protected int	currentPage_ Deprecated.
static PageList	EMPTY_LIST Deprecated.

Constructor Summary

PageList(int pageSize)
Deprecated.

Method Summary

protected void	checkAndSetPage(int page) Deprecated.
List<E>	currentPage() Deprecated.
abstract List<E>	getAll() Deprecated.
int	getAvailable() Deprecated. Returns the number of available elements.
int	getAvailablePage() Deprecated. Returns the number of available pages.
int	getCurrentPage() Deprecated. Returns the current page index.
int	getFrom() Deprecated. Returns the from index.
List<E>	getPage(int page) Deprecated. Updates the current page index and retrieves the element from that page.
int	getPageSize() Deprecated. Returns the page size.
int	getTo() Deprecated. Returns the to index.
protected abstract void	populateCurrentPage(int page) Deprecated.
protected void	setAvailablePage(int available) Deprecated.
void	setPageSize(int pageSize) Deprecated. Updates the page size.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LIST

public static final PageList EMPTY_LIST

Deprecated.

available_

protected int available_

Deprecated.

availablePage_

protected int availablePage_

Deprecated.

currentPage_

protected int currentPage_

Deprecated.

currentListPage_

protected List<E> currentListPage_

Deprecated.

Constructor Detail

PageList

public PageList(int pageSize)

Deprecated.

Method Detail

getPageSize

public int getPageSize()

Deprecated.

Returns the page size.

Returns:

the page size

setPageSize

public void setPageSize(int pageSize)

Deprecated.

Updates the page size.

Parameters:

pageSize - the new page size value

getCurrentPage

public int getCurrentPage()

Deprecated.

Returns the current page index.

Returns:

the current page

getAvailable

public int getAvailable()

Deprecated.

Returns the number of available elements.

Returns:

the available elements

getAvailablePage

public int getAvailablePage()

Deprecated.

Returns the number of available pages.

Returns:

the available pages

currentPage

public List<E> currentPage()
                    throws Exception

Deprecated.

Throws:

Exception

populateCurrentPage

protected abstract void populateCurrentPage(int page)
                                     throws Exception

Deprecated.

Throws:

Exception

getPage

public List<E> getPage(int page)
                throws Exception

Deprecated.

Updates the current page index and retrieves the element from that page.

Parameters:

page - the page index

Returns:

the list of element of the page

Throws:

Exception - an exception

getAll

public abstract List<E> getAll()
                        throws Exception

Deprecated.

Throws:

Exception

checkAndSetPage

protected void checkAndSetPage(int page)
                        throws Exception

Deprecated.

Throws:

Exception

setAvailablePage

protected void setAvailablePage(int available)

Deprecated.

getFrom

public int getFrom()

Deprecated.

Returns the from index.

Returns:

the from index

getTo

public int getTo()

Deprecated.

Returns the to index.

Returns:

the to index