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.

Method Summary

Modifier and Type	Method and Description
double	runAsDouble()
long	runAsLong()
void	setDocument(int doc)
default void	setNextAggregationValue(java.lang.Object value) Sets per-document aggregation _value.
void	setSource(java.util.Map<java.lang.String,java.lang.Object> source)

Methods inherited from interface org.elasticsearch.common.lucene.ScorerAware

setScorer

Methods inherited from interface org.elasticsearch.script.ExecutableScript

run, setNextVar, unwrap

Method Detail

setDocument

void setDocument(int doc)

setSource

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

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

runAsLong

long runAsLong()

runAsDouble

double runAsDouble()