Module org.elasticsearch.server

Package org.elasticsearch.script

Class AbstractLongFieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AbstractFieldScript

org.elasticsearch.script.AbstractLongFieldScript

Direct Known Subclasses:

DateFieldScript, LongFieldScript, SortedNumericDocValuesLongFieldScript

public abstract class AbstractLongFieldScript
extends AbstractFieldScript

Common base class for script field scripts that return long values.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
final int	count()	The number of results produced the last time AbstractFieldScript.runForDoc(int) was called.
final void	emit(long v)
protected void	prepareExecute()
final void	runForDoc(int docId, LongConsumer consumer)	Execute the script for the provided docId, passing results to the consumer
final long[]	values()	Values from the last time AbstractFieldScript.runForDoc(int) was called.

Methods inherited from class org.elasticsearch.script.AbstractFieldScript

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

Constructor Details

AbstractLongFieldScript

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

Method Details

prepareExecute

protected void prepareExecute()

Specified by:

prepareExecute in class AbstractFieldScript

runForDoc

public final void runForDoc(int docId,
 LongConsumer consumer)

Execute the script for the provided docId, passing results to the consumer

values

public final long[] values()

Values from the last time AbstractFieldScript.runForDoc(int) was called. This array is mutable and will change with the next call of AbstractFieldScript.runForDoc(int). It is also oversized and will contain garbage at all indices at and above count().

count

public final int count()

The number of results produced the last time AbstractFieldScript.runForDoc(int) was called.

emit

public final void emit(long v)