Package org.opensearch.index.query

Class RankFeatureQueryBuilder

java.lang.Object

org.opensearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>

org.opensearch.index.query.RankFeatureQueryBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public final class RankFeatureQueryBuilder
extends AbstractQueryBuilder<RankFeatureQueryBuilder>

Query to run on a [rank_feature] field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankFeatureQueryBuilder.ScoreFunction	Scoring function for a [rank_feature] field.

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.opensearch.core.xcontent.ConstructingObjectParser<RankFeatureQueryBuilder,Void>	PARSER

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RankFeatureQueryBuilder(String field, RankFeatureQueryBuilder.ScoreFunction scoreFunction)
RankFeatureQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(RankFeatureQueryBuilder other)
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
protected void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	getWriteableName()

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.index.query.QueryBuilder

visit

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final org.opensearch.core.xcontent.ConstructingObjectParser<RankFeatureQueryBuilder,Void> PARSER

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

RankFeatureQueryBuilder

public RankFeatureQueryBuilder(String field,
 RankFeatureQueryBuilder.ScoreFunction scoreFunction)

Parameters:

field - The field name.

scoreFunction - Scoring function for the rank_feature field.

RankFeatureQueryBuilder

public RankFeatureQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<RankFeatureQueryBuilder>

Throws:

IOException

doXContent

protected void doXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<RankFeatureQueryBuilder>

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<RankFeatureQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(RankFeatureQueryBuilder other)

Specified by:

doEquals in class AbstractQueryBuilder<RankFeatureQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<RankFeatureQueryBuilder>