org.nuxeo.ecm.platform.query.core

Class DocumentModelListPageProvider

java.lang.Object

org.nuxeo.ecm.platform.query.api.AbstractPageProvider<DocumentModel>

org.nuxeo.ecm.platform.query.core.DocumentModelListPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class DocumentModelListPageProvider
extends AbstractPageProvider<DocumentModel>

Wraps a DocumentModelList inside a PageProvider.

This page provider does not handle pagination at all, there is only one page with all the documents.

Since:

5.6

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

log

Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, PAGE_LIMIT_UNKNOWN, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
DocumentModelListPageProvider()
DocumentModelListPageProvider(DocumentModelList docs)

Method Summary

Methods

Modifier and Type	Method and Description
List<DocumentModel>	getCurrentPage() Returns the current page of results.
long	getCurrentPageSize() Returns the number of elements in current page.
DocumentModelList	getDocumentModelList()
long	getNumberOfPages() Returns the total number of pages or 0 if number of pages is unknown.
long	getPageSize() Returns the number of results per page.
long	getResultsCount() Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.5, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.
void	setDocumentModelList(List<DocumentModel> docs)

Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getPageLimit, getParameters, getProperties, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, refresh, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentModelListPageProvider

public DocumentModelListPageProvider()

DocumentModelListPageProvider

public DocumentModelListPageProvider(DocumentModelList docs)

Method Detail

setDocumentModelList

public void setDocumentModelList(List<DocumentModel> docs)

getDocumentModelList

public DocumentModelList getDocumentModelList()

getCurrentPage

public List<DocumentModel> getCurrentPage()

Description copied from interface: PageProvider

Returns the current page of results.

This method is designed to be called from higher levels. It therefore ensures cheapness of repeated calls, rather than data consistency. There is a refresh() method for that.

Specified by:

getCurrentPage in interface PageProvider<DocumentModel>

Specified by:

getCurrentPage in class AbstractPageProvider<DocumentModel>

Returns:

the current page

getResultsCount

public long getResultsCount()

Description copied from interface: PageProvider

Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.5, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.

Specified by:

getResultsCount in interface PageProvider<DocumentModel>

Overrides:

getResultsCount in class AbstractPageProvider<DocumentModel>

getPageSize

public long getPageSize()

Description copied from interface: PageProvider

Returns the number of results per page. 0 means no pagination.

Specified by:

getPageSize in interface PageProvider<DocumentModel>

Overrides:

getPageSize in class AbstractPageProvider<DocumentModel>

getCurrentPageSize

public long getCurrentPageSize()

Description copied from interface: PageProvider

Returns the number of elements in current page.

Specified by:

getCurrentPageSize in interface PageProvider<DocumentModel>

Overrides:

getCurrentPageSize in class AbstractPageProvider<DocumentModel>

getNumberOfPages

public long getNumberOfPages()

Description copied from interface: PageProvider

Returns the total number of pages or 0 if number of pages is unknown.

Specified by:

getNumberOfPages in interface PageProvider<DocumentModel>

Overrides:

getNumberOfPages in class AbstractPageProvider<DocumentModel>