Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class StandardRetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

org.elasticsearch.search.retriever.StandardRetrieverBuilder

All Implemented Interfaces:

ToXContent

public final class StandardRetrieverBuilder
extends RetrieverBuilder
implements ToXContent

A standard retriever is used to represent anything that is a query along with some elements to specify parameters for that query.

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	COLLAPSE_FIELD
static final ParseField	MIN_SCORE_FIELD
static final String	NAME
static final ObjectParser<StandardRetrieverBuilder,RetrieverParserContext>	PARSER
static final ParseField	QUERY_FIELD
static final ParseField	SEARCH_AFTER_FIELD
static final ParseField	SORT_FIELD
static final NodeFeature	STANDARD_RETRIEVER_SUPPORTED
static final ParseField	TERMINATE_AFTER_FIELD

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

NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, retrieverName, RETRIEVERS_SUPPORTED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
StandardRetrieverBuilder()

Method Summary

Modifier and Type	Method	Description
boolean	doEquals(Object o)
int	doHashCode()
void	doToXContent(XContentBuilder builder, ToXContent.Params params)
void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)	This method is called at the end of parsing on behalf of a SearchSourceBuilder.
static StandardRetrieverBuilder	fromXContent(XContentParser parser, RetrieverParserContext context)
String	getName()

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

declareBaseParserFields, equals, getPreFilterQueryBuilders, hashCode, isFragment, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, toString, toXContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

isFragment, toXContent

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

STANDARD_RETRIEVER_SUPPORTED

public static final NodeFeature STANDARD_RETRIEVER_SUPPORTED

QUERY_FIELD

public static final ParseField QUERY_FIELD

SEARCH_AFTER_FIELD

public static final ParseField SEARCH_AFTER_FIELD

TERMINATE_AFTER_FIELD

public static final ParseField TERMINATE_AFTER_FIELD

SORT_FIELD

public static final ParseField SORT_FIELD

MIN_SCORE_FIELD

public static final ParseField MIN_SCORE_FIELD

COLLAPSE_FIELD

public static final ParseField COLLAPSE_FIELD

PARSER

public static final ObjectParser<StandardRetrieverBuilder,RetrieverParserContext> PARSER

Constructor Details

StandardRetrieverBuilder

public StandardRetrieverBuilder()

Method Details

fromXContent

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

Throws:

IOException

extractToSearchSourceBuilder

public void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder,
 boolean compoundUsed)

Description copied from class: RetrieverBuilder

This method is called at the end of parsing 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

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

Specified by:

doToXContent in class RetrieverBuilder

Throws:

IOException

doEquals

public boolean doEquals(Object o)

Specified by:

doEquals in class RetrieverBuilder

doHashCode

public int doHashCode()

Specified by:

doHashCode in class RetrieverBuilder