Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class RescorerRetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

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

org.elasticsearch.search.retriever.RescorerRetrieverBuilder

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

public final class RescorerRetrieverBuilder
extends CompoundRetrieverBuilder<RescorerRetrieverBuilder>

A CompoundRetrieverBuilder that re-scores only the results produced by its child retriever.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.retriever.CompoundRetrieverBuilder

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 String	NAME
static final ConstructingObjectParser<RescorerRetrieverBuilder,RetrieverParserContext>	PARSER
static final ParseField	RETRIEVER_FIELD

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

INNER_RETRIEVERS_FILTER_SUPPORT, innerRetrievers, RANK_WINDOW_SIZE_FIELD, 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

Constructor	Description
RescorerRetrieverBuilder(RetrieverBuilder retriever, List<RescorerBuilder<?>> rescorers)

Method Summary

Modifier and Type	Method	Description
protected RescorerRetrieverBuilder	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 RankDoc[]	combineInnerRetrieverResults(List<org.apache.lucene.search.ScoreDoc[]> rankResults, boolean explain)	Combines the provided rankResults to return the final top documents.
boolean	doEquals(Object o)
int	doHashCode()
void	doToXContent(XContentBuilder builder, ToXContent.Params params)
protected SearchSourceBuilder	finalizeSourceBuilder(SearchSourceBuilder source)
static RescorerRetrieverBuilder	fromXContent(XContentParser parser, RetrieverParserContext context)
String	getName()
ParseField	getRankWindowSizeField()	Retrieves the ParseField used to configure the CompoundRetrieverBuilder.rankWindowSize at the REST layer.

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

addChild, createSearchSourceBuilder, explainQuery, extractToSearchSourceBuilder, isCompound, rankWindowSize, rewrite, topDocsQuery, validate

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

declareBaseParserFields, equals, 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

NAME

public static final String NAME

See Also:

• Constant Field Values

RETRIEVER_FIELD

public static final ParseField RETRIEVER_FIELD

PARSER

public static final ConstructingObjectParser<RescorerRetrieverBuilder,RetrieverParserContext> PARSER

Constructor Details

RescorerRetrieverBuilder

public RescorerRetrieverBuilder(RetrieverBuilder retriever,
 List<RescorerBuilder<?>> rescorers)

Method Details

fromXContent

public static RescorerRetrieverBuilder fromXContent(XContentParser parser,
 RetrieverParserContext context)
                                             throws IOException

Throws:

IOException

getName

public String getName()

Specified by:

getName in class RetrieverBuilder

getRankWindowSizeField

public ParseField getRankWindowSizeField()

Description copied from class: CompoundRetrieverBuilder

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

Overrides:

getRankWindowSizeField in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>

finalizeSourceBuilder

protected SearchSourceBuilder finalizeSourceBuilder(SearchSourceBuilder source)

Overrides:

finalizeSourceBuilder in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>

doToXContent

public void doToXContent(XContentBuilder builder,
 ToXContent.Params params)
                  throws IOException

Specified by:

doToXContent in class RetrieverBuilder

Throws:

IOException

clone

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

Description copied from class: CompoundRetrieverBuilder

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

Specified by:

clone in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>

combineInnerRetrieverResults

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

Description copied from class: CompoundRetrieverBuilder

Combines the provided rankResults to return the final top documents.

Specified by:

combineInnerRetrieverResults in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>

doEquals

public boolean doEquals(Object o)

Overrides:

doEquals in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>

doHashCode

public int doHashCode()

Overrides:

doHashCode in class CompoundRetrieverBuilder<RescorerRetrieverBuilder>