Package org.nuxeo.ecm.core.search

Class SearchQueryImpl.Builder

java.lang.Object

org.nuxeo.ecm.core.search.SearchQueryImpl.Builder

Enclosing class:

SearchQueryImpl

public static class SearchQueryImpl.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Aggregate<? extends Bucket>>	aggregates
protected static final int	DEFAULT_LIMIT
protected static final int	DEFAULT_SCROLL_SIZE
protected static final Duration	DEFAULT_SCROLL_TIMEOUT_DURATION
protected final List<String>	highlights
protected int	limit
protected final String	nxql
protected int	offset
protected final NuxeoPrincipal	principal
protected Duration	scrollKeepAlive
protected boolean	scrollSearch
protected int	scrollSize
protected List<SearchIndex>	searchIndexes
protected static final String	SELECT_ALL
protected static final String	SELECT_ALL_WHERE
protected final List<SortInfo>	sortInfos

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String nxql, NuxeoPrincipal principal)	Creates a SearchQuery builder.
protected	Builder(List<SearchIndex> searchIndexes, String nxql, NuxeoPrincipal principal)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.1, use Builder(String, NuxeoPrincipal) instead.

Method Summary

Modifier and Type	Method	Description
SearchQueryImpl.Builder	addAggregate(Aggregate<? extends Bucket> aggregate)	Asks for an aggregate.
SearchQueryImpl.Builder	addAggregates(List<Aggregate<? extends Bucket>> aggregates)	Asks for a list of aggregates.
SearchQueryImpl.Builder	addHighlight(String highlight)	Asks to extract highlights for the following fields if the client supports highlight.
SearchQueryImpl.Builder	addHighlights(List<String> highlights)	Asks to extract highlights for the following fields if the client supports highlight.
SearchQueryImpl.Builder	addSort(SortInfo sortInfo)	Adds an ordering clause.
SearchQueryImpl.Builder	addSorts(List<SortInfo> sortInfos)	Adds ordering clauses.
SearchQuery	build()	Creates the SearchQuery.
protected static String	completeQueryWithSelect(String nxql)
SearchQueryImpl.Builder	index(String indexName)	Search will be performed on this search index.
SearchQueryImpl.Builder	index(List<String> indexNames)	Search on multiple indexes to achieve multi repositories search.
SearchQueryImpl.Builder	limit(int limit)	No more than that many documents will be returned.
SearchQueryImpl.Builder	offset(int offset)	Says to skip that many documents before beginning to return documents.
SearchQueryImpl.Builder	scrollKeepAlive(Duration value)	Sets the scroll context keep alive duration, this is the maximum duration between calls of searchScroll API, which is the time to process a SearchResponse.
SearchQueryImpl.Builder	scrollSearch(boolean value)	A scroll search is for deep pagination, returning large amount of results, use SearchService.searchScroll(SearchScrollContext) to iterate.
SearchQueryImpl.Builder	scrollSize(int scrollSize)	Sets the maximum number of hits to return when using the scroll API.
SearchQueryImpl.Builder	searchIndex(List<SearchIndex> indexes)	Search on one or multiple SearchIndexes.
SearchQueryImpl.Builder	searchIndex(SearchIndex index)	Search will be performed on this search index.

Methods inherited from class java.lang.Object

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

Field Details

SELECT_ALL

protected static final String SELECT_ALL

See Also:

• Constant Field Values

SELECT_ALL_WHERE

protected static final String SELECT_ALL_WHERE

See Also:

• Constant Field Values

DEFAULT_SCROLL_TIMEOUT_DURATION

protected static final Duration DEFAULT_SCROLL_TIMEOUT_DURATION

DEFAULT_SCROLL_SIZE

protected static final int DEFAULT_SCROLL_SIZE

See Also:

• Constant Field Values

DEFAULT_LIMIT

protected static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

sortInfos

protected final List<SortInfo> sortInfos

highlights

protected final List<String> highlights

aggregates

protected final List<Aggregate<? extends Bucket>> aggregates

nxql

protected final String nxql

principal

protected final NuxeoPrincipal principal

searchIndexes

protected List<SearchIndex> searchIndexes

offset

protected int offset

limit

protected int limit

scrollSearch

protected boolean scrollSearch

scrollKeepAlive

protected Duration scrollKeepAlive

scrollSize

protected int scrollSize

Constructor Details

Builder

protected Builder(String nxql,
 NuxeoPrincipal principal)

Creates a SearchQuery builder.

Since:

2025.1

Builder

@Deprecated(since="2025.1",
            forRemoval=true)
protected Builder(List<SearchIndex> searchIndexes,
 String nxql,
 NuxeoPrincipal principal)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.1, use Builder(String, NuxeoPrincipal) instead.

Method Details

index

public SearchQueryImpl.Builder index(String indexName)

Search will be performed on this search index. Use the SearchService to find available index names for a repository.

Since:

2025.1

index

public SearchQueryImpl.Builder index(List<String> indexNames)

Search on multiple indexes to achieve multi repositories search. All indexes should belong to the same search client.

Throws:

IllegalArgumentException - If indexes belong to different search clients

Since:

2025.1

searchIndex

public SearchQueryImpl.Builder searchIndex(SearchIndex index)

Search will be performed on this search index.

Since:

2025.1

searchIndex

public SearchQueryImpl.Builder searchIndex(List<SearchIndex> indexes)

Search on one or multiple SearchIndexes.

Throws:

IllegalArgumentException - If indexes belong to different search clients

Since:

2025.1

completeQueryWithSelect

protected static String completeQueryWithSelect(String nxql)

offset

public SearchQueryImpl.Builder offset(int offset)

Says to skip that many documents before beginning to return documents. If both offset and limit appear, then offset documents are skipped before starting to count the limit documents that are returned. This has no effect on scroll search.

limit

public SearchQueryImpl.Builder limit(int limit)

No more than that many documents will be returned. This has no effect on scroll search.

scrollSearch

public SearchQueryImpl.Builder scrollSearch(boolean value)

A scroll search is for deep pagination, returning large amount of results, use SearchService.searchScroll(SearchScrollContext) to iterate.

scrollKeepAlive

public SearchQueryImpl.Builder scrollKeepAlive(Duration value)

Sets the scroll context keep alive duration, this is the maximum duration between calls of searchScroll API, which is the time to process a SearchResponse.

scrollSize

public SearchQueryImpl.Builder scrollSize(int scrollSize)

Sets the maximum number of hits to return when using the scroll API.

addSort

public SearchQueryImpl.Builder addSort(SortInfo sortInfo)

Adds an ordering clause.

addSorts

public SearchQueryImpl.Builder addSorts(List<SortInfo> sortInfos)

Adds ordering clauses.

addHighlight

public SearchQueryImpl.Builder addHighlight(String highlight)

Asks to extract highlights for the following fields if the client supports highlight.

addHighlights

public SearchQueryImpl.Builder addHighlights(List<String> highlights)

Asks to extract highlights for the following fields if the client supports highlight.

addAggregate

public SearchQueryImpl.Builder addAggregate(Aggregate<? extends Bucket> aggregate)

Asks for an aggregate.

addAggregates

public SearchQueryImpl.Builder addAggregates(List<Aggregate<? extends Bucket>> aggregates)

Asks for a list of aggregates.

build

public SearchQuery build()

Creates the SearchQuery.