org.elasticsearch.script

Interface LeafSearchScript

All Superinterfaces:

ExecutableScript, ScorerAware

All Known Subinterfaces:

ExplainableSearchScript

All Known Implementing Classes:

AbstractDoubleSearchScript, AbstractLongSearchScript, AbstractSearchScript

public interface LeafSearchScript
extends ScorerAware, ExecutableScript

A per-segment SearchScript. This is effectively a functional interface, requiring at least implementing runAsDouble().

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	run() Executes the script.
double	runAsDouble() Return the result as a double.
default long	runAsLong() Return the result as a long.
default void	setDocument(int doc) Set the document this script will process next.
default void	setNextAggregationValue(java.lang.Object value) Sets per-document aggregation _value.
default void	setNextVar(java.lang.String field, java.lang.Object value) Sets a runtime script parameter.
default void	setScorer(org.apache.lucene.search.Scorer scorer)
default void	setSource(java.util.Map<java.lang.String,java.lang.Object> source) Set the source for the current document.

Methods inherited from interface org.elasticsearch.script.ExecutableScript

unwrap

Method Detail

setDocument

default void setDocument(int doc)

Set the document this script will process next.

setScorer

default void setScorer(org.apache.lucene.search.Scorer scorer)

Specified by:

setScorer in interface ScorerAware

setSource

default void setSource(java.util.Map<java.lang.String,java.lang.Object> source)

Set the source for the current document.

setNextAggregationValue

default void setNextAggregationValue(java.lang.Object value)

Sets per-document aggregation _value.

The default implementation just calls setNextVar("_value", value) but some engines might want to handle this differently for better performance.

Parameters:

value - per-document value, typically a String, Long, or Double

setNextVar

default void setNextVar(java.lang.String field,
                        java.lang.Object value)

Description copied from interface: ExecutableScript

Sets a runtime script parameter.

Note that this method may be slow, involving put() and get() calls to a hashmap or similar.

Specified by:

setNextVar in interface ExecutableScript

Parameters:

field - parameter name

value - parameter value

runAsLong

default long runAsLong()

Return the result as a long. This is used by aggregation scripts over long fields.

run

default java.lang.Object run()

Description copied from interface: ExecutableScript

Executes the script.

Specified by:

run in interface ExecutableScript

runAsDouble

double runAsDouble()

Return the result as a double. This is the main use case of search script, used for document scoring.