Class ScriptScoreFunctionBuilder

java.lang.Object
org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder<ScriptScoreFunctionBuilder>
org.elasticsearch.index.query.functionscore.ScriptScoreFunctionBuilder
All Implemented Interfaces:
NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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​(SearchExecutionContext context)
    Build the Lucene ScoreFunction for this builder.
    protected void doWriteTo​(StreamOutput out)
    Write the subclass's components into the stream.
    void doXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
    Convert this subclass's data into XContent.
    static ScriptScoreFunctionBuilder fromXContent​(org.elasticsearch.common.xcontent.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