Module org.elasticsearch.server

Package org.elasticsearch.script

Class FieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.FieldScript

public abstract class FieldScript
extends DocBasedScript

A script to produce dynamic values for return fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FieldScript.Factory
static interface	FieldScript.LeafFactory	A factory to construct FieldScript instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<FieldScript.Factory>	CONTEXT	The context used to compile FieldScript factories.
static final String[]	PARAMETERS

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldScript()
	FieldScript(Map<String,Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)

Method Summary

Modifier and Type	Method	Description
abstract Object	execute()
Map<String,Object>	getParams()	Return the parameters for this script.

Methods inherited from class org.elasticsearch.script.DocBasedScript

docAsMap, field, fields, getDoc, setDocument, source

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<FieldScript.Factory> CONTEXT

The context used to compile FieldScript factories.

Constructor Details

FieldScript

public FieldScript(Map<String,Object> params,
 SearchLookup lookup,
 org.apache.lucene.index.LeafReaderContext leafContext)

FieldScript

protected FieldScript()

Method Details

execute

public abstract Object execute()

getParams

public Map<String,Object> getParams()

Return the parameters for this script.