Class ArrayValuesSourceAggregatorFactory

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactory

org.opensearch.search.aggregations.support.ArrayValuesSourceAggregatorFactory

public abstract class ArrayValuesSourceAggregatorFactory
extends AggregatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String, ValuesSourceConfig>	configs

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

factories, metadata, name, parent, queryShardContext

Constructor Summary

Constructors

Constructor	Description
ArrayValuesSourceAggregatorFactory(String name, Map<String, ValuesSourceConfig> configs, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
Aggregator	createInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)
protected abstract Aggregator	createUnmapped(SearchContext searchContext, Aggregator parent, Map<String,Object> metadata)	Create the Aggregator when none of the configured fields can be resolved to a ValuesSource.
protected abstract Aggregator	doCreateInternal(Map<String, ValuesSource> valuesSources, SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)	Create the Aggregator when any of the configured fields can be resolved to a ValuesSource.

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

create, doValidate, evaluateChildFactories, getParent, getStatsSubtype, getSubFactories, name, supportsConcurrentSegmentSearch

Methods inherited from class java.lang.Object

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

Field Details

configs

protected Map<String, ValuesSourceConfig> configs

Constructor Details

ArrayValuesSourceAggregatorFactory

public ArrayValuesSourceAggregatorFactory(String name,
 Map<String, ValuesSourceConfig> configs,
 QueryShardContext queryShardContext,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder,
 Map<String,Object> metadata)
                                   throws IOException

Throws:

IOException

Method Details

createInternal

public Aggregator createInternal(SearchContext searchContext,
 Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                          throws IOException

Specified by:

createInternal in class AggregatorFactory

Throws:

IOException

createUnmapped

protected abstract Aggregator createUnmapped(SearchContext searchContext,
 Aggregator parent,
 Map<String,Object> metadata)
                                      throws IOException

Create the Aggregator when none of the configured fields can be resolved to a ValuesSource.

Throws:

IOException

doCreateInternal

protected abstract Aggregator doCreateInternal(Map<String, ValuesSource> valuesSources,
 SearchContext searchContext,
 Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                                        throws IOException

Create the Aggregator when any of the configured fields can be resolved to a ValuesSource.

Parameters:

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

Throws:

IOException