Module org.elasticsearch.server

Package org.elasticsearch.index.query.functionscore

Class ScriptScoreQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.functionscore.ScriptScoreQueryBuilder

All Implemented Interfaces:

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

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.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 ParseField	MIN_SCORE_FIELD
static final String	NAME
static final ParseField	QUERY_FIELD
static final ParseField	SCRIPT_FIELD

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
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(SearchExecutionContext context, MaxClauseCountQueryVisitor queryVisitor)	Builds the Lucene Query for this builder.
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.
static ScriptScoreQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
Float	getMinScore()
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.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

QUERY_FIELD

public static final ParseField QUERY_FIELD

SCRIPT_FIELD

public static final ParseField SCRIPT_FIELD

MIN_SCORE_FIELD

public static final 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 IOException

Read from a stream.

Throws:

IOException

Method Details

fromXContent

public static ScriptScoreQueryBuilder fromXContent(XContentParser parser)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

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(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

IOException

setMinScore

public ScriptScoreQueryBuilder setMinScore(float minScore)

getMinScore

public Float getMinScore()

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

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(SearchExecutionContext context,
 MaxClauseCountQueryVisitor queryVisitor)
                                            throws IOException

Description copied from class: AbstractQueryBuilder

Builds the Lucene Query for this builder.

Implementations should use the provided QueryVisitor to visit any generated query or sub-queries. Boost and named-query handling are applied by QueryBuilder.toQuery(SearchExecutionContext, MaxClauseCountQueryVisitor). LeafQueryBuilder implementations get this visitor handling automatically.

Specified by:

doToQuery in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Parameters:

context - additional information needed to construct the query

queryVisitor - query MaxClauseCountQueryVisitor used to account for clauses while building the query

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<ScriptScoreQueryBuilder>

Throws:

IOException

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<ScriptScoreQueryBuilder>

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.