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. SeeScriptQueryBuilder
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FilterScript.Factory
A factory to construct statefulFilterScript
factories for a specific index.static interface
FilterScript.LeafFactory
A factory to constructFilterScript
instances.
-
Field Summary
Fields Modifier and Type Field Description static ScriptContext<FilterScript.Factory>
CONTEXT
The context used to compileFilterScript
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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
execute()
Returntrue
if the current document matches the filter, orfalse
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.
-
-
-
Field Detail
-
PARAMETERS
public static final java.lang.String[] PARAMETERS
-
CONTEXT
public static final ScriptContext<FilterScript.Factory> CONTEXT
The context used to compileFilterScript
factories.
-
-
Constructor Detail
-
FilterScript
public FilterScript(java.util.Map<java.lang.String,java.lang.Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)
-
-
Method Detail
-
execute
public abstract boolean execute()
Returntrue
if the current document matches the filter, orfalse
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.
-
-