org.elasticsearch.search.aggregations.bucket.filter

Class FilterAggregatorFactory

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactory<FilterAggregatorFactory>

org.elasticsearch.search.aggregations.bucket.filter.FilterAggregatorFactory

public class FilterAggregatorFactory
extends AggregatorFactory<FilterAggregatorFactory>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregatorFactory

AggregatorFactory.MultiBucketAggregatorWrapper

Field Summary

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

context, factories, metaData, name, parent

Constructor Summary

Constructors

Constructor and Description
FilterAggregatorFactory(java.lang.String name, QueryBuilder filterBuilder, SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method and Description
Aggregator	createInternal(Aggregator parent, boolean collectsFromSingleBucket, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)
org.apache.lucene.search.Weight	getWeight() Returns the Weight for this filter aggregation, creating it if necessary.

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

asMultiBucketAggregator, create, doValidate, getParent, name, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterAggregatorFactory

public FilterAggregatorFactory(java.lang.String name,
                               QueryBuilder filterBuilder,
                               SearchContext context,
                               AggregatorFactory<?> parent,
                               AggregatorFactories.Builder subFactoriesBuilder,
                               java.util.Map<java.lang.String,java.lang.Object> metaData)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getWeight

public org.apache.lucene.search.Weight getWeight()

Returns the Weight for this filter aggregation, creating it if necessary. This is done lazily so that the Weight is only created if the aggregation collects documents reducing the overhead of the aggregation in teh case where no documents are collected. Note that as aggregations are initialsed and executed in a serial manner, no concurrency considerations are necessary here.

createInternal

public Aggregator createInternal(Aggregator parent,
                                 boolean collectsFromSingleBucket,
                                 java.util.List<PipelineAggregator> pipelineAggregators,
                                 java.util.Map<java.lang.String,java.lang.Object> metaData)
                          throws java.io.IOException

Specified by:

createInternal in class AggregatorFactory<FilterAggregatorFactory>

Throws:

java.io.IOException