java.lang.Object

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

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.search.Collector, Releasable

Direct Known Subclasses:: GlobalOrdinalsSignificantTermsAggregator

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 Description

static interface GlobalOrdinalsStringTermsAggregator.GlobalOrdLookupFunction

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	Description
`protected org.apache.lucene.util.LongBitSet`	`acceptedGlobalOrdinals`
`protected LongHash`	`bucketOrds`
`protected IncludeExclude.OrdinalsFilter`	`includeExclude`
`protected GlobalOrdinalsStringTermsAggregator.GlobalOrdLookupFunction`	`lookupGlobalOrd`
`protected boolean`	`showTermDocCountError`
`protected long`	`valueCount`
`protected ValuesSource.Bytes.WithOrdinals`	`valuesSource`

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

aggsUsedForSorting, bucketCountThresholds, collectMode, format, order

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors
Constructor	Description
GlobalOrdinalsStringTermsAggregator(java.lang.String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals valuesSource, BucketOrder order, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.OrdinalsFilter includeExclude, SearchContext context, Aggregator parent, boolean remapGlobalOrds, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	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 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.

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

bucketComparator, shouldDefer

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

descendsFromGlobalAggregator, doPreCollection, getDeferringCollector, runDeferredCollections

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

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

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, getLeafCollector, metaData, name, parent, pipelineAggregators, postCollection, preCollection, preGetSubLeafCollectors, scoreMode, subAggregator, subAggregators, toString

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

descendsFromBucketAggregator

Methods inherited from class java.lang.Object

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

Field Details
- valuesSource
  
  protected final ValuesSource.Bytes.WithOrdinals valuesSource
- includeExclude
  
  protected final IncludeExclude.OrdinalsFilter includeExclude
- acceptedGlobalOrdinals
  
  protected final org.apache.lucene.util.LongBitSet acceptedGlobalOrdinals
- valueCount
  
  protected final long valueCount
- lookupGlobalOrd
  
  protected final GlobalOrdinalsStringTermsAggregator.GlobalOrdLookupFunction lookupGlobalOrd
- bucketOrds
  
  protected final LongHash bucketOrds
- showTermDocCountError
  
  protected final boolean showTermDocCountError
Constructor Details
- GlobalOrdinalsStringTermsAggregator
  
  public GlobalOrdinalsStringTermsAggregator(java.lang.String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals valuesSource, BucketOrder order, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.OrdinalsFilter includeExclude, SearchContext context, Aggregator parent, boolean remapGlobalOrds, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- getLeafCollector
  
  public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub) throws java.io.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:
  
  java.io.IOException
- copy
  
  protected static void copy(org.apache.lucene.util.BytesRef from, org.apache.lucene.util.BytesRef to)
- buildAggregation
  
  public InternalAggregation buildAggregation(long owningBucketOrdinal) throws java.io.IOException
  
  Description copied from class: Aggregator
  
  Build an aggregation for data that has been collected into bucket.
  
  Specified by:
  
  buildAggregation in class Aggregator
  
  Throws:
  
  java.io.IOException
- 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

Class GlobalOrdinalsStringTermsAggregator

Nested Class Summary

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

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