Module org.elasticsearch.server

Package org.elasticsearch.script

Class AbstractFieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AbstractFieldScript

Direct Known Subclasses:

AbstractLongFieldScript, BooleanFieldScript, CompositeFieldScript, DoubleFieldScript, GeoPointFieldScript, IpFieldScript, StringFieldScript

public abstract class AbstractFieldScript
extends DocBasedScript

Abstract base for scripts to execute to build scripted fields. Inspired by AggregationScript but hopefully with less historical baggage.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldName
static final int	MAX_VALUES	The maximum number of values a script should be allowed to emit.
protected final Supplier<Source>	source

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

Constructor	Description
AbstractFieldScript(String fieldName, Map<String,Object> params, SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext ctx, OnScriptError onScriptError)

Method Summary

Modifier and Type	Method	Description
protected final void	checkMaxSize(int currentSize)	Check if the we can add another value to the list of values.
protected final void	emitFromCompositeScript(CompositeFieldScript compositeFieldScript)
protected abstract void	emitFromObject(Object v)
protected final void	emitFromSource()
protected void	emitValueFromCompositeScript(Object value)
abstract void	execute()
protected List<Object>	extractFromSource(String path)
final Map<String,Object>	getParams()	Expose the params of the script to the script itself.
protected abstract void	prepareExecute()
final void	runForDoc(int docId)	Execute the script for the provided docId.

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

MAX_VALUES

public static final int MAX_VALUES

The maximum number of values a script should be allowed to emit.

See Also:

• Constant Field Values

fieldName

protected final String fieldName

source

protected final Supplier<Source> source

Constructor Details

AbstractFieldScript

public AbstractFieldScript(String fieldName,
 Map<String,Object> params,
 SearchLookup searchLookup,
 org.apache.lucene.index.LeafReaderContext ctx,
 OnScriptError onScriptError)

Method Details

getParams

public final Map<String,Object> getParams()

Expose the params of the script to the script itself.

extractFromSource

protected List<Object> extractFromSource(String path)

emitFromCompositeScript

protected final void emitFromCompositeScript(CompositeFieldScript compositeFieldScript)

emitValueFromCompositeScript

protected void emitValueFromCompositeScript(Object value)

emitFromObject

protected abstract void emitFromObject(Object v)

emitFromSource

protected final void emitFromSource()

checkMaxSize

protected final void checkMaxSize(int currentSize)

Check if the we can add another value to the list of values.

Parameters:

currentSize - the current size of the list

prepareExecute

protected abstract void prepareExecute()

runForDoc

public final void runForDoc(int docId)

Execute the script for the provided docId.

execute

public abstract void execute()