Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class InternalExtendedStats

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

org.elasticsearch.search.aggregations.metrics.InternalExtendedStats

All Implemented Interfaces:

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

Direct Known Subclasses:

InternalExtendedStatsBucket

public class InternalExtendedStats
extends InternalStats
implements ExtendedStats

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.ExtendedStats

ExtendedStats.Bounds

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 inherited from class org.elasticsearch.search.aggregations.metrics.InternalStats

count, max, min, 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
InternalExtendedStats(String name, long count, double sum, double min, double max, double sumOfSqrs, double sigma, DocValueFormat formatter, Map<String,Object> metadata)
InternalExtendedStats(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
InternalAggregation	finalizeSampling(SamplingContext samplingContext)	Called by the parent sampling context.
double	getSigma()
double	getStdDeviation()	The population standard deviation of the collected values.
String	getStdDeviationAsString()	The population standard deviation of the collected values as a String.
double	getStdDeviationBound(ExtendedStats.Bounds bound)	The upper or lower bounds of the stdDeviation
String	getStdDeviationBoundAsString(ExtendedStats.Bounds bound)	The upper or lower bounds of stdDev of the collected values as a String.
double	getStdDeviationPopulation()	The population standard deviation of the collected values.
String	getStdDeviationPopulationAsString()	The population standard deviation of the collected values as a String.
double	getStdDeviationSampling()	The sampling standard deviation of the collected values.
String	getStdDeviationSamplingAsString()	The sampling standard deviation of the collected values as a String.
double	getSumOfSquares()	The sum of the squares of the collected values.
String	getSumOfSquaresAsString()	The sum of the squares of the collected values as a String.
double	getVariance()	The population variance of the collected values.
String	getVarianceAsString()	The population variance of the collected values as a String.
double	getVariancePopulation()	The population variance of the collected values.
String	getVariancePopulationAsString()	The population variance of the collected values as a String.
double	getVarianceSampling()	The sampling variance of the collected values.
String	getVarianceSamplingAsString()	The sampling variance of the collected values as a String.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
protected XContentBuilder	otherStatsToXContent(XContentBuilder builder, ToXContent.Params params)
InternalExtendedStats	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.InternalStats

doWriteTo, doXContentBody, getAvg, getAvgAsString, getCount, getMax, getMaxAsString, getMin, getMinAsString, getSum, getSumAsString

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

getAvg, getAvgAsString, getCount, getMax, getMaxAsString, getMin, getMinAsString, getSum, getSumAsString

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalExtendedStats

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

InternalExtendedStats

public InternalExtendedStats(StreamInput in)
                      throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeOtherStatsTo

protected void writeOtherStatsTo(StreamOutput out)
                          throws IOException

Overrides:

writeOtherStatsTo in class InternalStats

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class InternalStats

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

Overrides:

value in class InternalStats

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

Overrides:

valueNames in class InternalStats

Returns:

iterable over all value names

getSigma

public double getSigma()

getSumOfSquares

public double getSumOfSquares()

Description copied from interface: ExtendedStats

The sum of the squares of the collected values.

Specified by:

getSumOfSquares in interface ExtendedStats

getVariance

public double getVariance()

Description copied from interface: ExtendedStats

The population variance of the collected values.

Specified by:

getVariance in interface ExtendedStats

getVariancePopulation

public double getVariancePopulation()

Description copied from interface: ExtendedStats

The population variance of the collected values.

Specified by:

getVariancePopulation in interface ExtendedStats

getVarianceSampling

public double getVarianceSampling()

Description copied from interface: ExtendedStats

The sampling variance of the collected values.

Specified by:

getVarianceSampling in interface ExtendedStats

getStdDeviation

public double getStdDeviation()

Description copied from interface: ExtendedStats

The population standard deviation of the collected values.

Specified by:

getStdDeviation in interface ExtendedStats

getStdDeviationPopulation

public double getStdDeviationPopulation()

Description copied from interface: ExtendedStats

The population standard deviation of the collected values.

Specified by:

getStdDeviationPopulation in interface ExtendedStats

getStdDeviationSampling

public double getStdDeviationSampling()

Description copied from interface: ExtendedStats

The sampling standard deviation of the collected values.

Specified by:

getStdDeviationSampling in interface ExtendedStats

getStdDeviationBound

public double getStdDeviationBound(ExtendedStats.Bounds bound)

Description copied from interface: ExtendedStats

The upper or lower bounds of the stdDeviation

Specified by:

getStdDeviationBound in interface ExtendedStats

getSumOfSquaresAsString

public String getSumOfSquaresAsString()

Description copied from interface: ExtendedStats

The sum of the squares of the collected values as a String.

Specified by:

getSumOfSquaresAsString in interface ExtendedStats

getVarianceAsString

public String getVarianceAsString()

Description copied from interface: ExtendedStats

The population variance of the collected values as a String.

Specified by:

getVarianceAsString in interface ExtendedStats

getVariancePopulationAsString

public String getVariancePopulationAsString()

Description copied from interface: ExtendedStats

The population variance of the collected values as a String.

Specified by:

getVariancePopulationAsString in interface ExtendedStats

getVarianceSamplingAsString

public String getVarianceSamplingAsString()

Description copied from interface: ExtendedStats

The sampling variance of the collected values as a String.

Specified by:

getVarianceSamplingAsString in interface ExtendedStats

getStdDeviationAsString

public String getStdDeviationAsString()

Description copied from interface: ExtendedStats

The population standard deviation of the collected values as a String.

Specified by:

getStdDeviationAsString in interface ExtendedStats

getStdDeviationPopulationAsString

public String getStdDeviationPopulationAsString()

Description copied from interface: ExtendedStats

The population standard deviation of the collected values as a String.

Specified by:

getStdDeviationPopulationAsString in interface ExtendedStats

getStdDeviationSamplingAsString

public String getStdDeviationSamplingAsString()

Description copied from interface: ExtendedStats

The sampling standard deviation of the collected values as a String.

Specified by:

getStdDeviationSamplingAsString in interface ExtendedStats

getStdDeviationBoundAsString

public String getStdDeviationBoundAsString(ExtendedStats.Bounds bound)

Description copied from interface: ExtendedStats

The upper or lower bounds of stdDev of the collected values as a String.

Specified by:

getStdDeviationBoundAsString in interface ExtendedStats

reduce

public InternalExtendedStats 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.

Overrides:

reduce in class InternalStats

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 InternalStats

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

otherStatsToXContent

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

Overrides:

otherStatsToXContent in class InternalStats

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalStats

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalStats