org.elasticsearch.search.aggregations.bucket.terms

Class LongTermsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

org.elasticsearch.search.aggregations.bucket.terms.LongTermsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

DoubleTermsAggregator, SignificantLongTermsAggregator

public class LongTermsAggregator
extends TermsAggregator

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

TermsAggregator.BucketCountThresholds

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

Aggregator.BucketAggregationMode, Aggregator.Parser, Aggregator.SubAggCollectionMode

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

BucketCollector.BucketAnalysisCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected LongHash	bucketOrds
protected ValueFormatter	formatter
protected ValuesSource.Numeric	valuesSource

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

aggsUsedForSorting, bucketCountThresholds, order, subAggCollectMode

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

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description

LongTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Numeric valuesSource, ValueFormat format, long estimatedBucketCount, Terms.Order order, TermsAggregator.BucketCountThresholds bucketCountThresholds, AggregationContext aggregationContext, Aggregator parent, Aggregator.SubAggCollectionMode subAggCollectMode, boolean showTermDocCountError, IncludeExclude.LongFilter longFilter)

Method Summary

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)
InternalAggregation	buildEmptyAggregation()
void	collect(int doc, long owningBucketOrdinal) Called during the query phase, to collect & aggregate the given document.
void	doClose() Release instance-specific data.
protected org.apache.lucene.index.SortedNumericDocValues	getValues(ValuesSource.Numeric valuesSource)
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)
boolean	shouldCollect()

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

shouldDefer

Methods inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectBucketNoCounts, collectExistingBucket, getDocCounts, incrementBucketDocCount, maxBucketOrd

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

bucketAggregationMode, buildEmptySubAggregations, context, depth, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, subAggregator, subAggregators

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

wrap

Methods inherited from class java.lang.Object

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

Field Detail

valuesSource

protected final ValuesSource.Numeric valuesSource

formatter

@Nullable
protected final ValueFormatter formatter

bucketOrds

protected final LongHash bucketOrds

Constructor Detail

LongTermsAggregator

public LongTermsAggregator(String name,
                           AggregatorFactories factories,
                           ValuesSource.Numeric valuesSource,
                           @Nullable
                           ValueFormat format,
                           long estimatedBucketCount,
                           Terms.Order order,
                           TermsAggregator.BucketCountThresholds bucketCountThresholds,
                           AggregationContext aggregationContext,
                           Aggregator parent,
                           Aggregator.SubAggCollectionMode subAggCollectMode,
                           boolean showTermDocCountError,
                           IncludeExclude.LongFilter longFilter)

Method Detail

shouldCollect

public boolean shouldCollect()

Specified by:

shouldCollect in class Aggregator

Returns:

Whether this aggregator is in the state where it can collect documents. Some aggregators can do their aggregations without actually collecting documents, for example, an aggregator that computes stats over unmapped fields doesn't need to collect anything as it knows to just return "empty" stats as the aggregation result.

getValues

protected org.apache.lucene.index.SortedNumericDocValues getValues(ValuesSource.Numeric valuesSource)

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

collect

public void collect(int doc,
                    long owningBucketOrdinal)
             throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

owningBucketOrdinal - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)

Specified by:

buildAggregation in class Aggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator

doClose

public void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class Aggregator