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, InternalSampler

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

metaData, 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, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData) Creates a single bucket aggregation.

Method Summary

Methods

Modifier and Type	Method and Description
InternalSingleBucketAggregation	create(InternalAggregations subAggregations) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided sub-aggregations.
protected void	doReadFrom(StreamInput in)
InternalAggregation	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
InternalAggregations	getAggregations()
long	getDocCount()
Object	getProperty(List<String> path)
protected abstract InternalSingleBucketAggregation	newAggregation(String name, long docCount, InternalAggregations subAggregations) Create a new empty sub aggregation.

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

getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, type, writeSize, writeTo

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, getProperty

Constructor Detail

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation()

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(String name,
                               long docCount,
                               InternalAggregations aggregations,
                               List<PipelineAggregator> pipelineAggregators,
                               Map<String,Object> metaData)

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

create

public InternalSingleBucketAggregation create(InternalAggregations subAggregations)

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided sub-aggregations.

Parameters:

subAggregations - the buckets to use in the new Aggregation

Returns:

the new Aggregation

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.

doReduce

public InternalAggregation doReduce(List<InternalAggregation> aggregations,
                           InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

Specified by:

doReadFrom in class InternalAggregation

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException