Package org.opensearch.join.aggregations

Class ChildrenToParentAggregator

java.lang.Object

org.opensearch.search.aggregations.BucketCollector

org.opensearch.search.aggregations.Aggregator

org.opensearch.search.aggregations.AggregatorBase

org.opensearch.search.aggregations.bucket.BucketsAggregator

org.opensearch.join.aggregations.ParentJoinAggregator

org.opensearch.join.aggregations.ChildrenToParentAggregator

All Implemented Interfaces:

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

public class ChildrenToParentAggregator
extends ParentJoinAggregator

A BucketsAggregator which resolves to the matching parent documents.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.join.aggregations.ParentJoinAggregator

ParentJoinAggregator.CollectionStrategy, ParentJoinAggregator.DenseCollectionStrategy, ParentJoinAggregator.SparseCollectionStrategy

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

BucketsAggregator.BucketBuilderForFixedCount<B extends Object>, BucketsAggregator.BucketBuilderForVariable<B extends Object>, BucketsAggregator.ResultBuilderForVariable<B extends Object>, BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

docCountProvider

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
ChildrenToParentAggregator(String name, AggregatorFactories factories, SearchContext context, Aggregator parent, org.apache.lucene.search.Query childFilter, org.apache.lucene.search.Query parentFilter, ValuesSource.Bytes.WithOrdinals valuesSource, long maxOrd, CardinalityUpperBound cardinality, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
InternalAggregation[]	buildAggregations(long[] owningBucketOrds)
InternalAggregation	buildEmptyAggregation()

Methods inherited from class org.opensearch.join.aggregations.ParentJoinAggregator

beforeBuildingBuckets, doClose, getLeafCollector, postCollection

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

bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, mergeBuckets, mergeBuckets, preGetSubLeafCollectors, resolveSortPath

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, preCollection, scoreMode, subAggregator, subAggregators, toString

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

buildTopLevel, collectDebugInfo, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Constructor Details

ChildrenToParentAggregator

public ChildrenToParentAggregator(String name,
 AggregatorFactories factories,
 SearchContext context,
 Aggregator parent,
 org.apache.lucene.search.Query childFilter,
 org.apache.lucene.search.Query parentFilter,
 ValuesSource.Bytes.WithOrdinals valuesSource,
 long maxOrd,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                           throws IOException

Throws:

IOException

Method Details

buildAggregations

public InternalAggregation[] buildAggregations(long[] owningBucketOrds)
                                        throws IOException

Specified by:

buildAggregations in class Aggregator

Throws:

IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator