Package org.elasticsearch.search.aggregations

Class InternalAggregations

java.lang.Object

org.elasticsearch.search.aggregations.Aggregations

org.elasticsearch.search.aggregations.InternalAggregations

All Implemented Interfaces:

Iterable<Aggregation>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public final class InternalAggregations
extends Aggregations
implements Writeable

An internal implementation of Aggregations.

Nested Class Summary

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

Modifier and Type	Field	Description
static InternalAggregations	EMPTY

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

aggregations, AGGREGATIONS_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalAggregations(List<InternalAggregation> aggregations, Supplier<PipelineAggregator.PipelineTree> pipelineTreeSource)	Constructs a node in the aggregation tree.

Method Summary

Modifier and Type	Method	Description
List<InternalAggregation>	copyResults()	Make a mutable copy of the aggregation results.
static InternalAggregations	from(List<InternalAggregation> aggregations)
List<SiblingPipelineAggregator>	getTopLevelPipelineAggregators()	Deprecated. these only exist for BWC serialization
void	mergePipelineTreeForBWCSerialization(PipelineAggregator.PipelineTree pipelineTree)	Merge a PipelineAggregator.PipelineTree into this aggregation result tree before serializing to a node older than 7.8.0.
static InternalAggregations	readFrom(StreamInput in)
static InternalAggregations	reduce(List<InternalAggregations> aggregationsList, InternalAggregation.ReduceContext context)	Version of reduce(List, ReduceContext, Function) for nodes inside the aggregation tree.
static InternalAggregations	reduce(List<InternalAggregations> aggregationsList, InternalAggregation.ReduceContext context, Function<List<InternalAggregation>,InternalAggregations> ctor)	Reduces the given list of aggregations as well as the top-level pipeline aggregators extracted from the first InternalAggregations object found in the list.
double	sortValue(AggregationPath.PathElement head, Iterator<AggregationPath.PathElement> tail)	Get value to use when sorting by a descendant of the aggregation containing this.
static InternalAggregations	topLevelReduce(List<InternalAggregations> aggregationsList, InternalAggregation.ReduceContext context)	Begin the reduction process.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

asList, asMap, equals, fromXContent, get, getAsMap, hashCode, iterator, toXContent, toXContentInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Field Details

EMPTY

public static final InternalAggregations EMPTY

Constructor Details

InternalAggregations

public InternalAggregations(List<InternalAggregation> aggregations,
 Supplier<PipelineAggregator.PipelineTree> pipelineTreeSource)

Constructs a node in the aggregation tree.

Parameters:

pipelineTreeSource - must be null inside the tree or after final reduction. Should reference the search request otherwise so we can properly serialize the response to versions of Elasticsearch that require the pipelines to be serialized.

Method Details

from

public static InternalAggregations from(List<InternalAggregation> aggregations)

readFrom

public static InternalAggregations readFrom(StreamInput in)
                                     throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

mergePipelineTreeForBWCSerialization

public void mergePipelineTreeForBWCSerialization(PipelineAggregator.PipelineTree pipelineTree)

Merge a PipelineAggregator.PipelineTree into this aggregation result tree before serializing to a node older than 7.8.0.

copyResults

public List<InternalAggregation> copyResults()

Make a mutable copy of the aggregation results.

IMPORTANT: The copy doesn't include any pipeline aggregations, if there are any.

getTopLevelPipelineAggregators

@Deprecated
public List<SiblingPipelineAggregator> getTopLevelPipelineAggregators()

Deprecated.

these only exist for BWC serialization

Get the top level pipeline aggregators.

sortValue

public double sortValue(AggregationPath.PathElement head,
 Iterator<AggregationPath.PathElement> tail)

Get value to use when sorting by a descendant of the aggregation containing this.

topLevelReduce

public static InternalAggregations topLevelReduce(List<InternalAggregations> aggregationsList,
 InternalAggregation.ReduceContext context)

Begin the reduction process. This should be the entry point for the "first" reduction, e.g. called by SearchPhaseController or anywhere else that wants to initiate a reduction. It _should not_ be called as an intermediate reduction step (e.g. in the middle of an aggregation tree). This method first reduces the aggregations, and if it is the final reduce, then reduce the pipeline aggregations (both embedded parent/sibling as well as top-level sibling pipelines)

reduce

public static InternalAggregations reduce(List<InternalAggregations> aggregationsList,
 InternalAggregation.ReduceContext context,
 Function<List<InternalAggregation>,InternalAggregations> ctor)

Reduces the given list of aggregations as well as the top-level pipeline aggregators extracted from the first InternalAggregations object found in the list. Note that pipeline aggregations _are not_ reduced by this method. Pipelines are handled separately by topLevelReduce(List, ReduceContext)

Parameters:

ctor - used to build the InternalAggregations. The top level reduce specifies a constructor that adds pipeline aggregation information that is used to send pipeline aggregations to older versions of Elasticsearch that require the pipeline aggregations to be returned as part of the aggregation tree

reduce

public static InternalAggregations reduce(List<InternalAggregations> aggregationsList,
 InternalAggregation.ReduceContext context)

Version of reduce(List, ReduceContext, Function) for nodes inside the aggregation tree.