org.elasticsearch.search.aggregations.bucket

Class InternalSingleBucketAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Aggregation, SingleBucketAggregation, HasAggregations

Direct Known Subclasses:

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.ReduceContext

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

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

metaData, name

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalSingleBucketAggregation(StreamInput in) Read from a stream.
protected	InternalSingleBucketAggregation(java.lang.String name, long docCount, InternalAggregations aggregations, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData) Creates a single bucket aggregation.

Method Summary

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 boolean	doEquals(java.lang.Object obj) Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
protected int	doHashCode() Opportunity for subclasses to the InternalAggregation.hashCode() for this class.
InternalAggregation	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
InternalAggregations	getAggregations()
long	getDocCount()
java.lang.Object	getProperty(java.util.List<java.lang.String> path)
protected abstract InternalSingleBucketAggregation	newAggregation(java.lang.String name, long docCount, InternalAggregations subAggregations) Create a new empty sub aggregation.

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

equals, getMetaData, getName, getProperty, getType, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetaData, getName, getType

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Constructor Detail

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(java.lang.String name,
                                          long docCount,
                                          InternalAggregations aggregations,
                                          java.util.List<PipelineAggregator> pipelineAggregators,
                                          java.util.Map<java.lang.String,java.lang.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.

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(StreamInput in)
                                   throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

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(java.lang.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(java.util.List<InternalAggregation> aggregations,
                                    InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

getProperty

public java.lang.Object getProperty(java.util.List<java.lang.String> path)

Specified by:

getProperty in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

doEquals

protected boolean doEquals(java.lang.Object obj)

Description copied from class: InternalAggregation

Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class. This method can safely cast obj to the subclass since the InternalAggregation.equals(Object) method checks that obj is the same class as this

Specified by:

doEquals in class InternalAggregation

doHashCode

protected int doHashCode()

Description copied from class: InternalAggregation

Opportunity for subclasses to the InternalAggregation.hashCode() for this class.

Specified by:

doHashCode in class InternalAggregation