Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class RetrieverBuilderWrapper<T extends RetrieverBuilder>

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

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

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

public abstract class RetrieverBuilderWrapper<T extends RetrieverBuilder>
extends RetrieverBuilder

A wrapper that can be used to modify the behaviour of an existing RetrieverBuilder.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
protected final RetrieverBuilder	in

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	RetrieverBuilderWrapper(RetrieverBuilder in)

Method Summary

Modifier and Type	Method	Description
protected abstract T	clone(RetrieverBuilder sub)
protected boolean	doEquals(Object o)
protected int	doHashCode()
protected void	doToXContent(XContentBuilder builder, ToXContent.Params params)
QueryBuilder	explainQuery()
void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)	This method is called at the end of rewriting on behalf of a SearchSourceBuilder.
String	getName()
List<QueryBuilder>	getPreFilterQueryBuilders()	Gets the filters for this retriever.
RankDoc[]	getRankDocs()
boolean	isCompound()	Determines if this retriever contains sub-retrievers that need to be executed prior to search.
boolean	isFragment()
Float	minScore()
RetrieverBuilder	minScore(Float minScore)
String	retrieverName()
RetrieverBuilder	retrieverName(String retrieverName)
RetrieverBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
void	setRankDocs(RankDoc[] rankDocs)
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.
String	toString()
ActionRequestValidationException	validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults)

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

declareBaseParserFields, equals, hashCode, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, rewritePreFilters, toXContent

Methods inherited from class java.lang.Object

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

Field Details

in

protected final RetrieverBuilder in

Constructor Details

RetrieverBuilderWrapper

protected RetrieverBuilderWrapper(RetrieverBuilder in)

Method Details

clone

protected abstract T clone(RetrieverBuilder sub)

rewrite

public 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 RetrieverBuilder>

Overrides:

rewrite in class RetrieverBuilder

Throws:

IOException

topDocsQuery

public 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

minScore

public RetrieverBuilder minScore(Float minScore)

Overrides:

minScore in class RetrieverBuilder

getPreFilterQueryBuilders

public List<QueryBuilder> getPreFilterQueryBuilders()

Description copied from class: RetrieverBuilder

Gets the filters for this retriever.

Overrides:

getPreFilterQueryBuilders in class RetrieverBuilder

validate

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

Overrides:

validate in class RetrieverBuilder

retrieverName

public RetrieverBuilder retrieverName(String retrieverName)

Overrides:

retrieverName in class RetrieverBuilder

setRankDocs

public void setRankDocs(RankDoc[] rankDocs)

Overrides:

setRankDocs in class RetrieverBuilder

getRankDocs

public RankDoc[] getRankDocs()

Overrides:

getRankDocs in class RetrieverBuilder

isCompound

public 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

explainQuery

public QueryBuilder explainQuery()

Overrides:

explainQuery in class RetrieverBuilder

minScore

public Float minScore()

Overrides:

minScore in class RetrieverBuilder

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent

Overrides:

isFragment in class RetrieverBuilder

toString

public String toString()

Overrides:

toString in class RetrieverBuilder

retrieverName

public String retrieverName()

Overrides:

retrieverName in class RetrieverBuilder

extractToSearchSourceBuilder

public 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

getName

public String getName()

Specified by:

getName in class RetrieverBuilder

doToXContent

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

Specified by:

doToXContent in class RetrieverBuilder

Throws:

IOException

doEquals

protected boolean doEquals(Object o)

Specified by:

doEquals in class RetrieverBuilder

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class RetrieverBuilder