Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class InternalNumericMetricsAggregation.SingleValue

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

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

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalAvg, InternalBucketMetricValue, InternalCardinality, InternalMedianAbsoluteDeviation, InternalSimpleValue, InternalValueCount, InternalWeightedAvg, Max, Min, Sum

Enclosing class:

InternalNumericMetricsAggregation

public abstract static class InternalNumericMetricsAggregation.SingleValue
extends InternalNumericMetricsAggregation
implements NumericMetricsAggregation.SingleValue

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 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, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleValue(String name, DocValueFormat format, Map<String,Object> metadata)
protected	SingleValue(StreamInput in)	Read from a stream.
protected	SingleValue(StreamInput in, boolean readFormat)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
Object	getProperty(List<String> path)
String	getValueAsString()
final SortValue	sortValue(String key)	Get value to use when sorting by this aggregation.

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

equals, hashCode, mustReduceOnSingleInternalAgg, sortValue

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

canLeadReduction, copyWithRewritenBuckets, doWriteTo, doXContentBody, finalizeSampling, forEachBucket, getLeaderReducer, getMetadata, getName, getProperty, getReducer, getType, 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.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue

value

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

SingleValue

protected SingleValue(String name,
 DocValueFormat format,
 Map<String,Object> metadata)

SingleValue

protected SingleValue(StreamInput in)
               throws IOException

Read from a stream.

Throws:

IOException

SingleValue

protected SingleValue(StreamInput in,
 boolean readFormat)
               throws IOException

Read from a stream.

Parameters:

readFormat - whether to read the "format" field

Throws:

IOException

Method Details

getValueAsString

public String getValueAsString()

Specified by:

getValueAsString in interface NumericMetricsAggregation.SingleValue

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

sortValue

public final SortValue sortValue(String key)

Description copied from class: InternalAggregation

Get value to use when sorting by this aggregation.

Overrides:

sortValue in class InternalAggregation