org.nuxeo.elasticsearch.provider

Class ElasticSearchNxqlPageProvider

java.lang.Object

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

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

org.nuxeo.elasticsearch.provider.ElasticSearchNxqlPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class ElasticSearchNxqlPageProvider
extends CoreQueryDocumentPageProvider

Elasticsearch Page provider that converts the NXQL query build by CoreQueryDocumentPageProvider.

Since:

5.9.3

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider

CHECK_QUERY_CACHE_PROPERTY, DEFAULT_NAVIGATION_RESULTS_KEY, DEFAULT_NAVIGATION_RESULTS_PROPERTY, DEFAULT_NAVIGATION_RESULTS_VALUE, DETACH_DOCUMENTS_PROPERTY, MAX_RESULTS_PROPERTY, PAGE_SIZE_RESULTS_KEY, USE_UNRESTRICTED_SESSION_PROPERTY

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
ElasticSearchNxqlPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Aggregate>	getAggregates()
List<DocumentModel>	getCurrentPage() Returns the list of current page items.
org.elasticsearch.index.query.QueryBuilder	getCurrentQueryAsEsBuilder()
boolean	hasAggregateSupport()
void	refresh() Refresh hook, to override for custom behavior

Methods inherited from class org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider

getCurrentQuery, getCurrentSelectPage, getMaxResults, getPageLimit, setMaxResults

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

addSortInfo, firstPage, getAggregateDefinitions, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, 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, setCurrentPageIndex, 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

Field Detail

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

SEARCH_ON_ALL_REPOSITORIES_PROPERTY

public static final String SEARCH_ON_ALL_REPOSITORIES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

ElasticSearchNxqlPageProvider

public ElasticSearchNxqlPageProvider()

Method Detail

getCurrentPage

public List<DocumentModel> 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<DocumentModel>

Overrides:

getCurrentPage in class CoreQueryDocumentPageProvider

Returns:

the current page

getCurrentQueryAsEsBuilder

public org.elasticsearch.index.query.QueryBuilder getCurrentQueryAsEsBuilder()

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 CoreQueryDocumentPageProvider

hasAggregateSupport

public boolean hasAggregateSupport()

Specified by:

hasAggregateSupport in interface PageProvider<DocumentModel>

Overrides:

hasAggregateSupport in class AbstractPageProvider<DocumentModel>

getAggregates

public Map<String,Aggregate> getAggregates()

Specified by:

getAggregates in interface PageProvider<DocumentModel>

Overrides:

getAggregates in class AbstractPageProvider<DocumentModel>