Module org.elasticsearch.server

Package org.elasticsearch.script

Class AggregationScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AggregationScript

All Implemented Interfaces:

ScorerAware

public abstract class AggregationScript
extends DocBasedScript
implements ScorerAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AggregationScript.Factory	A factory to construct stateful AggregationScript factories for a specific index.
static interface	AggregationScript.LeafFactory	A factory to construct AggregationScript instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<AggregationScript.Factory>	CONTEXT
static final String[]	PARAMETERS
protected org.apache.lucene.search.Scorable	scorer	A scorer that will return the score for the current document when the script is run.

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AggregationScript()
	AggregationScript(Map<String,Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)

Method Summary

Modifier and Type	Method	Description
abstract Object	execute()
Number	get_score()
Object	get_value()
Map<String,Object>	getParams()	Return the parameters for this script.
double	runAsDouble()
long	runAsLong()	Return the result as a long.
void	setNextAggregationValue(Object value)	Sets per-document aggregation _value.
void	setScorer(org.apache.lucene.search.Scorable scorer)

Methods inherited from class org.elasticsearch.script.DocBasedScript

docAsMap, field, fields, getDoc, setDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARAMETERS

public static final String[] PARAMETERS

CONTEXT

public static final ScriptContext<AggregationScript.Factory> CONTEXT

scorer

protected org.apache.lucene.search.Scorable scorer

A scorer that will return the score for the current document when the script is run.

Constructor Details

AggregationScript

public AggregationScript(Map<String,Object> params,
 SearchLookup lookup,
 org.apache.lucene.index.LeafReaderContext leafContext)

AggregationScript

protected AggregationScript()

Method Details

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

setScorer

public void setScorer(org.apache.lucene.search.Scorable scorer)

Specified by:

setScorer in interface ScorerAware

setNextAggregationValue

public void setNextAggregationValue(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

get_score

public Number get_score()

get_value

public Object get_value()

runAsLong

public long runAsLong()

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

runAsDouble

public double runAsDouble()

execute

public abstract Object execute()