Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket

Class ParsedSingleBucketAggregation

java.lang.Object

org.elasticsearch.search.aggregations.ParsedAggregation

org.elasticsearch.search.aggregations.bucket.ParsedSingleBucketAggregation

All Implemented Interfaces:

Aggregation, SingleBucketAggregation, HasAggregations, ToXContent, ToXContentFragment

Direct Known Subclasses:

ParsedFilter, ParsedGlobal, ParsedMissing, ParsedNested, ParsedReverseNested, ParsedSampler

public abstract class ParsedSingleBucketAggregation
extends ParsedAggregation
implements SingleBucketAggregation

A base class for all the single bucket aggregations.

Nested Class Summary

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

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
protected Aggregations	aggregations

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

metadata

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedSingleBucketAggregation()

Method Summary

Modifier and Type	Method	Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
Aggregations	getAggregations()
long	getDocCount()
protected static <T extends ParsedSingleBucketAggregation> T	parseXContent(XContentParser parser, T aggregation, String name)
protected void	setDocCount(long docCount)

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

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

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

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

getMetadata, getName, getType

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

aggregations

protected Aggregations aggregations

Constructor Details

ParsedSingleBucketAggregation

public ParsedSingleBucketAggregation()

Method Details

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface SingleBucketAggregation

Returns:

The number of documents in this bucket

setDocCount

protected void setDocCount(long docCount)

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface SingleBucketAggregation

Returns:

The sub-aggregations of this bucket

doXContentBody

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

Specified by:

doXContentBody in class ParsedAggregation

Throws:

IOException

parseXContent

protected static <T extends ParsedSingleBucketAggregation>
T parseXContent(XContentParser parser,
 T aggregation,
 String name)
         throws IOException

Throws:

IOException