Package org.opensearch.search.aggregations.bucket.range

Class AbstractRangeAggregatorFactory<R extends RangeAggregator.Range>

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactory

org.opensearch.search.aggregations.support.ValuesSourceAggregatorFactory

org.opensearch.search.aggregations.bucket.range.AbstractRangeAggregatorFactory<R>

Direct Known Subclasses:

DateRangeAggregatorFactory, RangeAggregatorFactory

public class AbstractRangeAggregatorFactory<R extends RangeAggregator.Range>
extends ValuesSourceAggregatorFactory

Field Summary

Fields inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregatorFactory

config

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

factories, metadata, name, parent, queryShardContext

Constructor Summary

Constructors

Constructor	Description
AbstractRangeAggregatorFactory(java.lang.String name, ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> registryKey, ValuesSourceConfig config, R[] ranges, boolean keyed, InternalRange.Factory<?,?> rangeFactory, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Summary

Modifier and Type	Method	Description
protected 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 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.
static void	registerAggregators(ValuesSourceRegistry.Builder builder, ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> registryKey)

Methods inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregatorFactory

createInternal, getStatsSubtype

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

Constructor Details

AbstractRangeAggregatorFactory

public AbstractRangeAggregatorFactory(java.lang.String name, ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> registryKey, ValuesSourceConfig config, R[] ranges, boolean keyed, InternalRange.Factory<?,?> rangeFactory, 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

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder, ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> registryKey)

createUnmapped

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

Description copied from class: ValuesSourceAggregatorFactory

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

Specified by:

createUnmapped in class ValuesSourceAggregatorFactory

Throws:

java.io.IOException

doCreateInternal

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

Description copied from class: ValuesSourceAggregatorFactory

Create the Aggregator for a ValuesSource that has values.

Specified by:

doCreateInternal in class ValuesSourceAggregatorFactory

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

Throws:

java.io.IOException