Package org.elasticsearch.script

Class FieldScript

java.lang.Object

org.elasticsearch.script.FieldScript

public abstract class FieldScript
extends Object

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

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,ScriptDocValues<?>>	getDoc()	The doc lookup for the Lucene segment this script was created for.
protected LeafSearchLookup	getLeafLookup()	The leaf lookup for the Lucene segment this script was created for.
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 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()

getLeafLookup

protected final LeafSearchLookup getLeafLookup()

The leaf lookup for the Lucene segment this script was created for.

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

getDoc

public final Map<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.