Package org.elasticsearch.script

Class AggregationScript

org.elasticsearch.script.AggregationScript
All Implemented Interfaces:
ScorerAware
public abstract class AggregationScript extends implements ScorerAware

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    AggregationScript.Factory
    A factory to construct stateful AggregationScript factories for a specific index.
    static interface 
    AggregationScript.LeafFactory
    A factory to construct AggregationScript instances.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static ScriptContext<AggregationScript.Factory>
    CONTEXT
     
    static []
    PARAMETERS
     
    protected org.apache.lucene.search.Scorable
    scorer
    A scorer that will return the score for the current document when the script is run.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AggregationScript()
     
     
    <,​> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract
    execute()
     
    get_score()
     
    get_value()
     
    <,​ScriptDocValues<?>>
    getDoc()
    The doc lookup for the Lucene segment this script was created for.
    <,​>
    getParams()
    Return the parameters for this script.
    double
    runAsDouble()
     
    long
    runAsLong()
    Return the result as a long.
    void
    setDocument​(int docid)
    Set the current document to run the script on next.
    void
     value)
    Sets per-document aggregation _value.
    void
    setScorer​(org.apache.lucene.search.Scorable scorer)
     

    Methods inherited from class java.lang.

    , , , , , , , , , ,

  • Field Details

    • PARAMETERS

      public static final [] PARAMETERS

    • CONTEXT

      public static final ScriptContext<AggregationScript.Factory> CONTEXT

    • scorer

      protected org.apache.lucene.search.Scorable scorer
      A scorer that will return the score for the current document when the script is run.

  • Constructor Details

    • AggregationScript

      public AggregationScript​(<,​> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)

    • AggregationScript

      protected AggregationScript()

  • Method Details

    • getParams

      public <,​> getParams()
      Return the parameters for this script.

    • getDoc

      public <,​ScriptDocValues<?>> getDoc()
      The doc lookup for the Lucene segment this script was created for.

    • setDocument

      public void setDocument​(int docid)
      Set the current document to run the script on next.

    • setScorer

      public void setScorer​(org.apache.lucene.search.Scorable scorer)
      Specified by:
      setScorer in interface ScorerAware

    • setNextAggregationValue

      public void setNextAggregationValue​( value)
      Sets per-document aggregation _value.

      The default implementation just calls setNextVar("_value", value) but some engines might want to handle this differently for better performance.

      Parameters:
      value - per-document value, typically a String, Long, or Double

    • get_score

      public  get_score()

    • get_value

      public  get_value()

    • runAsLong

      public long runAsLong()
      Return the result as a long. This is used by aggregation scripts over long fields.

    • runAsDouble

      public double runAsDouble()

    • execute

      public abstract  execute()