Class ValueCountAggregator
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
org.elasticsearch.search.aggregations.metrics.ValueCountAggregator
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,org.apache.lucene.search.Collector
,Releasable
public class ValueCountAggregator extends NumericMetricsAggregator.SingleValue
A field data based aggregator that counts the number of values a specific field has within the aggregation context.
This aggregator works in a multi-bucket mode, that is, when serves as a sub-aggregator, a single aggregator instance aggregates the
counts for all buckets owned by the parent aggregator)
-
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, context, DEFAULT_WEIGHT, name, parent, subAggregators
-
Constructor Summary
Constructors Constructor Description ValueCountAggregator(java.lang.String name, ValuesSourceConfig valuesSourceConfig, SearchContext aggregationContext, Aggregator parent, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description InternalAggregation
buildAggregation(long bucket)
Build an aggregation for data that has been collected intoowningBucketOrd
.InternalAggregation
buildEmptyAggregation()
Build an empty aggregation.void
doClose()
Release instance-specific data.LeafBucketCollector
getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)
Get aLeafBucketCollector
for the given ctx, which should delegate to the given collector.double
metric(long owningBucketOrd)
org.apache.lucene.search.ScoreMode
scoreMode()
Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.Methods inherited from class org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregator.SingleValue
bucketComparator
Methods inherited from class org.elasticsearch.search.aggregations.metrics.MetricsAggregator
buildAggregations
Methods inherited from class org.elasticsearch.search.aggregations.AggregatorBase
addRequestCircuitBreakerBytes, buildEmptySubAggregations, close, context, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, preGetSubLeafCollectors, subAggregator, subAggregators, toString
Methods inherited from class org.elasticsearch.search.aggregations.Aggregator
buildTopLevel, collectDebugInfo, resolveSortPath, resolveSortPathOnValidAgg
-
Constructor Details
-
ValueCountAggregator
public ValueCountAggregator(java.lang.String name, ValuesSourceConfig valuesSourceConfig, SearchContext aggregationContext, Aggregator parent, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException- Throws:
java.io.IOException
-
-
Method Details
-
getLeafCollector
public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub) throws java.io.IOExceptionDescription copied from class:AggregatorBase
Get aLeafBucketCollector
for the given ctx, which should delegate to the given collector.- Specified by:
getLeafCollector
in classAggregatorBase
- Throws:
java.io.IOException
-
metric
public double metric(long owningBucketOrd)- Specified by:
metric
in classNumericMetricsAggregator.SingleValue
-
buildAggregation
Description copied from class:MetricsAggregator
Build an aggregation for data that has been collected intoowningBucketOrd
.- Specified by:
buildAggregation
in classMetricsAggregator
-
scoreMode
public org.apache.lucene.search.ScoreMode scoreMode()Description copied from class:AggregatorBase
Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.- Specified by:
scoreMode
in interfaceorg.apache.lucene.search.Collector
- Overrides:
scoreMode
in classAggregatorBase
-
buildEmptyAggregation
Description copied from class:Aggregator
Build an empty aggregation.- Specified by:
buildEmptyAggregation
in classAggregator
-
doClose
public void doClose()Description copied from class:AggregatorBase
Release instance-specific data.- Overrides:
doClose
in classAggregatorBase
-