Package org.elasticsearch.search.retriever

Class TestRetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

org.elasticsearch.search.retriever.TestRetrieverBuilder

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, org.elasticsearch.xcontent.ToXContent

public class TestRetrieverBuilder
extends RetrieverBuilder

Test retriever is used to test parsing of retrievers in plugins where generation of other random retrievers are not easily accessible through test code.

Nested Class Summary

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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.elasticsearch.xcontent.ConstructingObjectParser<TestRetrieverBuilder,RetrieverParserContext>	PARSER
static final org.elasticsearch.xcontent.ParseField	TEST_FIELD
static final SearchPlugin.RetrieverSpec<TestRetrieverBuilder>	TEST_SPEC
static final org.elasticsearch.xcontent.ParseField	VALUE_FIELD

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
TestRetrieverBuilder(String value)

Method Summary

Modifier and Type	Method	Description
static TestRetrieverBuilder	createRandomTestRetrieverBuilder()	Creates a random TestRetrieverBuilder.
boolean	doEquals(Object o)
int	doHashCode()
void	doToXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)
static TestRetrieverBuilder	fromXContent(org.elasticsearch.xcontent.XContentParser parser, RetrieverParserContext context)
String	getName()
QueryBuilder	topDocsQuery()

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

declareBaseParserFields, equals, explainQuery, getPreFilterQueryBuilders, hashCode, isCompound, isFragment, minScore, minScore, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, retrieverName, retrieverName, rewrite, rewritePreFilters, setRankDocs, toString, toXContent, validate

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

TEST_FIELD

public static final org.elasticsearch.xcontent.ParseField TEST_FIELD

TEST_SPEC

public static final SearchPlugin.RetrieverSpec<TestRetrieverBuilder> TEST_SPEC

VALUE_FIELD

public static final org.elasticsearch.xcontent.ParseField VALUE_FIELD

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<TestRetrieverBuilder,RetrieverParserContext> PARSER

Constructor Details

TestRetrieverBuilder

public TestRetrieverBuilder(String value)

Method Details

createRandomTestRetrieverBuilder

public static TestRetrieverBuilder createRandomTestRetrieverBuilder()

Creates a random TestRetrieverBuilder. The created instance is not guaranteed to pass SearchRequest validation. This is purely for x-content testing.

fromXContent

public static TestRetrieverBuilder fromXContent(org.elasticsearch.xcontent.XContentParser parser,
 RetrieverParserContext context)

topDocsQuery

public QueryBuilder topDocsQuery()

Specified by:

topDocsQuery in class RetrieverBuilder

extractToSearchSourceBuilder

public void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder,
 boolean compoundUsed)

Specified by:

extractToSearchSourceBuilder in class RetrieverBuilder

getName

public String getName()

Specified by:

getName in class RetrieverBuilder

doToXContent

public void doToXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.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