org.nuxeo.ecm.platform.usermanager.providers

Class AbstractGroupMemberPageProvider<T>

java.lang.Object

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

org.nuxeo.ecm.platform.usermanager.providers.AbstractGroupMemberPageProvider<T>

All Implemented Interfaces:

Serializable, PageProvider<T>

Direct Known Subclasses:

GroupMemberGroupsPageProvider, GroupMemberUsersPageProvider

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

Since:

8.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	currentPage
protected UserManager	userManager

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

currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, log, maxPageSize, name, offset, PAGEPROVIDER_TRACK_PROPERTY_NAME, pageProviderChangedListener, pageSize, pageSizeOptions, parameters, properties, quickFilters, resultsCount, searchDocumentModel, selectedEntries, SKIPPED_SCHEMAS_FOR_SEARCHFIELD, sortable, sortInfos, tracking

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

DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, HIGHLIGHT_CTX_DATA, PAGE_LIMIT_UNKNOWN, SKIP_AGGREGATES_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
AbstractGroupMemberPageProvider()

Method Summary

Modifier and Type	Method and Description
List<T>	getCurrentPage() Returns the list of current page items.
protected abstract T	getMember(String id)
protected abstract List<String>	getMembers(NuxeoGroup group)
long	getPageLimit() Returns the page limit.
protected UserManager	getUserManager()
boolean	isSortable() Returns if this provider is sortable
protected void	pageChanged() Page change hook, to override for custom behavior
protected static int	safeLongToInt(long l)

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

addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getHighlights, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageSize, getPageSizeOptions, getParameters, getParametersChanged, getProperties, getQuickFilters, getResultsCount, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, previousEntry, previousPage, refresh, searchDocumentModelChanged, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos, sortInfoChanged

Methods inherited from class java.lang.Object

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

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

addQuickFilter, addSortInfo, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getHighlights, getMaxPageSize, getName, getNumberOfPages, getPageSize, getPageSizeOptions, getParameters, getProperties, getQuickFilters, getResultsCount, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, lastPage, nextEntry, nextPage, previousEntry, previousPage, refresh, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Field Detail

userManager

protected UserManager userManager

currentPage

protected List<T> currentPage

Constructor Detail

AbstractGroupMemberPageProvider

public AbstractGroupMemberPageProvider()

Method Detail

safeLongToInt

protected static int safeLongToInt(long l)

getCurrentPage

public List<T> getCurrentPage()

Description copied from class: AbstractPageProvider

Returns the list of current page items.

Custom implementation can be added here, based on the page provider properties, parameters and WhereClauseDefinition on the PageProviderDefinition, as well as search document, sort information, etc...

Implementation of this method usually consists in setting a non-null value to a field caching current items, and nullifying this field by overriding AbstractPageProvider.pageChanged() and AbstractPageProvider.refresh().

Fields AbstractPageProvider.errorMessage and AbstractPageProvider.error can also be filled to provide accurate feedback in case an error occurs during the search.

When items are retrieved, a call to AbstractPageProvider.setResultsCount(long) should be made to ensure proper pagination as implemented in this abstract class. The implementation in CoreQueryAndFetchPageProvider is a good example when the total results count is known.

If for performance reasons, for instance, the number of results cannot be known, a fall-back strategy can be applied to provide the "next" button but not the "last" one, by calling AbstractPageProvider.getCurrentHigherNonEmptyPageIndex() and AbstractPageProvider.setCurrentHigherNonEmptyPageIndex(int). In this case, CoreQueryDocumentPageProvider is a good example.

Specified by:

getCurrentPage in interface PageProvider<T>

Specified by:

getCurrentPage in class AbstractPageProvider<T>

Returns:

the current page

getMembers

protected abstract List<String> getMembers(NuxeoGroup group)

getMember

protected abstract T getMember(String id)

getPageLimit

public long getPageLimit()

Description copied from class: AbstractPageProvider

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

Specified by:

getPageLimit in interface PageProvider<T>

Overrides:

getPageLimit in class AbstractPageProvider<T>

isSortable

public boolean isSortable()

Description copied from interface: PageProvider

Returns if this provider is sortable

Specified by:

isSortable in interface PageProvider<T>

Overrides:

isSortable in class AbstractPageProvider<T>

pageChanged

protected void pageChanged()

Description copied from class: AbstractPageProvider

Page change hook, to override for custom behavior

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

Overrides:

pageChanged in class AbstractPageProvider<T>

getUserManager

protected UserManager getUserManager()