Package org.elasticsearch.index.query.functionscore

Class ScriptScoreFunctionBuilder

java.lang.Object

org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

org.elasticsearch.index.query.functionscore.ScriptScoreFunctionBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment

public class ScriptScoreFunctionBuilder
extends ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

A function that uses a script to compute or influence the score of documents that match with the inner query or filter.

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 java.lang.String	NAME

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptScoreFunctionBuilder(StreamInput in)	Read from a stream.
ScriptScoreFunctionBuilder(Script script)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ScriptScoreFunctionBuilder functionBuilder)	Check that two instances of the same subclass of ScoreFunctionBuilder are equal.
protected int	doHashCode()	Hashcode for fields defined in this subclass of ScoreFunctionBuilder.
protected ScoreFunction	doToFunction(QueryShardContext context)	Build the Lucene ScoreFunction for this builder.
protected void	doWriteTo(StreamOutput out)	Write the subclass's components into the stream.
void	doXContent(XContentBuilder builder, ToXContent.Params params)	Convert this subclass's data into XContent.
static ScriptScoreFunctionBuilder	fromXContent(XContentParser parser)
java.lang.String	getName()	The name of this score function.
Script	getScript()

Methods inherited from class org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder

equals, getWeight, getWriteableName, hashCode, setWeight, toFunction, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ScriptScoreFunctionBuilder

public ScriptScoreFunctionBuilder(Script script)

ScriptScoreFunctionBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Description copied from class: ScoreFunctionBuilder

Write the subclass's components into the stream.

Specified by:

doWriteTo in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

Throws:

java.io.IOException

getScript

public Script getScript()

doXContent

public void doXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException

Description copied from class: ScoreFunctionBuilder

Convert this subclass's data into XContent.

Specified by:

doXContent in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

Throws:

java.io.IOException

getName

public java.lang.String getName()

Description copied from class: ScoreFunctionBuilder

The name of this score function.

Specified by:

getName in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

doEquals

protected boolean doEquals(ScriptScoreFunctionBuilder functionBuilder)

Description copied from class: ScoreFunctionBuilder

Check that two instances of the same subclass of ScoreFunctionBuilder are equal. Implementers don't need to check any fields in ScoreFunctionBuilder, just fields that they define.

Specified by:

doEquals in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

doHashCode

protected int doHashCode()

Description copied from class: ScoreFunctionBuilder

Hashcode for fields defined in this subclass of ScoreFunctionBuilder. Implementers should ignore fields defined in ScoreFunctionBuilder because they will already be in the hashCode.

Specified by:

doHashCode in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

doToFunction

protected ScoreFunction doToFunction(QueryShardContext context)

Description copied from class: ScoreFunctionBuilder

Build the Lucene ScoreFunction for this builder. Implementers should ignore things defined in ScoreFunctionBuilder like weight as they will be handled by the function that calls this one.

Specified by:

doToFunction in class ScoreFunctionBuilder<ScriptScoreFunctionBuilder>

fromXContent

public static ScriptScoreFunctionBuilder fromXContent(XContentParser parser)
                                               throws java.io.IOException,
                                                      ParsingException

Throws:

java.io.IOException

ParsingException