Package org.elasticsearch.search.aggregations

Class InternalMultiBucketAggregation<A extends InternalMultiBucketAggregation,B extends InternalMultiBucketAggregation.InternalBucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation

Direct Known Subclasses:

AbstractInternalTerms, InternalAdjacencyMatrix, InternalAutoDateHistogram, InternalBinaryRange, InternalComposite, InternalDateHistogram, InternalFilters, InternalGeoGrid, InternalHistogram, InternalRange, InternalRareTerms, InternalSignificantTerms, InternalVariableWidthHistogram

public abstract class InternalMultiBucketAggregation<A extends InternalMultiBucketAggregation,B extends InternalMultiBucketAggregation.InternalBucket>
extends InternalAggregation
implements MultiBucketsAggregation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalMultiBucketAggregation.InternalBucket

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

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

metadata, name

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	InternalMultiBucketAggregation(String name, Map<String,Object> metadata)
protected	InternalMultiBucketAggregation(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalAggregation	copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)	Rewrite the sub-aggregations in the buckets in this aggregation.
static int	countInnerBucket(Aggregation agg)	Counts the number of inner buckets inside the provided Aggregation
static int	countInnerBucket(InternalMultiBucketAggregation.InternalBucket bucket)	Counts the number of inner buckets inside the provided InternalMultiBucketAggregation.InternalBucket
abstract A	create(List<B> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
abstract B	createBucket(InternalAggregations aggregations, B prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
void	forEachBucket(Consumer<InternalAggregations> consumer)	Run a Consumer over all buckets in this aggregation.
abstract List<B>	getBuckets()
Object	getProperty(List<String> path)
protected boolean	mustReduceOnSingleInternalAgg()	Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.
protected abstract B	reduceBucket(List<B> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.
InternalAggregation	reducePipelines(InternalAggregation reducedAggs, InternalAggregation.ReduceContext reduceContext, PipelineAggregator.PipelineTree pipelineTree)	A multi-bucket agg needs to first reduce the buckets and *their* pipelines before allowing sibling pipelines to materialize.

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

doWriteTo, doXContentBody, equals, getMetadata, getName, getProperty, getType, hashCode, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reduce, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalMultiBucketAggregation

public InternalMultiBucketAggregation(String name,
 Map<String,Object> metadata)

InternalMultiBucketAggregation

protected InternalMultiBucketAggregation(StreamInput in)
                                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

create

public abstract A create(List<B> buckets)

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public abstract B createBucket(InternalAggregations aggregations,
 B prototype)

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

reduceBucket

protected abstract B reduceBucket(List<B> buckets,
 InternalAggregation.ReduceContext context)

Reduce a list of same-keyed buckets (from multiple shards) to a single bucket. This requires all buckets to have the same key.

getBuckets

public abstract List<B> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

countInnerBucket

public static int countInnerBucket(InternalMultiBucketAggregation.InternalBucket bucket)

Counts the number of inner buckets inside the provided InternalMultiBucketAggregation.InternalBucket

countInnerBucket

public static int countInnerBucket(Aggregation agg)

Counts the number of inner buckets inside the provided Aggregation

reducePipelines

public final InternalAggregation reducePipelines(InternalAggregation reducedAggs,
 InternalAggregation.ReduceContext reduceContext,
 PipelineAggregator.PipelineTree pipelineTree)

A multi-bucket agg needs to first reduce the buckets and *their* pipelines before allowing sibling pipelines to materialize.

Overrides:

reducePipelines in class InternalAggregation

copyWithRewritenBuckets

public InternalAggregation copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)

Description copied from class: InternalAggregation

Rewrite the sub-aggregations in the buckets in this aggregation. Returns a copy of this InternalAggregation with the rewritten buckets, or, if there aren't any modifications to the buckets then this method will return this aggregation. Either way, it doesn't modify this aggregation.

Implementers of this should call the rewriter once per bucket with its InternalAggregations. The rewriter should return null if it doen't have any rewriting to do or it should return a new InternalAggregations to make changs.

The default implementation throws an exception because most aggregations don't have buckets in them. It should be overridden by aggregations that contain buckets. Implementers should respect the description above.

Overrides:

copyWithRewritenBuckets in class InternalAggregation

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Description copied from class: InternalAggregation

Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

forEachBucket

public void forEachBucket(Consumer<InternalAggregations> consumer)

Description copied from class: InternalAggregation

Run a Consumer over all buckets in this aggregation.

Overrides:

forEachBucket in class InternalAggregation