Class ScriptScoreQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<ScriptScoreQueryBuilder>
org.elasticsearch.index.query.functionscore.ScriptScoreQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,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.elasticsearch.common.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 ParseField
MIN_SCORE_FIELD
static java.lang.String
NAME
static ParseField
QUERY_FIELD
static ParseField
SCRIPT_FIELD
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
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 otherQueryBuilder
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(XContentBuilder builder, 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(XContentParser parser)
java.lang.Float
getMinScore()
java.lang.String
getWriteableName()
Returns the name of the writeable objectQueryBuilder
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, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
QUERY_FIELD
-
SCRIPT_FIELD
-
MIN_SCORE_FIELD
-
-
Constructor Details
-
ScriptScoreQueryBuilder
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
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
fromXContent
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<ScriptScoreQueryBuilder>
- Throws:
java.io.IOException
-
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 java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<ScriptScoreQueryBuilder>
- Throws:
java.io.IOException
-
setMinScore
-
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
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<ScriptScoreQueryBuilder>
- Throws:
java.io.IOException
-
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOException- Overrides:
doRewrite
in classAbstractQueryBuilder<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 classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-