Module org.elasticsearch.server

Package org.elasticsearch.script

Class CompositeFieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AbstractFieldScript

org.elasticsearch.script.CompositeFieldScript

public abstract class CompositeFieldScript
extends AbstractFieldScript

A script that emits a map of multiple values, that can then be accessed by child runtime fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompositeFieldScript.EmitField
static class	CompositeFieldScript.EmitMap
static interface	CompositeFieldScript.Factory
static interface	CompositeFieldScript.LeafFactory

Field Summary

Fields

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

Fields inherited from class org.elasticsearch.script.AbstractFieldScript

fieldName, MAX_VALUES, source

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected final void	emit(String field, Object value)
protected void	emitFromObject(Object v)
final Map<String,List<Object>>	getFieldValues()
final List<Object>	getValues(String field)	Runs the object script and returns the values that were emitted for the provided field name
protected void	prepareExecute()

Methods inherited from class org.elasticsearch.script.AbstractFieldScript

checkMaxSize, emitFromCompositeScript, emitFromSource, emitValueFromCompositeScript, execute, extractFromSource, getParams, newContext, runForDoc

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

CONTEXT

public static final ScriptContext<CompositeFieldScript.Factory> CONTEXT

PARAMETERS

public static final String[] PARAMETERS

Constructor Details

CompositeFieldScript

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

Method Details

getValues

public final List<Object> getValues(String field)

Runs the object script and returns the values that were emitted for the provided field name

Parameters:

field - the field name to extract values from

Returns:

the values that were emitted for the provided field

prepareExecute

protected void prepareExecute()

Specified by:

prepareExecute in class AbstractFieldScript

getFieldValues

public final Map<String,List<Object>> getFieldValues()

emit

protected final void emit(String field,
 Object value)

emitFromObject

protected void emitFromObject(Object v)

Specified by:

emitFromObject in class AbstractFieldScript