Package org.elasticsearch.search.aggregations

Class AggregatorFactories

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactories

public class AggregatorFactories
extends Object

An immutable collection of AggregatorFactories.

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
static AggregatorFactories.Builder	builder()
AggregationContext	context()
int	countAggregators()
Aggregator[]	createSubAggregators(Aggregator parent, CardinalityUpperBound cardinality)	Create all aggregators so that they can be consumed with multiple buckets.
Aggregator[]	createTopLevelAggregators()
AggregatorFactories	fixParent(Aggregator fixedParent)	This returns a copy of AggregatorFactories modified so that calls to createSubAggregators(org.elasticsearch.search.aggregations.Aggregator, org.elasticsearch.search.aggregations.CardinalityUpperBound) will ignore the provided parent aggregator and always use fixedParent provided in to this method.
static AggregatorFactories.Builder	parseAggregators(org.elasticsearch.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.elasticsearch.xcontent.XContentParser parser)
                                                    throws IOException

Parses the aggregation request recursively generating aggregator factories in turn.

Throws:

IOException

builder

public static AggregatorFactories.Builder builder()

context

public AggregationContext context()

createSubAggregators

public Aggregator[] createSubAggregators(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 Aggregator[] createTopLevelAggregators()
                                       throws IOException

Throws:

IOException

countAggregators

public int countAggregators()

Returns:

the number of sub-aggregator factories

fixParent

public AggregatorFactories fixParent(Aggregator fixedParent)

This returns a copy of AggregatorFactories modified so that calls to createSubAggregators(org.elasticsearch.search.aggregations.Aggregator, org.elasticsearch.search.aggregations.CardinalityUpperBound) will ignore the provided parent aggregator and always use fixedParent provided in to this method.

AdaptingAggregator uses this to make sure that sub-aggregators get the AdaptingAggregator aggregator itself as the parent.