Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class RankDocsQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<RankDocsQueryBuilder>

org.elasticsearch.index.query.LeafQueryBuilder<RankDocsQueryBuilder>

org.elasticsearch.index.query.RankDocsQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class RankDocsQueryBuilder
extends LeafQueryBuilder<RankDocsQueryBuilder>

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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
RankDocsQueryBuilder(StreamInput in)
RankDocsQueryBuilder(RankDoc[] rankDocs, QueryBuilder[] queryBuilders, boolean onlyRankDocs)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(RankDocsQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
protected void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)	For internal usage only! Extracts the inner hits from the query tree.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
QueryBuilder[]	getQueryBuilders()
String	getWriteableName()	Returns the name of the writeable object
RankDoc[]	rankDocs()

Methods inherited from class org.elasticsearch.index.query.LeafQueryBuilder

doToQuery

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doSearchRewrite, equals, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

RankDocsQueryBuilder

public RankDocsQueryBuilder(RankDoc[] rankDocs,
 QueryBuilder[] queryBuilders,
 boolean onlyRankDocs)

RankDocsQueryBuilder

public RankDocsQueryBuilder(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

extractInnerHitBuilders

protected void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

Description copied from class: AbstractQueryBuilder

For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<RankDocsQueryBuilder>

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<RankDocsQueryBuilder>

Throws:

IOException

rankDocs

public RankDoc[] rankDocs()

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<RankDocsQueryBuilder>

Throws:

IOException

getQueryBuilders

public QueryBuilder[] getQueryBuilders()

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class LeafQueryBuilder<RankDocsQueryBuilder>

Throws:

IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<RankDocsQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(RankDocsQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<RankDocsQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<RankDocsQueryBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.