Module org.elasticsearch.server

Package org.elasticsearch.script

Class StringFieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AbstractFieldScript

org.elasticsearch.script.StringFieldScript

Direct Known Subclasses:

SortedSetDocValuesStringFieldScript

public abstract class StringFieldScript
extends AbstractFieldScript

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringFieldScript.Emit
static interface	StringFieldScript.Factory
static interface	StringFieldScript.LeafFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<StringFieldScript.Factory>	CONTEXT
static final long	MAX_CHARS	The maximum number of chars a script should be allowed to emit.
static final String[]	PARAMETERS
static final StringFieldScript.Factory	PARSE_FROM_SOURCE

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
StringFieldScript(String fieldName, Map<String,Object> params, SearchLookup searchLookup, OnScriptError onScriptError, org.apache.lucene.index.LeafReaderContext ctx)

Method Summary

Modifier and Type	Method	Description
final void	emit(String v)
protected void	emitFromObject(Object v)
protected void	emitValueFromCompositeScript(Object value)
List<String>	getValues()	Values from the last time runForDoc(int) was called.
static StringFieldScript.Factory	leafAdapter(Function<SearchLookup,CompositeFieldScript.LeafFactory> parentFactory)
protected void	prepareExecute()
final void	runForDoc(int docId, Consumer<String> consumer)

Methods inherited from class org.elasticsearch.script.AbstractFieldScript

checkMaxSize, emitFromCompositeScript, emitFromSource, 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

MAX_CHARS

public static final long MAX_CHARS

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

See Also:

• Constant Field Values

CONTEXT

public static final ScriptContext<StringFieldScript.Factory> CONTEXT

PARSE_FROM_SOURCE

public static final StringFieldScript.Factory PARSE_FROM_SOURCE

PARAMETERS

public static final String[] PARAMETERS

Constructor Details

StringFieldScript

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

Method Details

leafAdapter

public static StringFieldScript.Factory leafAdapter(Function<SearchLookup,CompositeFieldScript.LeafFactory> parentFactory)

prepareExecute

protected void prepareExecute()

Specified by:

prepareExecute in class AbstractFieldScript

runForDoc

public final void runForDoc(int docId,
 Consumer<String> consumer)

getValues

public List<String> getValues()

Values from the last time runForDoc(int) was called. This list is mutable and will change with the next call of runForDoc(int).

emitValueFromCompositeScript

protected void emitValueFromCompositeScript(Object value)

Overrides:

emitValueFromCompositeScript in class AbstractFieldScript

emitFromObject

protected void emitFromObject(Object v)

Specified by:

emitFromObject in class AbstractFieldScript

emit

public final void emit(String v)