org.elasticsearch.search.aggregations

Class InternalAggregations

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregations

All Implemented Interfaces:

Iterable<Aggregation>, Streamable, ToXContent, Aggregations

public class InternalAggregations
extends Object
implements Aggregations, ToXContent, Streamable

An internal implementation of Aggregations.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static InternalAggregations	EMPTY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalAggregations(List<InternalAggregation> aggregations) Constructs a new addAggregation.

Method Summary

Methods

Modifier and Type	Method and Description
List<Aggregation>	asList() The list of Aggregations.
Map<String,Aggregation>	asMap() Returns the Aggregations keyed by map.
<A extends Aggregation> A	get(String name) Returns the aggregation that is associated with the specified name.
Map<String,Aggregation>	getAsMap() Returns the Aggregations keyed by map.
Object	getProperty(List<String> path)
Object	getProperty(String path) Get the value of specified path in the aggregation.
Iterator<Aggregation>	iterator() Iterates over the Aggregations.
static InternalAggregations	readAggregations(StreamInput in)
void	readFrom(StreamInput in)
static InternalAggregations	readOptionalAggregations(StreamInput in)
static InternalAggregations	reduce(List<InternalAggregations> aggregationsList, InternalAggregation.ReduceContext context) Reduces the given lists of addAggregation.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentInternal(XContentBuilder builder, ToXContent.Params params) Directly write all the addAggregation without their bounding object.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final InternalAggregations EMPTY

Constructor Detail

InternalAggregations

public InternalAggregations(List<InternalAggregation> aggregations)

Constructs a new addAggregation.

Method Detail

iterator

public Iterator<Aggregation> iterator()

Iterates over the Aggregations.

Specified by:

iterator in interface Iterable<Aggregation>

asList

public List<Aggregation> asList()

The list of Aggregations.

Specified by:

asList in interface Aggregations

asMap

public Map<String,Aggregation> asMap()

Returns the Aggregations keyed by map.

Specified by:

asMap in interface Aggregations

getAsMap

public Map<String,Aggregation> getAsMap()

Returns the Aggregations keyed by map.

Specified by:

getAsMap in interface Aggregations

get

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

Description copied from interface: Aggregations

Returns the aggregation that is associated with the specified name.

Specified by:

get in interface Aggregations

Returns:

the aggregation of the specified name.

getProperty

public Object getProperty(String path)

Description copied from interface: Aggregations

Get the value of specified path in the aggregation.

Specified by:

getProperty in interface Aggregations

Parameters:

path - the path to the property in the aggregation tree

Returns:

the value of the property

getProperty

public Object getProperty(List<String> path)

reduce

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

Reduces the given lists of addAggregation.

Parameters:

aggregationsList - A list of aggregation to reduce

Returns:

The reduced addAggregation

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 addAggregation without their bounding object. Used by sub-addAggregation (non top level addAggregation)

Throws:

IOException

readAggregations

public static InternalAggregations readAggregations(StreamInput in)
                                             throws IOException

Throws:

IOException

readOptionalAggregations

public static InternalAggregations readOptionalAggregations(StreamInput in)
                                                     throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException