Package org.opensearch.search.aggregations

Class AggregatorFactories

java.lang.Object

org.opensearch.search.aggregations.AggregatorFactories

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

An immutable collection of AggregatorFactories.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregatorFactories.Builder	A mutable collection of AggregationBuilders and PipelineAggregationBuilders.

Field Summary

Fields

Modifier and Type	Field	Description
static final AggregatorFactories	EMPTY
static final Pattern	VALID_AGG_NAME

Method Summary

Modifier and Type	Method	Description
boolean	allFactoriesSupportConcurrentSearch()
static AggregatorFactories.Builder	builder()
int	countAggregators()
Aggregator[]	createSubAggregators(SearchContext searchContext, Aggregator parent, CardinalityUpperBound cardinality)	Create all aggregators so that they can be consumed with multiple buckets.
List<Aggregator>	createTopLevelAggregators(SearchContext searchContext)
List<Aggregator>	createTopLevelGlobalAggregators(SearchContext searchContext)
List<Aggregator>	createTopLevelNonGlobalAggregators(SearchContext searchContext)
boolean	hasGlobalAggregator()
boolean	hasNonGlobalAggregator()
static AggregatorFactories.Builder	parseAggregators(org.opensearch.core.xcontent.XContentParser parser)	Parses the aggregation request recursively generating aggregator factories in turn.

Methods inherited from class java.lang.Object

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

Field Details

VALID_AGG_NAME

public static final Pattern VALID_AGG_NAME

EMPTY

public static final AggregatorFactories EMPTY

Method Details

parseAggregators

public static AggregatorFactories.Builder parseAggregators(org.opensearch.core.xcontent.XContentParser parser)
                                                    throws IOException

Parses the aggregation request recursively generating aggregator factories in turn.

Throws:

IOException

builder

public static AggregatorFactories.Builder builder()

allFactoriesSupportConcurrentSearch

public boolean allFactoriesSupportConcurrentSearch()

createSubAggregators

public Aggregator[] createSubAggregators(SearchContext searchContext,
 Aggregator parent,
 CardinalityUpperBound cardinality)
                                  throws IOException

Create all aggregators so that they can be consumed with multiple buckets.

Parameters:

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

Throws:

IOException

createTopLevelAggregators

public List<Aggregator> createTopLevelAggregators(SearchContext searchContext)
                                           throws IOException

Throws:

IOException

createTopLevelGlobalAggregators

public List<Aggregator> createTopLevelGlobalAggregators(SearchContext searchContext)
                                                 throws IOException

Throws:

IOException

createTopLevelNonGlobalAggregators

public List<Aggregator> createTopLevelNonGlobalAggregators(SearchContext searchContext)
                                                    throws IOException

Throws:

IOException

hasNonGlobalAggregator

public boolean hasNonGlobalAggregator()

hasGlobalAggregator

public boolean hasGlobalAggregator()

countAggregators

public int countAggregators()

Returns:

the number of sub-aggregator factories