Package org.opensearch.search.aggregations

Class AggregatorFactory

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactory

Direct Known Subclasses:

AdjacencyMatrixAggregatorFactory, FilterAggregatorFactory, FiltersAggregatorFactory, GlobalAggregatorFactory, MultiTermsAggregationFactory, MultiValuesSourceAggregatorFactory, NestedAggregatorFactory, ReverseNestedAggregatorFactory, SamplerAggregatorFactory, SignificantTextAggregatorFactory, ValuesSourceAggregatorFactory

@PublicApi(since="1.0.0")
public abstract class AggregatorFactory
extends Object

Base factory to instantiate an internal aggregator

Opensearch.api:

Field Summary

Fields

Modifier and Type	Field	Description
protected final AggregatorFactories	factories
protected final Map<String,Object>	metadata
protected final String	name
protected final AggregatorFactory	parent
protected final QueryShardContext	queryShardContext

Constructor Summary

Constructors

Constructor	Description
AggregatorFactory(String name, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metadata)	Constructs a new aggregator factory.

Method Summary

Modifier and Type	Method	Description
final Aggregator	create(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality)	Creates the aggregator.
protected abstract Aggregator	createInternal(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)
void	doValidate()
boolean	evaluateChildFactories()
AggregatorFactory	getParent()
String	getStatsSubtype()	Returns the aggregation subtype for nodes usage stats.
String	name()
protected boolean	supportsConcurrentSegmentSearch()	Implementation should override this method and return true if the Aggregator created by the factory works with concurrent segment search execution model

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

parent

protected final AggregatorFactory parent

factories

protected final AggregatorFactories factories

metadata

protected final Map<String,Object> metadata

queryShardContext

protected final QueryShardContext queryShardContext

Constructor Details

AggregatorFactory

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

Constructs a new aggregator factory.

Parameters:

name - The aggregation name

Throws:

IOException - if an error occurs creating the factory

Method Details

name

public String name()

doValidate

public void doValidate()

createInternal

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

Throws:

IOException

create

public final Aggregator create(SearchContext searchContext,
 Aggregator parent,
 CardinalityUpperBound cardinality)
                        throws IOException

Creates the aggregator.

Parameters:

parent - The parent aggregator (if this is a top level factory, the parent will be null)

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

Throws:

IOException

getParent

public AggregatorFactory getParent()

getStatsSubtype

public String getStatsSubtype()

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.

supportsConcurrentSegmentSearch

protected boolean supportsConcurrentSegmentSearch()

Implementation should override this method and return true if the Aggregator created by the factory works with concurrent segment search execution model

evaluateChildFactories

public boolean evaluateChildFactories()