Package org.elasticsearch.search.aggregations.bucket.composite

Interface CompositeAggregation

All Superinterfaces:

Aggregation, MultiBucketsAggregation, ToXContent, ToXContentFragment

All Known Implementing Classes:

InternalComposite, ParsedComposite

public interface CompositeAggregation
extends MultiBucketsAggregation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CompositeAggregation.Bucket

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

Field Summary

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	afterKey()	Returns the last key in this aggregation.
static XContentBuilder	bucketToXContent(CompositeAggregation.Bucket bucket, XContentBuilder builder, ToXContent.Params params)
static void	buildCompositeMap(java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> composite, XContentBuilder builder)
java.util.List<? extends CompositeAggregation.Bucket>	getBuckets()
static XContentBuilder	toXContentFragment(CompositeAggregation aggregation, XContentBuilder builder, ToXContent.Params params)

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

getMetaData, getName, getType

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

toXContent

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

isFragment

Method Detail

getBuckets

java.util.List<? extends CompositeAggregation.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

afterKey

java.util.Map<java.lang.String,java.lang.Object> afterKey()

Returns the last key in this aggregation. It can be used to retrieve the buckets that are after these values. See CompositeAggregationBuilder.aggregateAfter(java.util.Map<java.lang.String, java.lang.Object>).

bucketToXContent

static XContentBuilder bucketToXContent(CompositeAggregation.Bucket bucket,
                                        XContentBuilder builder,
                                        ToXContent.Params params)
                                 throws java.io.IOException

Throws:

java.io.IOException

toXContentFragment

static XContentBuilder toXContentFragment(CompositeAggregation aggregation,
                                          XContentBuilder builder,
                                          ToXContent.Params params)
                                   throws java.io.IOException

Throws:

java.io.IOException

buildCompositeMap

static void buildCompositeMap(java.lang.String fieldName,
                              java.util.Map<java.lang.String,java.lang.Object> composite,
                              XContentBuilder builder)
                       throws java.io.IOException

Throws:

java.io.IOException