org.elasticsearch.search.aggregations.metrics.scripted

Class InternalScriptedMetric

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalMetricsAggregation

org.elasticsearch.search.aggregations.metrics.scripted.InternalScriptedMetric

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, ScriptedMetric

public class InternalScriptedMetric
extends InternalMetricsAggregation
implements ScriptedMetric

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static AggregationStreams.Stream	STREAM
static InternalAggregation.Type	TYPE

Fields inherited from class org.elasticsearch.search.aggregations.InternalAggregation

metaData, name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalScriptedMetric(String name, Object aggregation, Script reduceScript, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
Object	aggregation() The result of the aggregation.
protected void	doReadFrom(StreamInput in)
InternalAggregation	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
Object	getProperty(List<String> path)
static void	registerStreams()
InternalAggregation.Type	type()

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getProperty

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

STREAM

public static final AggregationStreams.Stream STREAM

Constructor Detail

InternalScriptedMetric

public InternalScriptedMetric(String name,
                      Object aggregation,
                      Script reduceScript,
                      List<PipelineAggregator> pipelineAggregators,
                      Map<String,Object> metaData)

Method Detail

registerStreams

public static void registerStreams()

aggregation

public Object aggregation()

Description copied from interface: ScriptedMetric

The result of the aggregation. The type of the object depends on the aggregation that was run.

Specified by:

aggregation in interface ScriptedMetric

doReduce

public InternalAggregation doReduce(List<InternalAggregation> aggregations,
                           InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

Specified by:

doReadFrom in class InternalAggregation

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                             ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException