Package org.opensearch.script

Class DerivedFieldScript

java.lang.Object

org.opensearch.script.DerivedFieldScript

public abstract class DerivedFieldScript
extends Object

Definition of Script for DerivedField. It will be used to execute scripts defined against derived fields of any type

Opensearch.internal:

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<DerivedFieldScript.Factory>	CONTEXT
static final String[]	PARAMETERS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addEmittedValue(Object o)
void	execute()
Map<String,ScriptDocValues<?>>	getDoc()	The doc lookup for the Lucene segment this script was created for.
List<Object>	getEmittedValues()	Return the emitted values from the script execution.
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<DerivedFieldScript.Factory> CONTEXT

Constructor Details

DerivedFieldScript

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

Method Details

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

getDoc

public Map<String,ScriptDocValues<?>> getDoc()

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

getEmittedValues

public List<Object> getEmittedValues()

Return the emitted values from the script execution.

setDocument

public void setDocument(int docid)

Set the current document to run the script on next. Clears the emittedValues as well since they should be scoped per document.

addEmittedValue

public void addEmittedValue(Object o)

execute

public void execute()