org.nuxeo.ecm.platform.query.nxql
Class CoreQueryAndFetchPageProvider

java.lang.Object
  org.nuxeo.ecm.platform.query.api.AbstractPageProvider<java.util.Map<java.lang.String,java.io.Serializable>>
      org.nuxeo.ecm.platform.query.nxql.CoreQueryAndFetchPageProvider

All Implemented Interfaces:

java.io.Serializable, PageProvider<java.util.Map<java.lang.String,java.io.Serializable>>

public class CoreQueryAndFetchPageProvider
extends AbstractPageProvider<java.util.Map<java.lang.String,java.io.Serializable>>
implements PageProvider<java.util.Map<java.lang.String,java.io.Serializable>>

Page provider performing a queryAndFetch 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

static java.lang.String	CHECK_QUERY_CACHE_PROPERTY
static java.lang.String	CORE_SESSION_PROPERTY

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

UNKNOWN_SIZE

Constructor Summary

CoreQueryAndFetchPageProvider()

Method Summary

java.util.List<java.util.Map<java.lang.String,java.io.Serializable>>	getCurrentPage() Returns the current page of results.
java.lang.String	getCurrentQuery()
PageSelections<java.util.Map<java.lang.String,java.io.Serializable>>	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, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getDefinition, getError, getErrorMessage, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setDefinition, 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

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

addSortInfo, firstPage, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getDefinition, getError, getErrorMessage, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setDefinition, setName, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Field Detail

CORE_SESSION_PROPERTY

public static final java.lang.String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

CHECK_QUERY_CACHE_PROPERTY

public static final java.lang.String CHECK_QUERY_CACHE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CoreQueryAndFetchPageProvider

public CoreQueryAndFetchPageProvider()

Method Detail

getCurrentPage

public java.util.List<java.util.Map<java.lang.String,java.io.Serializable>> 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<java.util.Map<java.lang.String,java.io.Serializable>>

Specified by:

getCurrentPage in class AbstractPageProvider<java.util.Map<java.lang.String,java.io.Serializable>>

Returns:

the current page

getCurrentSelectPage

public PageSelections<java.util.Map<java.lang.String,java.io.Serializable>> 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<java.util.Map<java.lang.String,java.io.Serializable>>

Overrides:

getCurrentSelectPage in class AbstractPageProvider<java.util.Map<java.lang.String,java.io.Serializable>>

getCurrentQuery

public java.lang.String getCurrentQuery()

refresh

public void refresh()

Description copied from interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<java.util.Map<java.lang.String,java.io.Serializable>>

Overrides:

refresh in class AbstractPageProvider<java.util.Map<java.lang.String,java.io.Serializable>>