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

Class SignificantTextAggregatorFactory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory<SignificantTextAggregatorFactory>

org.elasticsearch.search.aggregations.bucket.significant.SignificantTextAggregatorFactory

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Releasable

public class SignificantTextAggregatorFactory
extends AggregatorFactory<SignificantTextAggregatorFactory>
implements Releasable

Nested Class Summary

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

AggregatorFactory.MultiBucketAggregatorWrapper

Field Summary

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

context, factories, metaData, name, parent

Constructor Summary

Constructors

Constructor

Description

SignificantTextAggregatorFactory(java.lang.String name, IncludeExclude includeExclude, QueryBuilder filterBuilder, TermsAggregator.BucketCountThresholds bucketCountThresholds, SignificanceHeuristic significanceHeuristic, SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder, 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
void	close()
protected Aggregator	createInternal(Aggregator parent, boolean collectsFromSingleBucket, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)
long	getBackgroundFrequency(org.apache.lucene.util.BytesRef termBytes)
long	getSupersetNumDocs()	Get the number of docs in the superset.

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

asMultiBucketAggregator, create, doValidate, getParent, name

Methods inherited from class java.lang.Object

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

Constructor Detail

SignificantTextAggregatorFactory

public SignificantTextAggregatorFactory(java.lang.String name,
                                        IncludeExclude includeExclude,
                                        QueryBuilder filterBuilder,
                                        TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                        SignificanceHeuristic significanceHeuristic,
                                        SearchContext context,
                                        AggregatorFactory<?> parent,
                                        AggregatorFactories.Builder subFactoriesBuilder,
                                        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

getSupersetNumDocs

public long getSupersetNumDocs()

Get the number of docs in the superset.

getBackgroundFrequency

public long getBackgroundFrequency(org.apache.lucene.util.BytesRef termBytes)
                            throws java.io.IOException

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable

createInternal

protected Aggregator createInternal(Aggregator parent,
                                    boolean collectsFromSingleBucket,
                                    java.util.List<PipelineAggregator> pipelineAggregators,
                                    java.util.Map<java.lang.String,java.lang.Object> metaData)
                             throws java.io.IOException

Specified by:

createInternal in class AggregatorFactory<SignificantTextAggregatorFactory>

Throws:

java.io.IOException