Package org.opensearch.index.query.functionscore

Class ScriptScoreQueryBuilder

java.lang.Object

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

org.opensearch.index.query.functionscore.ScriptScoreQueryBuilder

All Implemented Interfaces:

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

public class ScriptScoreQueryBuilder
extends AbstractQueryBuilder<ScriptScoreQueryBuilder>

A query that computes a document score based on the provided script

Nested Class Summary

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static org.opensearch.common.ParseField	MIN_SCORE_FIELD
static java.lang.String	NAME
static org.opensearch.common.ParseField	QUERY_FIELD
static org.opensearch.common.ParseField	SCRIPT_FIELD

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptScoreQueryBuilder(StreamInput in)	Read from a stream.
ScriptScoreQueryBuilder(QueryBuilder query, Script script)	Creates a script_score query that executes the provided script function on documents that match a query.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ScriptScoreQueryBuilder 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(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
protected void	extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits)	For internal usage only! Extracts the inner hits from the query tree.
static ScriptScoreQueryBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
java.lang.Float	getMinScore()
java.lang.String	getWriteableName()	Returns the name of the writeable object
QueryBuilder	query()	Returns the query builder that defines which documents the script_score query will be executed on.
ScriptScoreQueryBuilder	setMinScore(float minScore)

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, 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.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

QUERY_FIELD

public static final org.opensearch.common.ParseField QUERY_FIELD

SCRIPT_FIELD

public static final org.opensearch.common.ParseField SCRIPT_FIELD

MIN_SCORE_FIELD

public static final org.opensearch.common.ParseField MIN_SCORE_FIELD

Constructor Details

ScriptScoreQueryBuilder

public ScriptScoreQueryBuilder(QueryBuilder query, Script script)

Creates a script_score query that executes the provided script function on documents that match a query.

Parameters:

query - the query that defines which documents the script_score query will be executed on.

script - the script to run for computing the query score

ScriptScoreQueryBuilder

public ScriptScoreQueryBuilder(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

fromXContent

public static ScriptScoreQueryBuilder fromXContent(org.opensearch.common.xcontent.XContentParser parser)

doWriteTo

protected void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

java.io.IOException

query

public QueryBuilder query()

Returns the query builder that defines which documents the script_score query will be executed on.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

java.io.IOException

setMinScore

public ScriptScoreQueryBuilder setMinScore(float minScore)

getMinScore

public java.lang.Float getMinScore()

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doEquals

protected boolean doEquals(ScriptScoreQueryBuilder 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<ScriptScoreQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

java.io.IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOException

Overrides:

doRewrite in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

java.io.IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(java.util.Map<java.lang.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<ScriptScoreQueryBuilder>