org.elasticsearch.search.aggregations.metrics.avg

Class InternalAvg

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalMetricsAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

org.elasticsearch.search.aggregations.metrics.avg.InternalAvg

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, Avg, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue

public class InternalAvg
extends InternalNumericMetricsAggregation.SingleValue
implements Avg

Nested Class Summary

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

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

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.search.aggregations.metrics.NumericMetricsAggregation

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

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.metrics.InternalNumericMetricsAggregation

valueFormatter

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
InternalAvg(String name, double sum, long count, ValueFormatter formatter, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Modifier and Type	Method and Description
protected void	doReadFrom(StreamInput in)
InternalAvg	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
double	getValue() The average value.
static void	registerStreams()
InternalAggregation.Type	type()
double	value()

Methods inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

getProperty, getValueAsString

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.metrics.NumericMetricsAggregation.SingleValue

getValueAsString

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

InternalAvg

public InternalAvg(String name,
                   double sum,
                   long count,
                   ValueFormatter formatter,
                   List<PipelineAggregator> pipelineAggregators,
                   Map<String,Object> metaData)

Method Detail

registerStreams

public static void registerStreams()

value

public double value()

Specified by:

value in interface NumericMetricsAggregation.SingleValue

getValue

public double getValue()

Description copied from interface: Avg

The average value.

Specified by:

getValue in interface Avg

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

doReduce

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

Specified by:

doReduce 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