org.nuxeo.ecm.platform.query.api

Class AbstractPageProvider<T>

java.lang.Object

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

All Implemented Interfaces:

Serializable, PageProvider<T>

Direct Known Subclasses:

AbstractActivityPageProvider, AbstractGroupsPageProvider, AbstractUsersPageProvider, AuditPageProvider, ClassifiedPageProvider, CoreQueryAndFetchPageProvider, CoreQueryDocumentPageProvider, DocumentModelListPageProvider, EmptyPageProvider, PreviousRoutesPageProvider, UserRelationshipPageProvider, UserTaskPageProvider, VFolderPageProvider

public abstract class AbstractPageProvider<T>
extends Object
implements PageProvider<T>

Basic implementation for a PageProvider

Author:

Anahide Tchertchian

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, PAGE_LIMIT_UNKNOWN, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
AbstractPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSortInfo(String sortColumn, boolean sortAscending) Add the given sort info to the list of sorting infos.
void	firstPage() Go to the first page
T	getCurrentEntry() Returns the current entry.
int	getCurrentHigherNonEmptyPageIndex() Returns an integer keeping track of the higher page index giving results.
abstract List<T>	getCurrentPage() Returns the current page of results.
long	getCurrentPageIndex() Returns the current page index as a zero-based integer.
long	getCurrentPageOffset() Returns the offset (starting from 0) of the first element in the current page or UNKNOWN_SIZE.
long	getCurrentPageSize() Returns the number of elements in current page.
String	getCurrentPageStatus() Returns a simple formatted string for current pagination status.
PageSelections<T>	getCurrentSelectPage() Returns the current page of results wrapped in a PageSelection item.
PageProviderDefinition	getDefinition()
Throwable	getError()
String	getErrorMessage()
int	getMaxNumberOfEmptyPages() Returns the maximum number of empty pages that can be fetched empty (defaults to 1).
long	getMaxPageSize() Returns the max number of results per page.
long	getMinMaxPageSize() Returns the minimal value for the max page size, taking the lower value between the requested page size and the maximum accepted page size.
String	getName() Returns the provider identifier
long	getNumberOfPages() Returns the total number of pages or 0 if number of pages is unknown.
long	getPageLimit() Returns the page limit.
long	getPageSize() Returns the number of results per page.
Object[]	getParameters()
Map<String,Serializable>	getProperties() Gets properties set on the provider.
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.
DocumentModel	getSearchDocumentModel()
SortInfo	getSortInfo() Returns the first sorting info for this provider
int	getSortInfoIndex(String sortColumn, boolean sortAscending) Returns a positive 0-based integer if given sort information is found on the set sort infos, indicating the sort index, or -1 if this sort information is not found.
List<SortInfo>	getSortInfos() Returns the complete list of sorting info for this provider
boolean	hasChangedParameters(Object[] parameters) Test if provider parameters have changed
boolean	hasError()
boolean	isLastPageAvailable() Returns a boolean expressing if the last page can be displayed.
boolean	isNextEntryAvailable() Returns true if there is a next entry.
boolean	isNextPageAvailable() Returns a boolean expressing if there are further pages.
boolean	isPreviousEntryAvailable() Returns true if there is a previous entry.
boolean	isPreviousPageAvailable() Returns a boolean expressing if there is a previous page.
boolean	isSortable() Returns if this provider is sortable
void	last() Deprecated.
void	lastPage() Go to the last page.
void	next() Deprecated.
void	nextEntry() Move the current entry to the next one, if applicable.
void	nextPage() Go to the next page
void	previous() Deprecated.
void	previousEntry() Move the current entry to the previous one, if applicable.
void	previousPage() Go to the previous page
void	refresh() Refresh hook, to override for custom behavior
void	rewind() Deprecated.
void	setCurrentEntry(T entry) Sets the current entry.
void	setCurrentEntryIndex(long index) Sets the current entry index.
void	setCurrentHigherNonEmptyPageIndex(int higherFilledPageIndex)
List<T>	setCurrentPage(long page) Sets the current page of results to the required one and return it.
void	setCurrentPageIndex(long currentPageIndex) Sets the current page of results to the required one.
void	setCurrentPageOffset(long offset) Sets the current page offset.
void	setDefinition(PageProviderDefinition providerDefinition)
void	setMaxPageSize(long maxPageSize) Sets the max number of results per page.
void	setName(String name) Sets the provider identifier
void	setPageProviderChangedListener(PageProviderChangedListener listener) Sets the PageProviderChangedListener for this PageProvider.
void	setPageSize(long pageSize) Sets the number results per page.
void	setParameters(Object[] parameters)
void	setProperties(Map<String,Serializable> properties) Sets properties set on the provider.
void	setResultsCount(long resultsCount) Sets the results count.
void	setSearchDocumentModel(DocumentModel searchDocumentModel)
void	setSelectedEntries(List<T> entries) Sets the list of selected entries to take into account in PageProvider.getCurrentSelectPage().
void	setSortable(boolean sortable)
void	setSortInfo(SortInfo sortInfo) Sets the first and only sorting info for this provider.
void	setSortInfo(String sortColumn, boolean sortAscending, boolean removeOtherSortInfos) Sets the first and only sorting info for this provider if parameter removeOtherSortInfos is true.
void	setSortInfos(List<SortInfo> sortInfo) Sets the complete list of sorting info for this provider

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Log log

Constructor Detail

AbstractPageProvider

public AbstractPageProvider()

Method Detail

getCurrentPage

public abstract List<T> 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<T>

Returns:

the current page

firstPage

public void firstPage()

Description copied from interface: PageProvider

Go to the first page

Specified by:

firstPage in interface PageProvider<T>

rewind

@Deprecated
public void rewind()

Deprecated.

getCurrentPageIndex

public long getCurrentPageIndex()

Description copied from interface: PageProvider

Returns the current page index as a zero-based integer.

Specified by:

getCurrentPageIndex in interface PageProvider<T>

getCurrentPageOffset

public long getCurrentPageOffset()

Description copied from interface: PageProvider

Returns the offset (starting from 0) of the first element in the current page or UNKNOWN_SIZE.

Specified by:

getCurrentPageOffset in interface PageProvider<T>

setCurrentPageOffset

public void setCurrentPageOffset(long offset)

Description copied from interface: PageProvider

Sets the current page offset.

If the provider keeps information linked to the current page, they should be reset after calling this method.

Specified by:

setCurrentPageOffset in interface PageProvider<T>

getCurrentPageSize

public long getCurrentPageSize()

Description copied from interface: PageProvider

Returns the number of elements in current page.

Specified by:

getCurrentPageSize in interface PageProvider<T>

getName

public String getName()

Description copied from interface: PageProvider

Returns the provider identifier

Specified by:

getName in interface PageProvider<T>

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<T>

setCurrentPageIndex

public void setCurrentPageIndex(long currentPageIndex)

Description copied from interface: PageProvider

Sets the current page of results to the required one.

Specified by:

setCurrentPageIndex in interface PageProvider<T>

Parameters:

currentPageIndex - the page index, starting from 0

setCurrentPage

public List<T> setCurrentPage(long page)

Description copied from interface: PageProvider

Sets the current page of results to the required one and return it.

Specified by:

setCurrentPage in interface PageProvider<T>

Parameters:

page - the page index, starting from 0

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<T>

setPageSize

public void setPageSize(long pageSize)

Description copied from interface: PageProvider

Sets the number results per page. 0 means no pagination.

Specified by:

setPageSize in interface PageProvider<T>

getSortInfos

public List<SortInfo> getSortInfos()

Description copied from interface: PageProvider

Returns the complete list of sorting info for this provider

Specified by:

getSortInfos in interface PageProvider<T>

getSortInfo

public SortInfo getSortInfo()

Description copied from interface: PageProvider

Returns the first sorting info for this provider

Also kept for compatibility with existing code.

Specified by:

getSortInfo in interface PageProvider<T>

setSortInfos

public void setSortInfos(List<SortInfo> sortInfo)

Description copied from interface: PageProvider

Sets the complete list of sorting info for this provider

Specified by:

setSortInfos in interface PageProvider<T>

setSortInfo

public void setSortInfo(SortInfo sortInfo)

Description copied from interface: PageProvider

Sets the first and only sorting info for this provider.

Also kept for compatibility with existing code.

Specified by:

setSortInfo in interface PageProvider<T>

setSortInfo

public void setSortInfo(String sortColumn,
               boolean sortAscending,
               boolean removeOtherSortInfos)

Description copied from interface: PageProvider

Sets the first and only sorting info for this provider if parameter removeOtherSortInfos is true. Otherwise, adds or changes the sortAscending information according to given direction.

Specified by:

setSortInfo in interface PageProvider<T>

addSortInfo

public void addSortInfo(String sortColumn,
               boolean sortAscending)

Description copied from interface: PageProvider

Add the given sort info to the list of sorting infos.

Specified by:

addSortInfo in interface PageProvider<T>

getSortInfoIndex

public int getSortInfoIndex(String sortColumn,
                   boolean sortAscending)

Description copied from interface: PageProvider

Returns a positive 0-based integer if given sort information is found on the set sort infos, indicating the sort index, or -1 if this sort information is not found.

Specified by:

getSortInfoIndex in interface PageProvider<T>

isNextPageAvailable

public boolean isNextPageAvailable()

Description copied from interface: PageProvider

Returns a boolean expressing if there are further pages.

Specified by:

isNextPageAvailable in interface PageProvider<T>

isLastPageAvailable

public boolean isLastPageAvailable()

Description copied from interface: PageProvider

Returns a boolean expressing if the last page can be displayed.

Specified by:

isLastPageAvailable in interface PageProvider<T>

isPreviousPageAvailable

public boolean isPreviousPageAvailable()

Description copied from interface: PageProvider

Returns a boolean expressing if there is a previous page.

Specified by:

isPreviousPageAvailable in interface PageProvider<T>

lastPage

public void lastPage()

Description copied from interface: PageProvider

Go to the last page. Does not do anything if there is only one page displayed, or if the number of results is unknown.

Specified by:

lastPage in interface PageProvider<T>

last

@Deprecated
public void last()

Deprecated.

nextPage

public void nextPage()

Description copied from interface: PageProvider

Go to the next page

Specified by:

nextPage in interface PageProvider<T>

next

@Deprecated
public void next()

Deprecated.

previousPage

public void previousPage()

Description copied from interface: PageProvider

Go to the previous page

Specified by:

previousPage in interface PageProvider<T>

previous

@Deprecated
public void previous()

Deprecated.

refresh

public void refresh()

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<T>

setName

public void setName(String name)

Description copied from interface: PageProvider

Sets the provider identifier

Specified by:

setName in interface PageProvider<T>

getCurrentPageStatus

public String getCurrentPageStatus()

Description copied from interface: PageProvider

Returns a simple formatted string for current pagination status.

Specified by:

getCurrentPageStatus in interface PageProvider<T>

isNextEntryAvailable

public boolean isNextEntryAvailable()

Description copied from interface: PageProvider

Returns true if there is a next entry.

The next entry might be in next page, except if results count is unknown.

Specified by:

isNextEntryAvailable in interface PageProvider<T>

isPreviousEntryAvailable

public boolean isPreviousEntryAvailable()

Description copied from interface: PageProvider

Returns true if there is a previous entry.

The previous entry might be in previous page.

Specified by:

isPreviousEntryAvailable in interface PageProvider<T>

nextEntry

public void nextEntry()

Description copied from interface: PageProvider

Move the current entry to the next one, if applicable.

If needed and possible, the provider will forward to next page. No special exceptions: this method is intended to be plugged directly at the UI layer. In case there's no next entry, nothing happens.

Specified by:

nextEntry in interface PageProvider<T>

previousEntry

public void previousEntry()

Description copied from interface: PageProvider

Move the current entry to the previous one, if applicable.

No exception: this method is intended to be plugged directly at the UI layer. In case there's no previous entry, nothing will happen.

Specified by:

previousEntry in interface PageProvider<T>

getCurrentEntry

public T getCurrentEntry()

Description copied from interface: PageProvider

Returns the current entry.

Specified by:

getCurrentEntry in interface PageProvider<T>

setCurrentEntry

public void setCurrentEntry(T entry)
                     throws ClientException

Description copied from interface: PageProvider

Sets the current entry.

Specified by:

setCurrentEntry in interface PageProvider<T>

Throws:

ClientException - if entry is not found within current page.

setCurrentEntryIndex

public void setCurrentEntryIndex(long index)
                          throws ClientException

Description copied from interface: PageProvider

Sets the current entry index.

Specified by:

setCurrentEntryIndex in interface PageProvider<T>

Throws:

ClientException - if index is not found within 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<T>

getProperties

public Map<String,Serializable> getProperties()

Description copied from interface: PageProvider

Gets properties set on the provider.

Useful to retrieve a provider specific field attributes after instantiation. Other contextual parameters can be passed through API constructing the result provider.

Specified by:

getProperties in interface PageProvider<T>

setProperties

public void setProperties(Map<String,Serializable> properties)

Description copied from interface: PageProvider

Sets properties set on the provider.

Useful to initialize a provider specific field attributes after instantiation. Other contextual parameters can be passed through API constructing the result provider.

Specified by:

setProperties in interface PageProvider<T>

setResultsCount

public void setResultsCount(long resultsCount)

Description copied from interface: PageProvider

Sets the results count.

Specified by:

setResultsCount in interface PageProvider<T>

setSortable

public void setSortable(boolean sortable)

Specified by:

setSortable in interface PageProvider<T>

isSortable

public boolean isSortable()

Description copied from interface: PageProvider

Returns if this provider is sortable

Specified by:

isSortable in interface PageProvider<T>

getCurrentSelectPage

public PageSelections<T> 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<T>

setSelectedEntries

public void setSelectedEntries(List<T> entries)

Description copied from interface: PageProvider

Sets the list of selected entries to take into account in PageProvider.getCurrentSelectPage().

Specified by:

setSelectedEntries in interface PageProvider<T>

getParameters

public Object[] getParameters()

Specified by:

getParameters in interface PageProvider<T>

setParameters

public void setParameters(Object[] parameters)

Specified by:

setParameters in interface PageProvider<T>

getSearchDocumentModel

public DocumentModel getSearchDocumentModel()

Specified by:

getSearchDocumentModel in interface PageProvider<T>

setSearchDocumentModel

public void setSearchDocumentModel(DocumentModel searchDocumentModel)

Specified by:

setSearchDocumentModel in interface PageProvider<T>

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface PageProvider<T>

getError

public Throwable getError()

Specified by:

getError in interface PageProvider<T>

hasError

public boolean hasError()

Specified by:

hasError in interface PageProvider<T>

getDefinition

public PageProviderDefinition getDefinition()

Specified by:

getDefinition in interface PageProvider<T>

setDefinition

public void setDefinition(PageProviderDefinition providerDefinition)

Specified by:

setDefinition in interface PageProvider<T>

getMaxPageSize

public long getMaxPageSize()

Description copied from interface: PageProvider

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

If page size is greater than this maximum value, it will be taken into account instead.

Specified by:

getMaxPageSize in interface PageProvider<T>

setMaxPageSize

public void setMaxPageSize(long maxPageSize)

Description copied from interface: PageProvider

Sets the max number of results per page. 0 means no pagination.

If page size is greater than this maximum value, it will be taken into account instead.

Specified by:

setMaxPageSize in interface PageProvider<T>

getMinMaxPageSize

public long getMinMaxPageSize()

Returns the minimal value for the max page size, taking the lower value between the requested page size and the maximum accepted page size.

Since:

5.4.2

getCurrentHigherNonEmptyPageIndex

public int getCurrentHigherNonEmptyPageIndex()

Returns an integer keeping track of the higher page index giving results. Useful for enabling or disabling the nextPage action when number of results cannot be known.

Since:

5.5

getPageLimit

public long getPageLimit()

Returns the page limit. The n first page we know they exist.

Specified by:

getPageLimit in interface PageProvider<T>

Since:

5.8

setCurrentHigherNonEmptyPageIndex

public void setCurrentHigherNonEmptyPageIndex(int higherFilledPageIndex)

getMaxNumberOfEmptyPages

public int getMaxNumberOfEmptyPages()

Returns the maximum number of empty pages that can be fetched empty (defaults to 1). Can be useful for displaying pages of a provider without results count.

Since:

5.5

setPageProviderChangedListener

public void setPageProviderChangedListener(PageProviderChangedListener listener)

Description copied from interface: PageProvider

Sets the PageProviderChangedListener for this PageProvider.

Specified by:

setPageProviderChangedListener in interface PageProvider<T>

hasChangedParameters

public boolean hasChangedParameters(Object[] parameters)

Description copied from interface: PageProvider

Test if provider parameters have changed

Specified by:

hasChangedParameters in interface PageProvider<T>