Package org.elasticsearch.search.aggregations

Class Aggregations

java.lang.Object

org.elasticsearch.search.aggregations.Aggregations

All Implemented Interfaces:

Iterable<Aggregation>, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalAggregations

public class Aggregations
extends Object
implements Iterable<Aggregation>, ToXContentFragment

Represents a set 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	Description
protected List<? extends Aggregation>	aggregations
static String	AGGREGATIONS_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Aggregations(List<? extends Aggregation> aggregations)

Method Summary

Modifier and Type	Method	Description
List<Aggregation>	asList()	The list of Aggregations.
Map<String,Aggregation>	asMap()	Returns the Aggregations keyed by aggregation name.
boolean	equals(Object obj)
static Aggregations	fromXContent(XContentParser parser)
<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 aggregation name.
int	hashCode()
Iterator<Aggregation>	iterator()	Iterates over the Aggregations.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentInternal(XContentBuilder builder, ToXContent.Params params)	Directly write all the aggregations without their bounding object.

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 Detail

AGGREGATIONS_FIELD

public static final String AGGREGATIONS_FIELD

See Also:

Constant Field Values

aggregations

protected final List<? extends Aggregation> aggregations

Constructor Detail

Aggregations

public Aggregations(List<? extends Aggregation> aggregations)

Method Detail

iterator

public final Iterator<Aggregation> iterator()

Iterates over the Aggregations.

Specified by:

iterator in interface Iterable<Aggregation>

asList

public final List<Aggregation> asList()

The list of Aggregations.

asMap

public final Map<String,Aggregation> asMap()

Returns the Aggregations keyed by aggregation name.

getAsMap

public final Map<String,Aggregation> getAsMap()

Returns the Aggregations keyed by aggregation name.

get

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

Returns the aggregation that is associated with the specified name.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final 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 Aggregations fromXContent(XContentParser parser)
                                 throws IOException

Throws:

IOException