Package org.opensearch.search.aggregations.support

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 java.util.Map<java.lang.String,ValuesSourceConfig>	configs

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

factories, metadata, name, parent, queryShardContext

Constructor Summary

Constructors

Constructor	Description
ArrayValuesSourceAggregatorFactory(java.lang.String name, java.util.Map<java.lang.String,ValuesSourceConfig> configs, 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 when none of the configured fields can be resolved to a ValuesSource.
protected abstract Aggregator	doCreateInternal(java.util.Map<java.lang.String,ValuesSource> valuesSources, SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.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, getParent, getStatsSubtype, name

Methods inherited from class java.lang.Object

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

Field Detail

configs

protected java.util.Map<java.lang.String,ValuesSourceConfig> configs

Constructor Detail

ArrayValuesSourceAggregatorFactory

public ArrayValuesSourceAggregatorFactory(java.lang.String name,
                                          java.util.Map<java.lang.String,ValuesSourceConfig> configs,
                                          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 Detail

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 when none of the configured fields can be resolved to a ValuesSource.

Throws:

java.io.IOException

doCreateInternal

protected abstract Aggregator doCreateInternal(java.util.Map<java.lang.String,ValuesSource> valuesSources,
                                               SearchContext searchContext,
                                               Aggregator parent,
                                               CardinalityUpperBound cardinality,
                                               java.util.Map<java.lang.String,java.lang.Object> metadata)
                                        throws java.io.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:

java.io.IOException