org.nuxeo.ecm.platform.query.nxql

Class CoreQueryDocumentPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

Direct Known Subclasses:

CaseDocumentPageProvider

public class CoreQueryDocumentPageProvider
extends AbstractPageProvider<DocumentModel>

Page provider performing a query on a core session.

It builds the query at each call so that it can refresh itself when the query changes.

TODO: describe needed properties

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_QUERY_CACHE_PROPERTY
static String	CORE_SESSION_PROPERTY

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

DEFAULT_MAX_PAGE_SIZE, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
CoreQueryDocumentPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<DocumentModel>	getCurrentPage() Returns the current page of results.
String	getCurrentQuery()
PageSelections<DocumentModel>	getCurrentSelectPage() Returns the current page of results wrapped in a PageSelection item.
void	refresh() Forces refresh of the current page.

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

addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, 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

Field Detail

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

CHECK_QUERY_CACHE_PROPERTY

public static final String CHECK_QUERY_CACHE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CoreQueryDocumentPageProvider

public CoreQueryDocumentPageProvider()

Method Detail

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

getCurrentSelectPage

public PageSelections<DocumentModel> getCurrentSelectPage()

Description copied from interface: PageProvider

Returns the current page of results wrapped in a PageSelection item.

By default, no entry is selected, unless PageProvider.setSelectedEntries(List) has been called before.

Specified by:

getCurrentSelectPage in interface PageProvider<DocumentModel>

Overrides:

getCurrentSelectPage in class AbstractPageProvider<DocumentModel>

getCurrentQuery

public String getCurrentQuery()

refresh

public void refresh()

Description copied from interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<DocumentModel>

Overrides:

refresh in class AbstractPageProvider<DocumentModel>