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.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.SingleBucketAggregator

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

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

public class ParentToChildrenAggregator
extends SingleBucketAggregator
implements ReaderContextAware

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.BucketAggregationMode, Aggregator.Parser, Aggregator.SubAggCollectionMode

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

BucketCollector.BucketAnalysisCollector

Field Summary

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

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, 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.Filter childFilter, org.apache.lucene.search.Filter parentFilter, ValuesSource.Bytes.ParentChild valuesSource, long maxOrd)

Method Summary

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)
InternalAggregation	buildEmptyAggregation()
void	collect(int docId, long bucketOrdinal) Called during the query phase, to collect & aggregate the given document.
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.
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

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

shouldCollect

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

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

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

bucketAggregationMode, buildEmptySubAggregations, context, depth, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, shouldDefer, subAggregator, subAggregators

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

wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentToChildrenAggregator

public ParentToChildrenAggregator(String name,
                                  AggregatorFactories factories,
                                  AggregationContext aggregationContext,
                                  Aggregator parent,
                                  String parentType,
                                  org.apache.lucene.search.Filter childFilter,
                                  org.apache.lucene.search.Filter parentFilter,
                                  ValuesSource.Bytes.ParentChild valuesSource,
                                  long maxOrd)

Method Detail

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)

Specified by:

buildAggregation in class Aggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator

collect

public void collect(int docId,
                    long bucketOrdinal)
             throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

bucketOrdinal - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

Specified by:

setNextReader in interface ReaderContextAware

doPostCollection

protected void doPostCollection()
                         throws IOException

Description copied from class: Aggregator

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

Overrides:

doPostCollection in class Aggregator

Throws:

IOException

doClose

protected void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class Aggregator