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.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

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

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

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.util.LongBitSet	acceptedGlobalOrdinals
protected org.apache.lucene.index.RandomAccessOrds	globalOrds
protected IncludeExclude.OrdinalsFilter	includeExclude
protected boolean	showTermDocCountError
protected ValuesSource.Bytes.WithOrdinals	valuesSource

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

GlobalOrdinalsStringTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals valuesSource, Terms.Order order, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.OrdinalsFilter 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.
protected static void	copy(org.apache.lucene.util.BytesRef from, org.apache.lucene.util.BytesRef to)
protected long	getBucketOrd(long termOrd)
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub) Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.
protected LeafBucketCollector	newCollector(org.apache.lucene.index.RandomAccessOrds ords, LeafBucketCollector sub)

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, doClose, doPostCollection, doPreCollection, getDeferringCollector, getLeafCollector, metaData, name, needsScores, 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

valuesSource

protected final ValuesSource.Bytes.WithOrdinals valuesSource

includeExclude

protected final IncludeExclude.OrdinalsFilter includeExclude

acceptedGlobalOrdinals

protected org.apache.lucene.util.LongBitSet acceptedGlobalOrdinals

globalOrds

protected org.apache.lucene.index.RandomAccessOrds globalOrds

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

GlobalOrdinalsStringTermsAggregator

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

Throws:

IOException

Method Detail

getBucketOrd

protected long getBucketOrd(long termOrd)

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

newCollector

protected LeafBucketCollector newCollector(org.apache.lucene.index.RandomAccessOrds ords,
                               LeafBucketCollector sub)

copy

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

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

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator