org.elasticsearch.search.aggregations.bucket

Class InternalSingleBucketAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, SingleBucketAggregation, HasAggregations

Direct Known Subclasses:

InternalChildren, InternalFilter, InternalGlobal, InternalMissing, InternalNested, InternalReverseNested

public abstract class InternalSingleBucketAggregation
extends InternalAggregation
implements SingleBucketAggregation

A base class for all the single bucket aggregations.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalSingleBucketAggregation()
protected	InternalSingleBucketAggregation(String name, long docCount, InternalAggregations aggregations) Creates a single bucket aggregation.

Method Summary

Modifier and Type	Method and Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
InternalAggregations	getAggregations()
long	getDocCount()
protected abstract InternalSingleBucketAggregation	newAggregation(String name, long docCount, InternalAggregations subAggregations) Create a new empty sub aggregation.
void	readFrom(StreamInput in)
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
void	writeTo(StreamOutput out)

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

getName, readSize, toXContent, type, writeSize

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

getName

Constructor Detail

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation()

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(String name,
                                          long docCount,
                                          InternalAggregations aggregations)

Creates a single bucket aggregation.

Parameters:

name - The aggregation name.

docCount - The document count in the single bucket.

aggregations - The already built sub-aggregations that are associated with the bucket.

Method Detail

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface SingleBucketAggregation

Returns:

The number of documents in this bucket

getAggregations

public InternalAggregations getAggregations()

Specified by:

getAggregations in interface SingleBucketAggregation

Specified by:

getAggregations in interface HasAggregations

Returns:

The sub-aggregations of this bucket

newAggregation

protected abstract InternalSingleBucketAggregation newAggregation(String name,
                                                                  long docCount,
                                                                  InternalAggregations subAggregations)

Create a new empty sub aggregation. This must be a new instance on each call.

reduce

public InternalAggregation reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

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

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException