Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class InternalStats

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue

org.elasticsearch.search.aggregations.metrics.InternalStats

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, Stats, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalExtendedStats, InternalStatsBucket

public class InternalStats
extends InternalNumericMetricsAggregation.MultiValue
implements Stats

Nested Class Summary

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

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregation

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final long	count
protected final double	max
protected final double	min
protected final double	sum

Fields inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

format

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

metadata, name

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalStats(String name, long count, double sum, double min, double max, DocValueFormat formatter, Map<String,Object> metadata)
InternalStats(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected final void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
InternalAggregation	finalizeSampling(SamplingContext samplingContext)	Called by the parent sampling context.
double	getAvg()
String	getAvgAsString()
long	getCount()
double	getMax()
String	getMaxAsString()
double	getMin()
String	getMinAsString()
double	getSum()
String	getSumAsString()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
protected XContentBuilder	otherStatsToXContent(XContentBuilder builder, ToXContent.Params params)
InternalStats	reduce(List<InternalAggregation> aggregations, AggregationReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
double	value(String name)	Return the result of 1 value by name
Iterable<String>	valueNames()	Return an iterable over all value names this multi value aggregation provides.
protected void	writeOtherStatsTo(StreamOutput out)

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

getProperty, sortValue, valueAsString

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

mustReduceOnSingleInternalAgg, sortValue

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

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, readSize, reducePipelines, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetadata, getName, getType

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

count

protected final long count

min

protected final double min

max

protected final double max

sum

protected final double sum

Constructor Details

InternalStats

public InternalStats(String name,
 long count,
 double sum,
 double min,
 double max,
 DocValueFormat formatter,
 Map<String,Object> metadata)

InternalStats

public InternalStats(StreamInput in)
              throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

writeOtherStatsTo

protected void writeOtherStatsTo(StreamOutput out)
                          throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getCount

public long getCount()

Specified by:

getCount in interface Stats

Returns:

The number of values that were aggregated.

getMin

public double getMin()

Specified by:

getMin in interface Stats

Returns:

The minimum value of all aggregated values.

getMax

public double getMax()

Specified by:

getMax in interface Stats

Returns:

The maximum value of all aggregated values.

getAvg

public double getAvg()

Specified by:

getAvg in interface Stats

Returns:

The avg value over all aggregated values.

getSum

public double getSum()

Specified by:

getSum in interface Stats

Returns:

The sum of aggregated values.

getMinAsString

public String getMinAsString()

Specified by:

getMinAsString in interface Stats

Returns:

The minimum value of all aggregated values as a String.

getMaxAsString

public String getMaxAsString()

Specified by:

getMaxAsString in interface Stats

Returns:

The maximum value of all aggregated values as a String.

getAvgAsString

public String getAvgAsString()

Specified by:

getAvgAsString in interface Stats

Returns:

The avg value over all aggregated values as a String.

getSumAsString

public String getSumAsString()

Specified by:

getSumAsString in interface Stats

Returns:

The sum of aggregated values as a String.

value

public double value(String name)

Description copied from interface: NumericMetricsAggregation.MultiValue

Return the result of 1 value by name

Specified by:

value in interface NumericMetricsAggregation.MultiValue

Specified by:

value in class InternalNumericMetricsAggregation.MultiValue

Parameters:

name - of the value

Returns:

the value

valueNames

public Iterable<String> valueNames()

Description copied from interface: NumericMetricsAggregation.MultiValue

Return an iterable over all value names this multi value aggregation provides. The iterable might be created on the fly, if you need to call this multiple times, please cache the result in a variable on caller side..

Specified by:

valueNames in interface NumericMetricsAggregation.MultiValue

Returns:

iterable over all value names

reduce

public InternalStats reduce(List<InternalAggregation> aggregations,
 AggregationReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

finalizeSampling

public InternalAggregation finalizeSampling(SamplingContext samplingContext)

Description copied from class: InternalAggregation

Called by the parent sampling context. Should only ever be called once as some aggregations scale their internal values

Overrides:

finalizeSampling in class InternalAggregation

Parameters:

samplingContext - the current sampling context

Returns:

new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

otherStatsToXContent

protected XContentBuilder otherStatsToXContent(XContentBuilder builder,
 ToXContent.Params params)
                                        throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalNumericMetricsAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalNumericMetricsAggregation