Package org.elasticsearch.search.aggregations.metrics

Class ParsedExtendedStats

java.lang.Object

org.elasticsearch.search.aggregations.ParsedAggregation

org.elasticsearch.search.aggregations.metrics.ParsedStats

org.elasticsearch.search.aggregations.metrics.ParsedExtendedStats

All Implemented Interfaces:

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

Direct Known Subclasses:

ParsedExtendedStatsBucket

public class ParsedExtendedStats
extends ParsedStats
implements ExtendedStats

Nested Class Summary

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.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
protected double	avg
protected double	stdDeviation
protected double	stdDeviationBoundLower
protected double	stdDeviationBoundUpper
protected double	sum
protected double	sumOfSquares
protected double	variance

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

count, max, min, valueAsString

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

metadata

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedExtendedStats()

Method Summary

Modifier and Type	Method	Description
protected static void	declareExtendedStatsFields(ObjectParser<? extends ParsedExtendedStats,java.lang.Void> objectParser)
static ParsedExtendedStats	fromXContent(XContentParser parser, java.lang.String name)
double	getStdDeviation()	The standard deviation of the collected values.
java.lang.String	getStdDeviationAsString()	The standard deviation of the collected values as a String.
double	getStdDeviationBound(ExtendedStats.Bounds bound)	The upper or lower bounds of the stdDeviation
java.lang.String	getStdDeviationBoundAsString(ExtendedStats.Bounds bound)	The upper or lower bounds of stdDev of the collected values as a String.
double	getSumOfSquares()	The sum of the squares of the collected values.
java.lang.String	getSumOfSquaresAsString()	The sum of the squares of the collected values as a String.
java.lang.String	getType()
double	getVariance()	The variance of the collected values.
java.lang.String	getVarianceAsString()	The variance of the collected values as a String.
protected XContentBuilder	otherStatsToXContent(XContentBuilder builder, ToXContent.Params params)

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

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

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

declareAggregationFields, getMetaData, getName, parseDouble, setName, toXContent

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

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.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

sumOfSquares

protected double sumOfSquares

variance

protected double variance

stdDeviation

protected double stdDeviation

stdDeviationBoundUpper

protected double stdDeviationBoundUpper

stdDeviationBoundLower

protected double stdDeviationBoundLower

sum

protected double sum

avg

protected double avg

Constructor Detail

ParsedExtendedStats

public ParsedExtendedStats()

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in interface Aggregation

Overrides:

getType in class ParsedStats

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

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 variance of the collected values.

Specified by:

getVariance in interface ExtendedStats

getStdDeviation

public double getStdDeviation()

Description copied from interface: ExtendedStats

The standard deviation of the collected values.

Specified by:

getStdDeviation 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

getStdDeviationAsString

public java.lang.String getStdDeviationAsString()

Description copied from interface: ExtendedStats

The standard deviation of the collected values as a String.

Specified by:

getStdDeviationAsString in interface ExtendedStats

getStdDeviationBoundAsString

public java.lang.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

getSumOfSquaresAsString

public java.lang.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 java.lang.String getVarianceAsString()

Description copied from interface: ExtendedStats

The variance of the collected values as a String.

Specified by:

getVarianceAsString in interface ExtendedStats

otherStatsToXContent

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

Overrides:

otherStatsToXContent in class ParsedStats

Throws:

java.io.IOException

declareExtendedStatsFields

protected static void declareExtendedStatsFields(ObjectParser<? extends ParsedExtendedStats,java.lang.Void> objectParser)

fromXContent

public static ParsedExtendedStats fromXContent(XContentParser parser,
                                               java.lang.String name)