Package 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.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.DeferableBucketAggregator

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

org.elasticsearch.search.aggregations.bucket.terms.StringTermsAggregator

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.search.Collector, Releasable

public class SignificantStringTermsAggregator
extends StringTermsAggregator

An aggregator of significant string values.

Nested Class Summary

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

Aggregator.Parser, Aggregator.SubAggCollectionMode

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

TermsAggregator.BucketCountThresholds

Field Summary

Fields

Modifier and Type	Field	Description
protected long	numCollectedDocs
protected boolean	showTermDocCountError
protected SignificantTermsAggregatorFactory	termsAggFactory

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

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, collectMode, format, order

Constructor Summary

Constructors

Constructor

Description

SignificantStringTermsAggregator(java.lang.String name, AggregatorFactories factories, ValuesSource valuesSource, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.StringFilter includeExclude, SearchContext aggregationContext, Aggregator parent, SignificanceHeuristic significanceHeuristic, SignificantTermsAggregatorFactory termsAggFactory, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
SignificantStringTerms	buildAggregation(long owningBucketOrdinal)	Build an aggregation for data that has been collected into bucket.
SignificantStringTerms	buildEmptyAggregation()	Build an empty aggregation.
void	doClose()	Release instance-specific data.
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

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

descendsFromBucketAggregator

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, getLeafCollector, metaData, name, parent, pipelineAggregators, postCollection, preCollection, preGetSubLeafCollectors, subAggregator, subAggregators, toString

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

wrap

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

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectExistingBucket, consumeBucketsAndMaybeBreak, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd

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

descendsFromGlobalAggregator, doPreCollection, getDeferringCollector, runDeferredCollections

Methods inherited from class java.lang.Object

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

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

needsScores

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

bucketComparator, shouldDefer

Field Detail

numCollectedDocs

protected long numCollectedDocs

termsAggFactory

protected final SignificantTermsAggregatorFactory termsAggFactory

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

SignificantStringTermsAggregator

public SignificantStringTermsAggregator(java.lang.String name,
                                        AggregatorFactories factories,
                                        ValuesSource valuesSource,
                                        DocValueFormat format,
                                        TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                        IncludeExclude.StringFilter includeExclude,
                                        SearchContext aggregationContext,
                                        Aggregator parent,
                                        SignificanceHeuristic significanceHeuristic,
                                        SignificantTermsAggregatorFactory termsAggFactory,
                                        java.util.List<PipelineAggregator> pipelineAggregators,
                                        java.util.Map<java.lang.String,java.lang.Object> metaData)
                                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
                                            LeafBucketCollector sub)
                                     throws java.io.IOException

Description copied from class: AggregatorBase

Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

Overrides:

getLeafCollector in class StringTermsAggregator

Throws:

java.io.IOException

buildAggregation

public SignificantStringTerms buildAggregation(long owningBucketOrdinal)
                                        throws java.io.IOException

Description copied from class: Aggregator

Build an aggregation for data that has been collected into bucket.

Overrides:

buildAggregation in class StringTermsAggregator

Throws:

java.io.IOException

buildEmptyAggregation

public SignificantStringTerms buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class StringTermsAggregator