org.elasticsearch.search.aggregations

Class AggregatorFactories

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactories

public class AggregatorFactories
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregatorFactories.AggParseContext Context to parse and aggregation.
static class	AggregatorFactories.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static AggregatorFactories	EMPTY
static java.util.regex.Pattern	VALID_AGG_NAME

Method Summary

Modifier and Type	Method and Description
static AggregatorFactories.Builder	builder()
int	countAggregators()
int	countPipelineAggregators()
java.util.List<PipelineAggregator>	createPipelineAggregators()
Aggregator[]	createSubAggregators(Aggregator parent) Create all aggregators so that they can be consumed with multiple buckets.
Aggregator[]	createTopLevelAggregators()
static AggregatorFactories.Builder	parseAggregators(QueryParseContext parseContext) Parses the aggregation request recursively generating aggregator factories in turn.
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

VALID_AGG_NAME

public static final java.util.regex.Pattern VALID_AGG_NAME

EMPTY

public static final AggregatorFactories EMPTY

Method Detail

parseAggregators

public static AggregatorFactories.Builder parseAggregators(QueryParseContext parseContext)
                                                    throws java.io.IOException

Parses the aggregation request recursively generating aggregator factories in turn.

Parameters:

parseContext - The parse context.

Returns:

The parsed aggregator factories.

Throws:

java.io.IOException - When parsing fails for unknown reasons.

builder

public static AggregatorFactories.Builder builder()

createPipelineAggregators

public java.util.List<PipelineAggregator> createPipelineAggregators()
                                                             throws java.io.IOException

Throws:

java.io.IOException

createSubAggregators

public Aggregator[] createSubAggregators(Aggregator parent)
                                  throws java.io.IOException

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

Throws:

java.io.IOException

createTopLevelAggregators

public Aggregator[] createTopLevelAggregators()
                                       throws java.io.IOException

Throws:

java.io.IOException

countAggregators

public int countAggregators()

Returns:

the number of sub-aggregator factories not including pipeline aggregator factories

countPipelineAggregators

public int countPipelineAggregators()

Returns:

the number of pipeline aggregator factories

validate

public void validate()