Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations

Class AggregatorFactory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory

Direct Known Subclasses:

FilterAggregationBuilder.FilterAggregatorFactory, FiltersAggregatorFactory, GlobalAggregatorFactory, MultiValuesSourceAggregatorFactory, NestedAggregatorFactory, RandomSamplerAggregatorFactory, ReverseNestedAggregatorFactory, SamplerAggregatorFactory, SignificantTextAggregatorFactory, ValuesSourceAggregatorFactory

public abstract class AggregatorFactory
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Aggregator	create(Aggregator parent, CardinalityUpperBound cardinality)	Creates the aggregator.
protected abstract Aggregator	createInternal(Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)
AggregatorFactory	getParent()
Optional<SamplingContext>	getSamplingContext()	Climbs up the aggregation factory tree to find the sampling context if one exists.
String	getStatsSubtype()	Returns the aggregation subtype for nodes usage stats.
String	name()

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

parent

protected final AggregatorFactory parent

factories

protected final AggregatorFactories factories

metadata

protected final Map<String,Object> metadata

context

protected final AggregationContext context

Constructor Details

AggregatorFactory

public AggregatorFactory(String name,
 AggregationContext context,
 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 Details

getSamplingContext

public Optional<SamplingContext> getSamplingContext()

Climbs up the aggregation factory tree to find the sampling context if one exists.

Returns:

Optional SamplingContext

name

public String name()

createInternal

protected abstract Aggregator createInternal(Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                                      throws IOException

Throws:

IOException

create

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

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:

IOException

getParent

public AggregatorFactory getParent()

getStatsSubtype

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