org.exoplatform.services.wcm.publication

Class PaginatedResultIterator

java.lang.Object

org.exoplatform.commons.utils.PageList

org.exoplatform.services.wcm.publication.PaginatedResultIterator

Direct Known Subclasses:

NodeLocationPaginatedResultIterator

public class PaginatedResultIterator
extends org.exoplatform.commons.utils.PageList

Created by The eXo Platform SAS Author : Hoa Pham hoa.phamvu@exoplatform.com Oct 17, 2008

Field Summary

Fields

Modifier and Type	Field and Description
protected Result	result The nodes.

Fields inherited from class org.exoplatform.commons.utils.PageList

available_, availablePage_, currentListPage_, currentPage_, EMPTY_LIST

Constructor Summary

Constructors

Constructor and Description
PaginatedResultIterator(int pageSize) Instantiates a new paginated node iterator.
PaginatedResultIterator(Result result, int pageSize)

Method Summary

Modifier and Type	Method and Description
void	changePage(int page) Change page.
List	getAll()
List	getCurrentPageData() Retrieve the nodes of current page.
int	getNodesPerPage() Retrieve the nodes per page.
List	getPage(int page)
long	getTotalNodes() Retrieve the total nodes.
int	getTotalPages() Retrieve the total pages.
protected void	populateCurrentPage(int page)

Methods inherited from class org.exoplatform.commons.utils.PageList

checkAndSetPage, currentPage, getAvailable, getAvailablePage, getCurrentPage, getFrom, getPageSize, getTo, setAvailablePage, setPageSize

Methods inherited from class java.lang.Object

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

Field Detail

result

protected Result result

The nodes.

Constructor Detail

PaginatedResultIterator

public PaginatedResultIterator(int pageSize)

Instantiates a new paginated node iterator.

Parameters:

pageSize - the page size

PaginatedResultIterator

public PaginatedResultIterator(Result result,
                               int pageSize)

Method Detail

populateCurrentPage

protected void populateCurrentPage(int page)
                            throws Exception

Specified by:

populateCurrentPage in class org.exoplatform.commons.utils.PageList

Throws:

Exception

getTotalPages

public int getTotalPages()

Retrieve the total pages.

Returns:

the total pages

getNodesPerPage

public int getNodesPerPage()

Retrieve the nodes per page.

Returns:

the nodes per page

getTotalNodes

public long getTotalNodes()

Retrieve the total nodes.

Returns:

the total nodes

getCurrentPageData

public List getCurrentPageData()
                        throws Exception

Retrieve the nodes of current page.

Returns:

the current page data

Throws:

Exception - the exception

getPage

public List getPage(int page)
             throws Exception

Overrides:

getPage in class org.exoplatform.commons.utils.PageList

Throws:

Exception

changePage

public void changePage(int page)
                throws Exception

Change page.

Parameters:

page - the page

Throws:

Exception - the exception

getAll

public List getAll()
            throws Exception

Specified by:

getAll in class org.exoplatform.commons.utils.PageList

Throws:

Exception