org.elasticsearch.search.aggregations.bucket.children

Class ParentToChildrenAggregator

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.SingleBucketAggregator

org.elasticsearch.search.aggregations.bucket.children.ParentToChildrenAggregator

All Implemented Interfaces:

AutoCloseable, org.apache.lucene.search.Collector, Releasable

public class ParentToChildrenAggregator
extends SingleBucketAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParentToChildrenAggregator.Factory

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

Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

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

collectableSubAggregators, context, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
ParentToChildrenAggregator(String name, AggregatorFactories factories, AggregationContext aggregationContext, Aggregator parent, String parentType, org.apache.lucene.search.Query childFilter, org.apache.lucene.search.Query parentFilter, ValuesSource.Bytes.ParentChild valuesSource, long maxOrd, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal) Build an aggregation for data that has been collected into bucket.
InternalAggregation	buildEmptyAggregation() Build an empty aggregation.
protected void	doClose() Release instance-specific data.
protected void	doPostCollection() Can be overriden by aggregator implementation to be called back when the collection phase ends.
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.bucket.BucketsAggregator

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

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

buildEmptySubAggregations, context, doPreCollection, getDeferringCollector, getLeafCollector, metaData, name, needsScores, parent, pipelineAggregators, postCollection, preCollection, runDeferredCollections, shouldDefer, subAggregator, subAggregators, toString

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

descendsFromBucketAggregator

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

wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentToChildrenAggregator

public ParentToChildrenAggregator(String name,
                          AggregatorFactories factories,
                          AggregationContext aggregationContext,
                          Aggregator parent,
                          String parentType,
                          org.apache.lucene.search.Query childFilter,
                          org.apache.lucene.search.Query parentFilter,
                          ValuesSource.Bytes.ParentChild valuesSource,
                          long maxOrd,
                          List<PipelineAggregator> pipelineAggregators,
                          Map<String,Object> metaData)
                           throws IOException

Throws:

IOException

Method Detail

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)
                                     throws IOException

Description copied from class: Aggregator

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

Specified by:

buildAggregation in class Aggregator

Throws:

IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
                                   LeafBucketCollector sub)
                                     throws 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:

IOException

doPostCollection

protected void doPostCollection()
                         throws IOException

Description copied from class: AggregatorBase

Can be overriden by aggregator implementation to be called back when the collection phase ends.

Overrides:

doPostCollection in class AggregatorBase

Throws:

IOException

doClose

protected void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase