Package org.elasticsearch.script

Class FilterScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.FilterScript

public abstract class FilterScript
extends DocBasedScript

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 final ScriptContext<FilterScript.Factory>	CONTEXT	The context used to compile FilterScript factories.
static final String[]	PARAMETERS

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

Constructor	Description
FilterScript(Map<String,Object> params, SearchLookup lookup, DocReader docReader)

Method Summary

Modifier and Type	Method	Description
abstract boolean	execute()	Return true if the current document matches the filter, or false otherwise.
Map<String,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 org.elasticsearch.script.DocBasedScript

docAsMap, field, fields, getDoc

Methods inherited from class java.lang.Object

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

Field Details

PARAMETERS

public static final String[] PARAMETERS

CONTEXT

public static final ScriptContext<FilterScript.Factory> CONTEXT

The context used to compile FilterScript factories.

Constructor Details

FilterScript

public FilterScript(Map<String,Object> params,
 SearchLookup lookup,
 DocReader docReader)

Method Details

execute

public abstract boolean execute()

Return true if the current document matches the filter, or false otherwise.

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

setDocument

public void setDocument(int docid)

Set the current document to run the script on next.

Overrides:

setDocument in class DocBasedScript