org.nuxeo.ecm.platform.semanticentities.service

Class CMISQLDocumentPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.semanticentities.service.CMISQLDocumentPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class CMISQLDocumentPageProvider
extends AbstractPageProvider<DocumentModel>
implements PageProvider<DocumentModel>

Simple PageProvider implementation that uses the CMISQL api to be able to perform paginated joins. The CMISQL SELECT statement is expected to select a unique attribute that is the document IdRef (a.k.a. cmis:objectId) of the result.

Author:

ogrisel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Log	log

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

DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
CMISQLDocumentPageProvider(CoreSession session, String query, String docIdColumnName, String providerName)

Method Summary

Methods

Modifier and Type	Method and Description
List<DocumentModel>	getCurrentPage() Returns the current page of results.
void	refresh() Refresh hook, to override for custom behavior

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

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

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

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

Field Detail

log

public static final Log log

Constructor Detail

CMISQLDocumentPageProvider

public CMISQLDocumentPageProvider(CoreSession session,
                          String query,
                          String docIdColumnName,
                          String providerName)
                           throws ClientException

Throws:

ClientException

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

refresh

public void refresh()

Description copied from class: AbstractPageProvider

Refresh hook, to override for custom behavior

When overriding it, call super.refresh() as last statement to make sure that the PageProviderChangedListener is called with the up-to-date @{code PageProvider} state.

Specified by:

refresh in interface PageProvider<DocumentModel>

Overrides:

refresh in class AbstractPageProvider<DocumentModel>