Package org.opensearch.search.aggregations.support

Class ValuesSourceAggregatorFactory

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactory

org.opensearch.search.aggregations.support.ValuesSourceAggregatorFactory

Direct Known Subclasses:

AbstractRangeAggregatorFactory, AutoDateHistogramAggregatorFactory, BinaryRangeAggregatorFactory, DateHistogramAggregatorFactory, DiversifiedAggregatorFactory, GeoDistanceRangeAggregatorFactory, GeoHashGridAggregatorFactory, GeoTileGridAggregatorFactory, HistogramAggregatorFactory, MedianAbsoluteDeviationAggregatorFactory, MissingAggregatorFactory, RareTermsAggregatorFactory, SignificantTermsAggregatorFactory, TermsAggregatorFactory, VariableWidthHistogramAggregatorFactory

public abstract class ValuesSourceAggregatorFactory
extends AggregatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected ValuesSourceConfig	config

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

factories, metadata, name, parent, queryShardContext

Constructor Summary

Constructors

Constructor	Description
ValuesSourceAggregatorFactory(java.lang.String name, ValuesSourceConfig config, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Summary

Modifier and Type	Method	Description
Aggregator	createInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata)
protected abstract Aggregator	createUnmapped(SearchContext searchContext, Aggregator parent, java.util.Map<java.lang.String,java.lang.Object> metadata)	Create the Aggregator for a ValuesSource that doesn't have values.
protected abstract Aggregator	doCreateInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata)	Create the Aggregator for a ValuesSource that has values.
java.lang.String	getStatsSubtype()	Returns the aggregation subtype for nodes usage stats.

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

create, doValidate, getParent, name

Methods inherited from class java.lang.Object

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

Field Details

config

protected ValuesSourceConfig config

Constructor Details

ValuesSourceAggregatorFactory

public ValuesSourceAggregatorFactory(java.lang.String name, ValuesSourceConfig config, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException

Throws:

java.io.IOException

Method Details

createInternal

public Aggregator createInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException

Specified by:

createInternal in class AggregatorFactory

Throws:

java.io.IOException

createUnmapped

protected abstract Aggregator createUnmapped(SearchContext searchContext, Aggregator parent, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException

Create the Aggregator for a ValuesSource that doesn't have values.

Throws:

java.io.IOException

doCreateInternal

protected abstract Aggregator doCreateInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException

Create the Aggregator for a ValuesSource that has values.

Parameters:

cardinality - Upper bound of the number of owningBucketOrds that the Aggregator created by this method will be asked to collect.

Throws:

java.io.IOException

getStatsSubtype

public java.lang.String getStatsSubtype()

Description copied from class: AggregatorFactory

Returns the aggregation subtype for nodes usage stats.

It should match the types registered by calling AggregationUsageService. In other words, it should be ValueSourcesType for the VST aggregations OTHER_SUBTYPE for all other aggregations.

Overrides:

getStatsSubtype in class AggregatorFactory