org.elasticsearch.search.aggregations.bucket.terms

Class StringTermsAggregator

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.terms.TermsAggregator

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

All Implemented Interfaces:

AutoCloseable, org.apache.lucene.search.Collector, Releasable

Direct Known Subclasses:

SignificantStringTermsAggregator

public class StringTermsAggregator
extends TermsAggregator

An aggregator of string values.

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 and Description
protected BytesRefHash	bucketOrds
protected boolean	showTermDocCountError

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

aggsUsedForSorting, bucketCountThresholds, collectMode, order

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

collectableSubAggregators, context, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description

StringTermsAggregator(String name, AggregatorFactories factories, ValuesSource valuesSource, Terms.Order order, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.StringFilter includeExclude, AggregationContext aggregationContext, Aggregator parent, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal) Build an aggregation for data that has been collected into bucket.
InternalAggregation	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.
boolean	needsScores() Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

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

shouldDefer

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

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

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

buildEmptySubAggregations, context, doPostCollection, doPreCollection, getDeferringCollector, getLeafCollector, metaData, name, parent, pipelineAggregators, postCollection, preCollection, runDeferredCollections, subAggregator, subAggregators, toString

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

descendsFromBucketAggregator

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

wrap

Methods inherited from class java.lang.Object

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

Field Detail

bucketOrds

protected final BytesRefHash bucketOrds

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

StringTermsAggregator

public StringTermsAggregator(String name,
                     AggregatorFactories factories,
                     ValuesSource valuesSource,
                     Terms.Order order,
                     TermsAggregator.BucketCountThresholds bucketCountThresholds,
                     IncludeExclude.StringFilter includeExclude,
                     AggregationContext aggregationContext,
                     Aggregator parent,
                     Aggregator.SubAggCollectionMode collectionMode,
                     boolean showTermDocCountError,
                     List<PipelineAggregator> pipelineAggregators,
                     Map<String,Object> metaData)
                      throws IOException

Throws:

IOException

Method Detail

needsScores

public boolean needsScores()

Description copied from class: AggregatorBase

Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

Specified by:

needsScores in interface org.apache.lucene.search.Collector

Overrides:

needsScores in class AggregatorBase

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
                                   LeafBucketCollector sub)
                                     throws 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:

IOException

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)
                                     throws IOException

Description copied from class: Aggregator

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

Specified by:

buildAggregation in class Aggregator

Throws:

IOException

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator