org.elasticsearch.search.aggregations.metrics.tophits

Class TopHitsAggregator.Factory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory

org.elasticsearch.search.aggregations.metrics.tophits.TopHitsAggregator.Factory

Enclosing class:

TopHitsAggregator

public static class TopHitsAggregator.Factory
extends AggregatorFactory

Field Summary

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

factories, name, parent, type

Constructor Summary

Constructors

Constructor and Description
Factory(String name, FetchPhase fetchPhase, SubSearchContext subSearchContext)

Method Summary

Modifier and Type	Method and Description
Aggregator	create(AggregationContext aggregationContext, Aggregator parent, long expectedBucketsCount) Creates the aggregator
AggregatorFactory	subFactories(AggregatorFactories subFactories) Registers sub-factories with this factory.

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

doValidate, parent, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Factory

public Factory(String name,
               FetchPhase fetchPhase,
               SubSearchContext subSearchContext)

Method Detail

create

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

Description copied from class: AggregatorFactory

Creates the aggregator

Specified by:

create in class AggregatorFactory

Parameters:

aggregationContext - 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

subFactories

public AggregatorFactory subFactories(AggregatorFactories subFactories)

Description copied from class: AggregatorFactory

Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.

Overrides:

subFactories in class AggregatorFactory

Parameters:

subFactories - The sub-factories

Returns:

this factory (fluent interface)