Package org.elasticsearch.search.aggregations

Class AggregatorFactory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory

Direct Known Subclasses:

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

public abstract class AggregatorFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregatorFactory.MultiBucketAggregatorWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected AggregatorFactories	factories
protected Map<String,Object>	metaData
protected String	name
protected AggregatorFactory	parent
protected 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
protected static Aggregator	asMultiBucketAggregator(AggregatorFactory factory, SearchContext searchContext, Aggregator parent)	Utility method.
Aggregator	create(SearchContext searchContext, Aggregator parent, boolean collectsFromSingleBucket)	Creates the aggregator
protected abstract Aggregator	createInternal(SearchContext searchContext, Aggregator parent, boolean collectsFromSingleBucket, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
void	doValidate()
AggregatorFactory	getParent()
String	name()

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

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 Detail

name

public String name()

doValidate

public void doValidate()

createInternal

protected abstract Aggregator createInternal(SearchContext searchContext,
                                             Aggregator parent,
                                             boolean collectsFromSingleBucket,
                                             List<PipelineAggregator> pipelineAggregators,
                                             Map<String,Object> metaData)
                                      throws IOException

Throws:

IOException

create

public final Aggregator create(SearchContext searchContext,
                               Aggregator parent,
                               boolean collectsFromSingleBucket)
                        throws IOException

Creates the aggregator

Parameters:

searchContext - The search context

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

collectsFromSingleBucket - If true then the created aggregator will only be collected with 0 as a bucket ordinal. Some factories can take advantage of this in order to return more optimized implementations.

Returns:

The created aggregator

Throws:

IOException

getParent

public AggregatorFactory getParent()

asMultiBucketAggregator

protected static Aggregator asMultiBucketAggregator(AggregatorFactory factory,
                                                    SearchContext searchContext,
                                                    Aggregator parent)
                                             throws IOException

Utility method. Given an AggregatorFactory that creates Aggregators that only know how to collect bucket 0, this returns an aggregator that can collect any bucket.

Throws:

IOException