Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class CompoundRetrieverBuilder<T extends CompoundRetrieverBuilder<T>>

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

org.elasticsearch.search.retriever.CompoundRetrieverBuilder<T>

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

Direct Known Subclasses:

RescorerRetrieverBuilder

public abstract class CompoundRetrieverBuilder<T extends CompoundRetrieverBuilder<T>>
extends RetrieverBuilder

This abstract retriever defines a compound retriever. The idea is that it is not a leaf-retriever, i.e. it does not perform actual searches itself. Instead, it is a container for a set of child retrievers and is responsible for combining the results of the child retrievers according to the implementation of combineQueryPhaseResults.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CompoundRetrieverBuilder.RetrieverSource

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final NodeFeature	INNER_RETRIEVERS_FILTER_SUPPORT
protected final List<CompoundRetrieverBuilder.RetrieverSource>	innerRetrievers
static final ParseField	RANK_WINDOW_SIZE_FIELD
protected final int	rankWindowSize

Fields inherited from class org.elasticsearch.search.retriever.RetrieverBuilder

MIN_SCORE_FIELD, minScore, NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, rankDocs, retrieverName, RETRIEVERS_SUPPORTED

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompoundRetrieverBuilder(List<CompoundRetrieverBuilder.RetrieverSource> innerRetrievers, int rankWindowSize)

Method Summary

Modifier and Type	Method	Description
T	addChild(RetrieverBuilder retrieverBuilder)
protected abstract T	clone(List<CompoundRetrieverBuilder.RetrieverSource> newChildRetrievers, List<QueryBuilder> newPreFilterQueryBuilders)	Returns a clone of the original retriever, replacing the sub-retrievers with the provided newChildRetrievers and the filters with the newPreFilterQueryBuilders.
protected abstract RankDoc[]	combineInnerRetrieverResults(List<org.apache.lucene.search.ScoreDoc[]> rankResults, boolean explain)	Combines the provided rankResults to return the final top documents.
protected final SearchSourceBuilder	createSearchSourceBuilder(PointInTimeBuilder pit, RetrieverBuilder retrieverBuilder)
boolean	doEquals(Object o)
int	doHashCode()
final QueryBuilder	explainQuery()
final void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)	This method is called at the end of rewriting on behalf of a SearchSourceBuilder.
protected SearchSourceBuilder	finalizeSourceBuilder(SearchSourceBuilder sourceBuilder)
ParseField	getRankWindowSizeField()	Retrieves the ParseField used to configure the rankWindowSize at the REST layer.
final boolean	isCompound()	Determines if this retriever contains sub-retrievers that need to be executed prior to search.
final RetrieverBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
final QueryBuilder	topDocsQuery()	This function is called by compound RetrieverBuilder to return the original query that was used by this retriever to compute its top documents.
ActionRequestValidationException	validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults)

Methods inherited from class org.elasticsearch.search.retriever.RetrieverBuilder

declareBaseParserFields, doToXContent, equals, getName, getPreFilterQueryBuilders, getRankDocs, hashCode, isFragment, minScore, minScore, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, retrieverName, retrieverName, rewritePreFilters, setRankDocs, toString, toXContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INNER_RETRIEVERS_FILTER_SUPPORT

public static final NodeFeature INNER_RETRIEVERS_FILTER_SUPPORT

RANK_WINDOW_SIZE_FIELD

public static final ParseField RANK_WINDOW_SIZE_FIELD

rankWindowSize

protected final int rankWindowSize

innerRetrievers

protected final List<CompoundRetrieverBuilder.RetrieverSource> innerRetrievers

Constructor Details

CompoundRetrieverBuilder

protected CompoundRetrieverBuilder(List<CompoundRetrieverBuilder.RetrieverSource> innerRetrievers,
 int rankWindowSize)

Method Details

addChild

public T addChild(RetrieverBuilder retrieverBuilder)

clone

protected abstract T clone(List<CompoundRetrieverBuilder.RetrieverSource> newChildRetrievers,
 List<QueryBuilder> newPreFilterQueryBuilders)

Returns a clone of the original retriever, replacing the sub-retrievers with the provided newChildRetrievers and the filters with the newPreFilterQueryBuilders.

combineInnerRetrieverResults

protected abstract RankDoc[] combineInnerRetrieverResults(List<org.apache.lucene.search.ScoreDoc[]> rankResults,
 boolean explain)

Combines the provided rankResults to return the final top documents.

isCompound

public final boolean isCompound()

Description copied from class: RetrieverBuilder

Determines if this retriever contains sub-retrievers that need to be executed prior to search.

Overrides:

isCompound in class RetrieverBuilder

getRankWindowSizeField

public ParseField getRankWindowSizeField()

Retrieves the ParseField used to configure the rankWindowSize at the REST layer.

rewrite

public final RetrieverBuilder rewrite(QueryRewriteContext ctx)
                               throws IOException

Description copied from interface: Rewriteable

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Specified by:

rewrite in interface Rewriteable<T extends CompoundRetrieverBuilder<T>>

Overrides:

rewrite in class RetrieverBuilder

Throws:

IOException

topDocsQuery

public final QueryBuilder topDocsQuery()

Description copied from class: RetrieverBuilder

This function is called by compound RetrieverBuilder to return the original query that was used by this retriever to compute its top documents.

Specified by:

topDocsQuery in class RetrieverBuilder

explainQuery

public final QueryBuilder explainQuery()

Overrides:

explainQuery in class RetrieverBuilder

extractToSearchSourceBuilder

public final void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder,
 boolean compoundUsed)

Description copied from class: RetrieverBuilder

This method is called at the end of rewriting on behalf of a SearchSourceBuilder. Elements from retrievers are expected to be "extracted" into the SearchSourceBuilder.

Specified by:

extractToSearchSourceBuilder in class RetrieverBuilder

validate

public ActionRequestValidationException validate(SearchSourceBuilder source,
 ActionRequestValidationException validationException,
 boolean isScroll,
 boolean allowPartialSearchResults)

Overrides:

validate in class RetrieverBuilder

doEquals

public boolean doEquals(Object o)

Specified by:

doEquals in class RetrieverBuilder

doHashCode

public int doHashCode()

Specified by:

doHashCode in class RetrieverBuilder

createSearchSourceBuilder

protected final SearchSourceBuilder createSearchSourceBuilder(PointInTimeBuilder pit,
 RetrieverBuilder retrieverBuilder)

finalizeSourceBuilder

protected SearchSourceBuilder finalizeSourceBuilder(SearchSourceBuilder sourceBuilder)