org.elasticsearch.search.aggregations.bucket.significant

Class SignificantStringTermsAggregator

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.StringTermsAggregator

org.elasticsearch.search.aggregations.bucket.significant.SignificantStringTermsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

public class SignificantStringTermsAggregator
extends StringTermsAggregator

An aggregator of significant string values.

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
protected boolean	showTermDocCountError
protected SignificantTermsAggregatorFactory	termsAggFactory

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

bucketOrds

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
SignificantStringTermsAggregator(String name, AggregatorFactories factories, ValuesSource valuesSource, long estimatedBucketCount, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude includeExclude, AggregationContext aggregationContext, Aggregator parent, SignificantTermsAggregatorFactory termsAggFactory)

Method Summary

Modifier and Type	Method and Description
SignificantStringTerms	buildAggregation(long owningBucketOrdinal)
SignificantStringTerms	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.StringTermsAggregator

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

termsAggFactory

protected final SignificantTermsAggregatorFactory termsAggFactory

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

SignificantStringTermsAggregator

public SignificantStringTermsAggregator(String name,
                                        AggregatorFactories factories,
                                        ValuesSource valuesSource,
                                        long estimatedBucketCount,
                                        TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                        IncludeExclude includeExclude,
                                        AggregationContext aggregationContext,
                                        Aggregator parent,
                                        SignificantTermsAggregatorFactory termsAggFactory)

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 StringTermsAggregator

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

Overrides:

buildAggregation in class StringTermsAggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public SignificantStringTerms buildEmptyAggregation()

doClose

public void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class StringTermsAggregator