org.elasticsearch.search.aggregations.bucket.significant

Class SignificantLongTermsAggregator

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

org.elasticsearch.search.aggregations.bucket.significant.SignificantLongTermsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

public class SignificantLongTermsAggregator
extends LongTermsAggregator

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 long	numCollectedDocs

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

bucketOrds, formatter, 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
SignificantLongTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Numeric valuesSource, ValueFormat format, long estimatedBucketCount, TermsAggregator.BucketCountThresholds bucketCountThresholds, AggregationContext aggregationContext, Aggregator parent, SignificantTermsAggregatorFactory termsAggFactory, IncludeExclude.LongFilter includeExclude)

Method Summary

Modifier and Type	Method and Description
SignificantLongTerms	buildAggregation(long owningBucketOrdinal)
SignificantLongTerms	buildEmptyAggregation()
void	collect(int doc, long owningBucketOrdinal) Called during the query phase, to collect & aggregate the given document.
void	doClose() Release instance-specific data.

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

getValues, setNextReader, 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

numCollectedDocs

protected long numCollectedDocs

Constructor Detail

SignificantLongTermsAggregator

public SignificantLongTermsAggregator(String name,
                                      AggregatorFactories factories,
                                      ValuesSource.Numeric valuesSource,
                                      @Nullable
                                      ValueFormat format,
                                      long estimatedBucketCount,
                                      TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                      AggregationContext aggregationContext,
                                      Aggregator parent,
                                      SignificantTermsAggregatorFactory termsAggFactory,
                                      IncludeExclude.LongFilter includeExclude)

Method Detail

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.

Overrides:

collect in class LongTermsAggregator

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 SignificantLongTerms buildAggregation(long owningBucketOrdinal)

Overrides:

buildAggregation in class LongTermsAggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public SignificantLongTerms buildEmptyAggregation()

Overrides:

buildEmptyAggregation in class LongTermsAggregator

doClose

public void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class LongTermsAggregator