Package org.nuxeo.ecm.core.search

Class SearchResponseImpl

java.lang.Object

org.nuxeo.ecm.core.search.SearchResponseImpl

All Implemented Interfaces:

SearchResponse

public class SearchResponseImpl
extends Object
implements SearchResponse

Since:

2025.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponseImpl.Builder
static final record	SearchResponseImpl.Error

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Aggregate<? extends Bucket>>	aggregates
protected final List<SearchHit>	hits
protected final List<SearchClient.Capability>	missingCapabilities
protected final SearchScrollContext	scrollContext
protected static final String	SELECT_DOCUMENTS_IN
protected final long	total
protected final boolean	totalAccurate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchResponseImpl(SearchResponseImpl.Builder builder)

Method Summary

Modifier and Type	Method	Description
List<Aggregate<? extends Bucket>>	getAggregates()	Returns the aggregates.
List<SearchHit>	getHits()	Returns the search hits.
IterableQueryResult	getHitsAsIterator()	Returns search hits as an iterator, the query must be a scroll query.
PartialList<Map<String,Serializable>>	getHitsAsMap()	Returns search hits as a partial list.
long	getHitsCount()	Returns the number of returned search hits, taking in account limits.
List<SearchClient.Capability>	getMissingCapabilities()	Returns the list of SearchClient.Capability that are missing to fully perform the SearchQuery.
SearchScrollContext	getScrollContext()	Returns a scroll context to use in SearchService.searchScroll(SearchScrollContext) to fetch the next batch of results.
long	getTotal()	Get the total number of match for the query.
boolean	isTotalAccurate()	Returns true if the total is accurate, i.e. not an estimation.
DocumentModelList	loadDocuments(CoreSession defaultSession)	Loads search hits from repository as a DocumentModelList using the provided session.
protected DocumentModelList	loadDocumentsOneByOne(CoreSession session, List<String> documentIds)
protected DocumentModelList	loadDocumentsUsingSession(CoreSession session)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.search.SearchResponse

isMissingCapabilities

Field Details

SELECT_DOCUMENTS_IN

protected static final String SELECT_DOCUMENTS_IN

See Also:

• Constant Field Values

hits

protected final List<SearchHit> hits

missingCapabilities

protected final List<SearchClient.Capability> missingCapabilities

total

protected final long total

totalAccurate

protected final boolean totalAccurate

scrollContext

@Nullable
protected final SearchScrollContext scrollContext

aggregates

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

Constructor Details

SearchResponseImpl

protected SearchResponseImpl(SearchResponseImpl.Builder builder)

Method Details

getMissingCapabilities

public List<SearchClient.Capability> getMissingCapabilities()

Description copied from interface: SearchResponse

Returns the list of SearchClient.Capability that are missing to fully perform the SearchQuery.

Specified by:

getMissingCapabilities in interface SearchResponse

getHits

public List<SearchHit> getHits()

Description copied from interface: SearchResponse

Returns the search hits.

Specified by:

getHits in interface SearchResponse

getHitsCount

public long getHitsCount()

Description copied from interface: SearchResponse

Returns the number of returned search hits, taking in account limits.

Specified by:

getHitsCount in interface SearchResponse

getHitsAsMap

public PartialList<Map<String,Serializable>> getHitsAsMap()

Description copied from interface: SearchResponse

Returns search hits as a partial list.

Specified by:

getHitsAsMap in interface SearchResponse

getHitsAsIterator

public IterableQueryResult getHitsAsIterator()

Description copied from interface: SearchResponse

Returns search hits as an iterator, the query must be a scroll query.

Specified by:

getHitsAsIterator in interface SearchResponse

getTotal

public long getTotal()

Description copied from interface: SearchResponse

Get the total number of match for the query. Limit is not taken in account.

Specified by:

getTotal in interface SearchResponse

Returns:

-1 if unknown.

isTotalAccurate

public boolean isTotalAccurate()

Description copied from interface: SearchResponse

Returns true if the total is accurate, i.e. not an estimation.

Specified by:

isTotalAccurate in interface SearchResponse

getScrollContext

@Nullable
public SearchScrollContext getScrollContext()

Description copied from interface: SearchResponse

Returns a scroll context to use in SearchService.searchScroll(SearchScrollContext) to fetch the next batch of results.

Specified by:

getScrollContext in interface SearchResponse

getAggregates

public List<Aggregate<? extends Bucket>> getAggregates()

Description copied from interface: SearchResponse

Returns the aggregates.

Specified by:

getAggregates in interface SearchResponse

loadDocuments

public DocumentModelList loadDocuments(CoreSession defaultSession)

Description copied from interface: SearchResponse

Loads search hits from repository as a DocumentModelList using the provided session. Can be an expensive operation. In the case of a multi repository search, additional sessions are created using the defaultSession principal.

Specified by:

loadDocuments in interface SearchResponse

loadDocumentsUsingSession

protected DocumentModelList loadDocumentsUsingSession(CoreSession session)

loadDocumentsOneByOne

protected DocumentModelList loadDocumentsOneByOne(CoreSession session,
 List<String> documentIds)

toString

public String toString()

Overrides:

toString in class Object