Package org.elasticsearch.search.aggregations.metrics

Class NumericMetricsAggregator.SingleValue

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.metrics.MetricsAggregator

org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator

org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator.SingleValue

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, Releasable

Direct Known Subclasses:

CardinalityAggregator, GlobalOrdCardinalityAggregator, MedianAbsoluteDeviationAggregator, MinAggregator, SumAggregator, ValueCountAggregator

Enclosing class:

NumericMetricsAggregator

public abstract static class NumericMetricsAggregator.SingleValue
extends NumericMetricsAggregator

Nested Class Summary

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

NumericMetricsAggregator.MultiValue, NumericMetricsAggregator.SingleValue

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

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

collectableSubAggregators, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleValue(String name, AggregationContext context, Aggregator parent, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
Aggregator.BucketComparator	bucketComparator(String key, SortOrder order)	Builds a comparator that compares two buckets aggregated by this Aggregator.
abstract double	metric(long owningBucketOrd)

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

buildAggregation, buildAggregations

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

addRequestCircuitBreakerBytes, bigArrays, buildEmptySubAggregations, close, doClose, doPostCollection, doPreCollection, getLeafCollector, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, preGetSubLeafCollectors, scoreMode, searcher, subAggregator, subAggregators, topLevelQuery, toString

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

buildEmptyAggregation, buildTopLevel, collectDebugInfo, resolveSortPath, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SingleValue

protected SingleValue(String name,
 AggregationContext context,
 Aggregator parent,
 Map<String,Object> metadata)
               throws IOException

Throws:

IOException

Method Details

metric

public abstract double metric(long owningBucketOrd)

bucketComparator

public Aggregator.BucketComparator bucketComparator(String key,
 SortOrder order)

Description copied from class: Aggregator

Builds a comparator that compares two buckets aggregated by this Aggregator.

The default implementation throws an exception but we override it on aggregations that support sorting.

Overrides:

bucketComparator in class Aggregator