Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class RetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

Direct Known Subclasses:

CompoundRetrieverBuilder, KnnRetrieverBuilder, RankDocsRetrieverBuilder, RetrieverBuilderWrapper, StandardRetrieverBuilder

public abstract class RetrieverBuilder
extends Object
implements Rewriteable<RetrieverBuilder>, ToXContent

A retriever represents an API element that returns an ordered list of top documents. These can be obtained from a query, from another retriever, etc. Internally, a RetrieverBuilder is first rewritten into its simplest form and then its elements are extracted into a SearchSourceBuilder. The advantage retrievers have is in the API they appear as a tree-like structure enabling easier reasoning about what a search does. This is the base class for all other retrievers. This class does not support serialization and is expected to be fully extracted to a SearchSourceBuilder prior to any transport calls.

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
static final ParseField	MIN_SCORE_FIELD
protected Float	minScore
static final ParseField	NAME_FIELD
static final ParseField	PRE_FILTER_FIELD
protected List<QueryBuilder>	preFilterQueryBuilders
protected RankDoc[]	rankDocs
protected String	retrieverName

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

Method Summary

Modifier and Type	Method	Description
protected static void	declareBaseParserFields(String name, AbstractObjectParser<? extends RetrieverBuilder,RetrieverParserContext> parser)
protected abstract boolean	doEquals(Object o)
protected abstract int	doHashCode()
protected abstract void	doToXContent(XContentBuilder builder, ToXContent.Params params)
final boolean	equals(Object o)
QueryBuilder	explainQuery()
abstract void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)	This method is called at the end of rewriting on behalf of a SearchSourceBuilder.
abstract String	getName()
List<QueryBuilder>	getPreFilterQueryBuilders()	Gets the filters for this retriever.
RankDoc[]	getRankDocs()
final int	hashCode()
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)
protected static RetrieverBuilder	parseInnerRetrieverBuilder(XContentParser parser, RetrieverParserContext context)
static RetrieverBuilder	parseTopLevelRetrieverBuilder(XContentParser parser, RetrieverParserContext context)
String	retrieverName()
RetrieverBuilder	retrieverName(String retrieverName)
RetrieverBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
protected final List<QueryBuilder>	rewritePreFilters(QueryRewriteContext ctx)
void	setRankDocs(RankDoc[] rankDocs)
abstract 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()
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults)

Methods inherited from class java.lang.Object

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

Field Details

PRE_FILTER_FIELD

public static final ParseField PRE_FILTER_FIELD

MIN_SCORE_FIELD

public static final ParseField MIN_SCORE_FIELD

NAME_FIELD

public static final ParseField NAME_FIELD

preFilterQueryBuilders

protected List<QueryBuilder> preFilterQueryBuilders

retrieverName

protected String retrieverName

minScore

protected Float minScore

rankDocs

protected RankDoc[] rankDocs

Constructor Details

RetrieverBuilder

public RetrieverBuilder()

Method Details

declareBaseParserFields

protected static void declareBaseParserFields(String name,
 AbstractObjectParser<? extends RetrieverBuilder,RetrieverParserContext> parser)

retrieverName

public RetrieverBuilder retrieverName(String retrieverName)

minScore

public RetrieverBuilder minScore(Float minScore)

parseTopLevelRetrieverBuilder

public static RetrieverBuilder parseTopLevelRetrieverBuilder(XContentParser parser,
 RetrieverParserContext context)
                                                      throws IOException

Throws:

IOException

parseInnerRetrieverBuilder

protected static RetrieverBuilder parseInnerRetrieverBuilder(XContentParser parser,
 RetrieverParserContext context)
                                                      throws IOException

Throws:

IOException

isCompound

public boolean isCompound()

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

rewritePreFilters

protected final List<QueryBuilder> rewritePreFilters(QueryRewriteContext ctx)
                                              throws IOException

Throws:

IOException

topDocsQuery

public abstract 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.

explainQuery

public QueryBuilder explainQuery()

minScore

public Float minScore()

setRankDocs

public void setRankDocs(RankDoc[] rankDocs)

getRankDocs

public RankDoc[] getRankDocs()

getPreFilterQueryBuilders

public List<QueryBuilder> getPreFilterQueryBuilders()

Gets the filters for this retriever.

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

Throws:

IOException

extractToSearchSourceBuilder

public abstract void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder,
 boolean compoundUsed)

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.

validate

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

getName

public abstract String getName()

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                                 throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doToXContent

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

Throws:

IOException

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

doEquals

protected abstract boolean doEquals(Object o)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

doHashCode

protected abstract int doHashCode()

toString

public String toString()

Overrides:

toString in class Object

retrieverName

public String retrieverName()