Package org.elasticsearch.search.aggregations.bucket.significant

Class SignificantTextAggregator

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.significant.SignificantTextAggregator

All Implemented Interfaces:

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

public class SignificantTextAggregator
extends BucketsAggregator

Nested Class Summary

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

Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected TermsAggregator.BucketCountThresholds	bucketCountThresholds
protected long	numCollectedDocs

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

SignificantTextAggregator(java.lang.String name, AggregatorFactories factories, SearchContext context, Aggregator parent, java.util.List<PipelineAggregator> pipelineAggregators, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.StringFilter includeExclude, SignificanceHeuristic significanceHeuristic, SignificantTextAggregatorFactory termsAggFactory, java.lang.String fieldName, java.lang.String[] sourceFieldNames, boolean filterDuplicateText, 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, doPreCollection, getLeafCollector, metaData, name, needsScores, 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 java.lang.Object

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

Field Detail

bucketCountThresholds

protected final TermsAggregator.BucketCountThresholds bucketCountThresholds

numCollectedDocs

protected long numCollectedDocs

Constructor Detail

SignificantTextAggregator

public SignificantTextAggregator(java.lang.String name,
                                 AggregatorFactories factories,
                                 SearchContext context,
                                 Aggregator parent,
                                 java.util.List<PipelineAggregator> pipelineAggregators,
                                 TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                 IncludeExclude.StringFilter includeExclude,
                                 SignificanceHeuristic significanceHeuristic,
                                 SignificantTextAggregatorFactory termsAggFactory,
                                 java.lang.String fieldName,
                                 java.lang.String[] sourceFieldNames,
                                 boolean filterDuplicateText,
                                 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.

Specified by:

getLeafCollector in class AggregatorBase

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.

Specified by:

buildAggregation in class Aggregator

Throws:

java.io.IOException

buildEmptyAggregation

public SignificantStringTerms buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase