Package org.elasticsearch.search.aggregations

Class ParsedMultiBucketAggregation.ParsedBucket

java.lang.Object

org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

All Implemented Interfaces:

MultiBucketsAggregation.Bucket, HasAggregations, org.elasticsearch.xcontent.ToXContent

Direct Known Subclasses:

ParsedAdjacencyMatrix.ParsedBucket, ParsedAutoDateHistogram.ParsedBucket, ParsedBinaryRange.ParsedBucket, ParsedComposite.ParsedBucket, ParsedDateHistogram.ParsedBucket, ParsedFilters.ParsedBucket, ParsedGeoGridBucket, ParsedRange.ParsedBucket, ParsedRareTerms.ParsedBucket, ParsedSignificantTerms.ParsedBucket, ParsedTerms.ParsedBucket, ParsedVariableWidthHistogram.ParsedBucket

Enclosing class:

ParsedMultiBucketAggregation<B extends MultiBucketsAggregation.Bucket>

public abstract static class ParsedMultiBucketAggregation.ParsedBucket
extends Object
implements MultiBucketsAggregation.Bucket

Nested Class Summary

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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedBucket()

Method Summary

Modifier and Type	Method	Description
Aggregations	getAggregations()
long	getDocCount()
String	getKeyAsString()
protected boolean	isKeyed()
protected org.elasticsearch.xcontent.XContentBuilder	keyToXContent(org.elasticsearch.xcontent.XContentBuilder builder)
protected static <B extends ParsedMultiBucketAggregation.ParsedBucket> B	parseXContent(org.elasticsearch.xcontent.XContentParser parser, boolean keyed, Supplier<B> bucketSupplier, CheckedBiConsumer<org.elasticsearch.xcontent.XContentParser,B,IOException> keyConsumer)
protected void	setAggregations(Aggregations aggregations)
protected void	setDocCount(long docCount)
protected void	setKeyAsString(String keyAsString)
void	setKeyed(boolean keyed)
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)

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.bucket.MultiBucketsAggregation.Bucket

getKey

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

isFragment

Constructor Details

ParsedBucket

public ParsedBucket()

Method Details

setKeyAsString

protected void setKeyAsString(String keyAsString)

getKeyAsString

public String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

setDocCount

protected void setDocCount(long docCount)

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

setKeyed

public void setKeyed(boolean keyed)

isKeyed

protected boolean isKeyed()

setAggregations

protected void setAggregations(Aggregations aggregations)

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Returns:

The sub-aggregations of this bucket

toXContent

public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                      throws IOException

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

keyToXContent

protected org.elasticsearch.xcontent.XContentBuilder keyToXContent(org.elasticsearch.xcontent.XContentBuilder builder)
                                                            throws IOException

Throws:

IOException

parseXContent

protected static <B extends ParsedMultiBucketAggregation.ParsedBucket>
B parseXContent(org.elasticsearch.xcontent.XContentParser parser,
 boolean keyed,
 Supplier<B> bucketSupplier,
 CheckedBiConsumer<org.elasticsearch.xcontent.XContentParser,B,IOException> keyConsumer)
         throws IOException

Throws:

IOException