Package org.opensearch.search.aggregations.support

Class MultiValuesSourceAggregatorFactory

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactory

org.opensearch.search.aggregations.support.MultiValuesSourceAggregatorFactory

public abstract class MultiValuesSourceAggregatorFactory
extends AggregatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,ValuesSourceConfig>	configs
protected DocValueFormat	format

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

factories, metadata, name, parent, queryShardContext

Constructor Summary

Constructors

Constructor	Description
MultiValuesSourceAggregatorFactory(java.lang.String name, java.util.Map<java.lang.String,ValuesSourceConfig> configs, DocValueFormat format, 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 an aggregator that won't collect anything but will return an appropriate empty aggregation.
protected abstract Aggregator	doCreateInternal(SearchContext searchContext, java.util.Map<java.lang.String,ValuesSourceConfig> configs, DocValueFormat format, Aggregator parent, CardinalityUpperBound cardinality, java.util.Map<java.lang.String,java.lang.Object> metadata)	Create the Aggregator.

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 Details

configs

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

format

protected final DocValueFormat format

Constructor Details

MultiValuesSourceAggregatorFactory

public MultiValuesSourceAggregatorFactory(java.lang.String name, java.util.Map<java.lang.String,ValuesSourceConfig> configs, DocValueFormat format, 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 an aggregator that won't collect anything but will return an appropriate empty aggregation.

Throws:

java.io.IOException

doCreateInternal

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

Create the Aggregator.

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