Package org.elasticsearch.search.aggregations.bucket.filter

Class FiltersAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.search.Collector, Releasable

public class FiltersAggregator
extends BucketsAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FiltersAggregator.KeyedFilter

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

Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FILTERS_FIELD
static ParseField	OTHER_BUCKET_FIELD
static ParseField	OTHER_BUCKET_KEY_FIELD

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
FiltersAggregator(java.lang.String name, AggregatorFactories factories, java.lang.String[] keys, java.util.function.Supplier<org.apache.lucene.search.Weight[]> filters, boolean keyed, java.lang.String otherBucketKey, SearchContext context, Aggregator parent, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)	Build an aggregation for data that has been collected into bucket.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

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

descendsFromBucketAggregator

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doClose, doPostCollection, doPreCollection, getLeafCollector, metaData, name, needsScores, parent, pipelineAggregators, postCollection, preCollection, preGetSubLeafCollectors, subAggregator, subAggregators, toString

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

wrap

Methods inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectExistingBucket, consumeBucketsAndMaybeBreak, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd

Methods inherited from class java.lang.Object

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

Field Detail

FILTERS_FIELD

public static final ParseField FILTERS_FIELD

OTHER_BUCKET_FIELD

public static final ParseField OTHER_BUCKET_FIELD

OTHER_BUCKET_KEY_FIELD

public static final ParseField OTHER_BUCKET_KEY_FIELD

Constructor Detail

FiltersAggregator

public FiltersAggregator(java.lang.String name,
                         AggregatorFactories factories,
                         java.lang.String[] keys,
                         java.util.function.Supplier<org.apache.lucene.search.Weight[]> filters,
                         boolean keyed,
                         java.lang.String otherBucketKey,
                         SearchContext context,
                         Aggregator parent,
                         java.util.List<PipelineAggregator> pipelineAggregators,
                         java.util.Map<java.lang.String,java.lang.Object> metaData)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
                                            LeafBucketCollector sub)
                                     throws java.io.IOException

Description copied from class: AggregatorBase

Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

Specified by:

getLeafCollector in class AggregatorBase

Throws:

java.io.IOException

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)
                                     throws java.io.IOException

Description copied from class: Aggregator

Build an aggregation for data that has been collected into bucket.

Specified by:

buildAggregation in class Aggregator

Throws:

java.io.IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator