Package org.elasticsearch.script

Class FilterScript

java.lang.Object
org.elasticsearch.script.FilterScript
public abstract class FilterScript
extends java.lang.Object
A script implementation of a query filter. See ScriptQueryBuilder.

  • Nested Class Summary

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static ScriptContext<FilterScript.Factory> CONTEXT
    The context used to compile FilterScript factories.
    static java.lang.String[] PARAMETERS  

  • Constructor Summary

    Constructors 
    Constructor Description
    FilterScript​(java.util.Map<java.lang.String,​java.lang.Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)  

  • Method Summary

    Modifier and Type Method Description
    abstract boolean execute()
    Return true if the current document matches the filter, or false otherwise.
    java.util.Map<java.lang.String,​ScriptDocValues<?>> getDoc()
    The doc lookup for the Lucene segment this script was created for.
    java.util.Map<java.lang.String,​java.lang.Object> getParams()
    Return the parameters for this script.
    void setDocument​(int docid)
    Set the current document to run the script on next.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • FilterScript

      public FilterScript​(java.util.Map<java.lang.String,​java.lang.Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)

  • Method Details

    • execute

      public abstract boolean execute()
      Return true if the current document matches the filter, or false otherwise.

    • getParams

      public java.util.Map<java.lang.String,​java.lang.Object> getParams()
      Return the parameters for this script.

    • getDoc

      public final java.util.Map<java.lang.String,​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.