Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations

Class InternalAggregations

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregations

All Implemented Interfaces:

Iterable<InternalAggregation>, Writeable, ToXContent, ToXContentFragment

public final class InternalAggregations
extends Object
implements Iterable<InternalAggregation>, ToXContentFragment, Writeable

Represents a set of InternalAggregations

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 final String	AGGREGATIONS_FIELD
static final InternalAggregations	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
List<InternalAggregation>	asList()	The list of InternalAggregations.
Map<String,InternalAggregation>	asMap()	Returns the InternalAggregations keyed by aggregation name.
List<InternalAggregation>	copyResults()	Make a mutable copy of the aggregation results.
boolean	equals(Object obj)
static InternalAggregations	finalizeSampling(InternalAggregations internalAggregations, SamplingContext samplingContext)	Finalizes the sampling for all the internal aggregations
static InternalAggregations	from(List<InternalAggregation> aggregations)
static InternalAggregations	fromXContent(XContentParser parser)
<A extends InternalAggregation> A	get(String name)	Returns the aggregation that is associated with the specified name.
Map<String,InternalAggregation>	getAsMap()	Returns the InternalAggregations keyed by aggregation name.
int	hashCode()
Iterator<InternalAggregation>	iterator()	Iterates over the InternalAggregations.
static InternalAggregations	readFrom(StreamInput in)
static InternalAggregations	reduce(List<InternalAggregations> aggregationsList, AggregationReduceContext context)	Reduces the given list of aggregations as well as the top-level pipeline aggregators extracted from the first InternalAggregations object found in the list.
SortValue	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, AggregationReduceContext context)	Begin the reduction process.
static InternalAggregations	topLevelReduceDelayable(List<DelayableWriteable<InternalAggregations>> delayableAggregations, AggregationReduceContext context)	Equivalent to topLevelReduce(List, AggregationReduceContext) but it takes a list of DelayableWriteable.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentInternal(XContentBuilder builder, ToXContent.Params params)	Directly write all the aggregations without their bounding object.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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.xcontent.ToXContentFragment

isFragment

Field Details

AGGREGATIONS_FIELD

public static final String AGGREGATIONS_FIELD

See Also:

• Constant Field Values

EMPTY

public static final InternalAggregations EMPTY

Method Details

iterator

public Iterator<InternalAggregation> iterator()

Iterates over the InternalAggregations.

Specified by:

iterator in interface Iterable<InternalAggregation>

asList

public List<InternalAggregation> asList()

The list of InternalAggregations.

asMap

public Map<String,InternalAggregation> asMap()

Returns the InternalAggregations keyed by aggregation name.

getAsMap

public Map<String,InternalAggregation> getAsMap()

Returns the InternalAggregations keyed by aggregation name.

get

public <A extends InternalAggregation> A get(String name)

Returns the aggregation that is associated with the specified name.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContentInternal

public XContentBuilder toXContentInternal(XContentBuilder builder,
 ToXContent.Params params)
                                   throws IOException

Directly write all the aggregations without their bounding object. Used by sub-aggregations (non top level aggs)

Throws:

IOException

fromXContent

public static InternalAggregations fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

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

copyResults

public List<InternalAggregation> copyResults()

Make a mutable copy of the aggregation results.

sortValue

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

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

topLevelReduceDelayable

public static InternalAggregations topLevelReduceDelayable(List<DelayableWriteable<InternalAggregations>> delayableAggregations,
 AggregationReduceContext context)

Equivalent to topLevelReduce(List, AggregationReduceContext) but it takes a list of DelayableWriteable. The object will be expanded once via DelayableWriteable.expand() but it is the responsibility of the caller to release those releasables.

topLevelReduce

public static InternalAggregations topLevelReduce(List<InternalAggregations> aggregationsList,
 AggregationReduceContext 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,
 AggregationReduceContext context)

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, AggregationReduceContext)

finalizeSampling

public static InternalAggregations finalizeSampling(InternalAggregations internalAggregations,
 SamplingContext samplingContext)

Finalizes the sampling for all the internal aggregations

Parameters:

samplingContext - the sampling context

Returns:

the finalized aggregations