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

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

All Implemented Interfaces:

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

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.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected long	numCollectedDocs

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

bucketOrds, valuesSource

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

aggsUsedForSorting, bucketCountThresholds, collectMode, format, order

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

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

Modifier and Type	Method	Description
SignificantLongTerms	buildAggregation(long owningBucketOrdinal)	Build an aggregation for data that has been collected into bucket.
SignificantLongTerms	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.bucket.terms.LongTermsAggregator

getValues, needsScores

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

bucketComparator, shouldDefer

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

descendsFromGlobalAggregator, doPreCollection, getDeferringCollector, runDeferredCollections

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

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

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

descendsFromBucketAggregator

Methods inherited from class java.lang.Object

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

Field Detail

numCollectedDocs

protected long numCollectedDocs

Constructor Detail

SignificantLongTermsAggregator

public SignificantLongTermsAggregator(java.lang.String name,
                                      AggregatorFactories factories,
                                      ValuesSource.Numeric valuesSource,
                                      DocValueFormat format,
                                      TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                      SearchContext context,
                                      Aggregator parent,
                                      SignificanceHeuristic significanceHeuristic,
                                      SignificantTermsAggregatorFactory termsAggFactory,
                                      IncludeExclude.LongFilter includeExclude,
                                      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 LongTermsAggregator

Throws:

java.io.IOException

buildAggregation

public SignificantLongTerms 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 LongTermsAggregator

Throws:

java.io.IOException

buildEmptyAggregation

public SignificantLongTerms buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Overrides:

buildEmptyAggregation in class LongTermsAggregator

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class LongTermsAggregator