org.elasticsearch.search.aggregations.bucket.significant

Class SignificantTermsAggregatorFactory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory

org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory

org.elasticsearch.search.aggregations.bucket.significant.SignificantTermsAggregatorFactory

All Implemented Interfaces:

AutoCloseable, Releasable

public class SignificantTermsAggregatorFactory
extends ValuesSourceAggregatorFactory
implements Releasable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignificantTermsAggregatorFactory.ExecutionMode

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

ValuesSourceAggregatorFactory.LeafOnly<VS extends ValuesSource>

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory

config

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

factories, name, parent, type

Constructor Summary

Constructors

Constructor and Description
SignificantTermsAggregatorFactory(String name, ValuesSourceConfig valueSourceConfig, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude includeExclude, String executionHint, org.apache.lucene.search.Filter filter, SignificanceHeuristic significanceHeuristic)

Method Summary

Modifier and Type	Method and Description
void	close()
protected Aggregator	create(ValuesSource valuesSource, long expectedBucketsCount, AggregationContext aggregationContext, Aggregator parent)
protected Aggregator	createUnmapped(AggregationContext aggregationContext, Aggregator parent)
long	getBackgroundFrequency(org.apache.lucene.util.BytesRef termBytes)
long	getBackgroundFrequency(long term)
protected TermsAggregator.BucketCountThresholds	getBucketCountThresholds()
SignificanceHeuristic	getSignificanceHeuristic()
long	prepareBackground(AggregationContext context) Creates the TermsEnum (if not already created) and must be called before any calls to getBackgroundFrequency

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory

create, doValidate

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

parent, subFactories, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SignificantTermsAggregatorFactory

public SignificantTermsAggregatorFactory(String name,
                                         ValuesSourceConfig valueSourceConfig,
                                         TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                         IncludeExclude includeExclude,
                                         String executionHint,
                                         org.apache.lucene.search.Filter filter,
                                         SignificanceHeuristic significanceHeuristic)

Method Detail

getSignificanceHeuristic

public SignificanceHeuristic getSignificanceHeuristic()

getBucketCountThresholds

protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()

createUnmapped

protected Aggregator createUnmapped(AggregationContext aggregationContext,
                                    Aggregator parent)

Specified by:

createUnmapped in class ValuesSourceAggregatorFactory

create

protected Aggregator create(ValuesSource valuesSource,
                            long expectedBucketsCount,
                            AggregationContext aggregationContext,
                            Aggregator parent)

Specified by:

create in class ValuesSourceAggregatorFactory

prepareBackground

public long prepareBackground(AggregationContext context)

Creates the TermsEnum (if not already created) and must be called before any calls to getBackgroundFrequency

Parameters:

context - The aggregation context

Returns:

The number of documents in the index (after an optional filter might have been applied)

getBackgroundFrequency

public long getBackgroundFrequency(org.apache.lucene.util.BytesRef termBytes)

getBackgroundFrequency

public long getBackgroundFrequency(long term)

close

public void close()
           throws ElasticsearchException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

Throws:

ElasticsearchException