Package org.elasticsearch.search.aggregations

Class AggregatorFactory

org.elasticsearch.search.aggregations.AggregatorFactory

Direct Known Subclasses:

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

public abstract class AggregatorFactory
extends 

Field Summary

Fields

Modifier and Type	Field	Description
protected AggregationContext	context
protected AggregatorFactories	factories
protected <,>	metadata
protected	name
protected AggregatorFactory	parent

Constructor Summary

Constructors

Constructor	Description
name, AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, <,> metadata)	Constructs a new aggregator factory.

Method Summary

Modifier and Type	Method	Description
Aggregator	create(Aggregator parent, CardinalityUpperBound cardinality)	Creates the aggregator.
protected abstract Aggregator	createInternal(Aggregator parent, CardinalityUpperBound cardinality, <,> metadata)
void	doValidate()
AggregatorFactory	getParent()
	getStatsSubtype()	Returns the aggregation subtype for nodes usage stats.
	name()

Methods inherited from class java.lang.

, , , , , , , , , ,

Field Details

name

protected final  name

parent

protected final AggregatorFactory parent

factories

protected final AggregatorFactories factories

metadata

protected final <,> metadata

context

protected final AggregationContext context

Constructor Details

AggregatorFactory

public AggregatorFactory( name,
 AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder,
 <,> metadata)
                  throws 

Constructs a new aggregator factory.

Parameters:

name - The aggregation name

Throws:

- if an error occurs creating the factory

Method Details

name

public  name()

doValidate

public void doValidate()

createInternal

protected abstract Aggregator createInternal(Aggregator parent,
 CardinalityUpperBound cardinality,
 <,> metadata)
                                      throws 

Throws:

create

public final Aggregator create(Aggregator parent,
 CardinalityUpperBound cardinality)
                        throws 

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:

getParent

public AggregatorFactory getParent()

getStatsSubtype

public  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.