org.elasticsearch.search.aggregations.bucket.terms

Class GlobalOrdinalsStringTermsAggregator.LowCardinality

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

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

All Implemented Interfaces:

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

Enclosing class:

GlobalOrdinalsStringTermsAggregator

public static class GlobalOrdinalsStringTermsAggregator.LowCardinality
extends GlobalOrdinalsStringTermsAggregator

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.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.GlobalOrdinalsStringTermsAggregator

GlobalOrdinalsStringTermsAggregator.LowCardinality, GlobalOrdinalsStringTermsAggregator.WithHash

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 boolean	showTermDocCountError

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

acceptedGlobalOrdinals, globalOrds, includeExclude, 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.LowCardinality(String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals valuesSource, Terms.Order order, TermsAggregator.BucketCountThresholds bucketCountThresholds, 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	buildEmptyAggregation() Build an empty aggregation.
protected void	doClose() Release instance-specific data.
protected void	doPostCollection() Can be overriden by aggregator implementation to be called back when the collection phase ends.
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.GlobalOrdinalsStringTermsAggregator

buildAggregation, copy, getBucketOrd

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, 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

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Detail

GlobalOrdinalsStringTermsAggregator.LowCardinality

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

Throws:

IOException

Method Detail

newCollector

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

Overrides:

newCollector in class GlobalOrdinalsStringTermsAggregator

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.

Overrides:

getLeafCollector in class GlobalOrdinalsStringTermsAggregator

Throws:

IOException

doPostCollection

protected void doPostCollection()

Description copied from class: AggregatorBase

Can be overriden by aggregator implementation to be called back when the collection phase ends.

Overrides:

doPostCollection in class AggregatorBase

doClose

protected 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