org.elasticsearch.search.aggregations.bucket.terms

Class GlobalOrdinalsStringTermsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

GlobalOrdinalsSignificantTermsAggregator, GlobalOrdinalsStringTermsAggregator.LowCardinality, GlobalOrdinalsStringTermsAggregator.WithHash

public class GlobalOrdinalsStringTermsAggregator
extends TermsAggregator

An aggregator of string values that relies on global ordinals in order to build buckets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalOrdinalsStringTermsAggregator.LowCardinality Variant of GlobalOrdinalsStringTermsAggregator that resolves global ordinals post segment collection instead of on the fly for each match.This is beneficial for low cardinality fields, because it can reduce the amount of look-ups significantly.
static class	GlobalOrdinalsStringTermsAggregator.WithHash Variant of GlobalOrdinalsStringTermsAggregator that rebases hashes in order to make them dense.

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

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

BucketCollector.BucketAnalysisCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.util.LongBitSet	acceptedGlobalOrdinals
protected org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator.Collector	collector
protected org.apache.lucene.index.RandomAccessOrds	globalOrds
protected IncludeExclude	includeExclude
protected boolean	showTermDocCountError
protected ValuesSource.Bytes.WithOrdinals.FieldData	valuesSource

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

aggsUsedForSorting, bucketCountThresholds, order, subAggCollectMode

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

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description

GlobalOrdinalsStringTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals.FieldData valuesSource, long estimatedBucketCount, long maxOrd, Terms.Order order, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude includeExclude, AggregationContext aggregationContext, Aggregator parent, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError)

Method Summary

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)
InternalAggregation	buildEmptyAggregation()
void	collect(int doc, long owningBucketOrdinal) Called during the query phase, to collect & aggregate the given document.
protected static void	copy(org.apache.lucene.util.BytesRef from, org.apache.lucene.util.BytesRef to)
protected long	getBucketOrd(long termOrd)
protected org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator.Collector	newCollector(org.apache.lucene.index.RandomAccessOrds ords)
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)
boolean	shouldCollect()

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, collectBucketNoCounts, collectExistingBucket, getDocCounts, incrementBucketDocCount, maxBucketOrd

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

bucketAggregationMode, buildEmptySubAggregations, context, depth, doClose, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, subAggregator, subAggregators

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

wrap

Methods inherited from class java.lang.Object

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

Field Detail

valuesSource

protected final ValuesSource.Bytes.WithOrdinals.FieldData valuesSource

includeExclude

protected final IncludeExclude includeExclude

globalOrds

protected org.apache.lucene.index.RandomAccessOrds globalOrds

acceptedGlobalOrdinals

protected org.apache.lucene.util.LongBitSet acceptedGlobalOrdinals

collector

protected org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator.Collector collector

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

GlobalOrdinalsStringTermsAggregator

public GlobalOrdinalsStringTermsAggregator(String name,
                                           AggregatorFactories factories,
                                           ValuesSource.Bytes.WithOrdinals.FieldData valuesSource,
                                           long estimatedBucketCount,
                                           long maxOrd,
                                           Terms.Order order,
                                           TermsAggregator.BucketCountThresholds bucketCountThresholds,
                                           IncludeExclude includeExclude,
                                           AggregationContext aggregationContext,
                                           Aggregator parent,
                                           Aggregator.SubAggCollectionMode collectionMode,
                                           boolean showTermDocCountError)

Method Detail

getBucketOrd

protected long getBucketOrd(long termOrd)

shouldCollect

public boolean shouldCollect()

Returns:

Whether this aggregator is in the state where it can collect documents. Some aggregators can do their aggregations without actually collecting documents, for example, an aggregator that computes stats over unmapped fields doesn't need to collect anything as it knows to just return "empty" stats as the aggregation result.

newCollector

protected org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator.Collector newCollector(org.apache.lucene.index.RandomAccessOrds ords)

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

collect

public void collect(int doc,
                    long owningBucketOrdinal)
             throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

owningBucketOrdinal - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

copy

protected static void copy(org.apache.lucene.util.BytesRef from,
                           org.apache.lucene.util.BytesRef to)

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)

Specified by:

buildAggregation in class Aggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator