org.elasticsearch.search.aggregations.support

Class ValuesSourceAggregatorFactory<VS extends ValuesSource>

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory

org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory<VS>

Direct Known Subclasses:

GeoBoundsAggregator.Factory, HistogramAggregator.Factory, MissingAggregator.Factory, ParentToChildrenAggregator.Factory, RangeAggregator.Factory, SignificantTermsAggregatorFactory, TermsAggregatorFactory, ValuesSourceAggregatorFactory.LeafOnly

public abstract class ValuesSourceAggregatorFactory<VS extends ValuesSource>
extends AggregatorFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValuesSourceAggregatorFactory.LeafOnly<VS extends ValuesSource>

Field Summary

Fields

Modifier and Type	Field and Description
protected ValuesSourceConfig<VS>	config

Fields inherited from class org.elasticsearch.search.aggregations.AggregatorFactory

factories, name, parent, type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValuesSourceAggregatorFactory(String name, String type, ValuesSourceConfig<VS> config)

Method Summary

Modifier and Type	Method and Description
Aggregator	create(AggregationContext context, Aggregator parent, long expectedBucketsCount) Creates the aggregator
protected abstract Aggregator	create(VS valuesSource, long expectedBucketsCount, AggregationContext aggregationContext, Aggregator parent)
protected abstract Aggregator	createUnmapped(AggregationContext aggregationContext, Aggregator parent)
void	doValidate()

Methods inherited from class org.elasticsearch.search.aggregations.AggregatorFactory

parent, subFactories, validate

Methods inherited from class java.lang.Object

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

Field Detail

config

protected ValuesSourceConfig<VS extends ValuesSource> config

Constructor Detail

ValuesSourceAggregatorFactory

protected ValuesSourceAggregatorFactory(String name,
                                        String type,
                                        ValuesSourceConfig<VS> config)

Method Detail

create

public Aggregator create(AggregationContext context,
                         Aggregator parent,
                         long expectedBucketsCount)

Description copied from class: AggregatorFactory

Creates the aggregator

Specified by:

create in class AggregatorFactory

Parameters:

context - The aggregation context

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

expectedBucketsCount - If this is a sub-factory of another factory, this will indicate the number of bucket the parent aggregator may generate (this is an estimation only). For top level factories, this will always be 0

Returns:

The created aggregator

doValidate

public void doValidate()

Overrides:

doValidate in class AggregatorFactory

createUnmapped

protected abstract Aggregator createUnmapped(AggregationContext aggregationContext,
                                             Aggregator parent)

create

protected abstract Aggregator create(VS valuesSource,
                                     long expectedBucketsCount,
                                     AggregationContext aggregationContext,
                                     Aggregator parent)