Package org.opensearch.search.aggregations.bucket.terms

Class MapStringTermsAggregator

java.lang.Object

org.opensearch.search.aggregations.BucketCollector

org.opensearch.search.aggregations.Aggregator

org.opensearch.search.aggregations.AggregatorBase

org.opensearch.search.aggregations.bucket.BucketsAggregator

org.opensearch.search.aggregations.bucket.DeferableBucketAggregator

org.opensearch.search.aggregations.bucket.terms.TermsAggregator

org.opensearch.search.aggregations.bucket.terms.MapStringTermsAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.opensearch.common.lease.Releasable

public class MapStringTermsAggregator
extends TermsAggregator

An aggregator of string values that hashes the strings on the fly rather than up front like the GlobalOrdinalsStringTermsAggregator.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MapStringTermsAggregator.CollectConsumer	Consumer for the collector
static interface	MapStringTermsAggregator.CollectorSource	Abstaction on top of building collectors to fetch values.
static class	MapStringTermsAggregator.ValuesSourceCollectorSource	Fetch values from a ValuesSource.

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

TermsAggregator.BucketCountThresholds, TermsAggregator.CoordinatorBucketCountThresholds

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	showTermDocCountError

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

aggsUsedForSorting, bucketCountThresholds, collectMode, format, order, partiallyBuiltBucketComparator

Fields inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

docCountProvider

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor

Description

MapStringTermsAggregator(String name, AggregatorFactories factories, MapStringTermsAggregator.CollectorSource collectorSource, Function<MapStringTermsAggregator,org.opensearch.search.aggregations.bucket.terms.MapStringTermsAggregator.ResultStrategy<?,?>> resultStrategy, BucketOrder order, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.StringFilter includeExclude, SearchContext context, Aggregator parent, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, CardinalityUpperBound cardinality, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
InternalAggregation[]	buildAggregations(long[] owningBucketOrds)	Build the results of this aggregation.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
protected SignificantStringTerms	buildEmptySignificantTermsAggregation(long subsetSize, SignificanceHeuristic significanceHeuristic)
protected StringTerms	buildEmptyTermsAggregation()
void	collectDebugInfo(BiConsumer<String,Object> add)	Collect debug information to add to the profiling results.
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.
org.apache.lucene.search.ScoreMode	scoreMode()	Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

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

shouldDefer

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

beforeBuildingBuckets, doPreCollection, getDeferringCollector

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

bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, mergeBuckets, mergeBuckets, preGetSubLeafCollectors, resolveSortPath

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, subAggregator, subAggregators, toString

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

buildTopLevel, getPostCollectionAggregation, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Field Details

showTermDocCountError

protected final boolean showTermDocCountError

Constructor Details

MapStringTermsAggregator

public MapStringTermsAggregator(String name,
 AggregatorFactories factories,
 MapStringTermsAggregator.CollectorSource collectorSource,
 Function<MapStringTermsAggregator,org.opensearch.search.aggregations.bucket.terms.MapStringTermsAggregator.ResultStrategy<?,?>> resultStrategy,
 BucketOrder order,
 DocValueFormat format,
 TermsAggregator.BucketCountThresholds bucketCountThresholds,
 IncludeExclude.StringFilter includeExclude,
 SearchContext context,
 Aggregator parent,
 Aggregator.SubAggCollectionMode collectionMode,
 boolean showTermDocCountError,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                         throws IOException

Throws:

IOException

Method Details

scoreMode

public org.apache.lucene.search.ScoreMode scoreMode()

Description copied from class: AggregatorBase

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

Specified by:

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

Overrides:

scoreMode 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

buildAggregations

public InternalAggregation[] buildAggregations(long[] owningBucketOrds)
                                        throws IOException

Description copied from class: Aggregator

Build the results of this aggregation.

Specified by:

buildAggregations in class Aggregator

Parameters:

owningBucketOrds - the ordinals of the buckets that we want to collect from this aggregation

Returns:

the results for each ordinal, in the same order as the array of ordinals

Throws:

IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

collectDebugInfo

public void collectDebugInfo(BiConsumer<String,Object> add)

Description copied from class: Aggregator

Collect debug information to add to the profiling results. This will only be called if the aggregation is being profiled.

Well behaved implementations will always call the superclass implementation just in case it has something interesting. They will also only add objects which can be serialized with StreamOutput.writeGenericValue(Object) and XContentBuilder.value(Object). And they'll have an integration test.

Overrides:

collectDebugInfo in class DeferableBucketAggregator

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase

buildEmptyTermsAggregation

protected StringTerms buildEmptyTermsAggregation()

buildEmptySignificantTermsAggregation

protected SignificantStringTerms buildEmptySignificantTermsAggregation(long subsetSize,
 SignificanceHeuristic significanceHeuristic)