org.elasticsearch.search.aggregations.bucket.filters

Class InternalFilters

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.filters.InternalFilters

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, Filters, MultiBucketsAggregation

public class InternalFilters
extends InternalAggregation
implements Filters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalFilters.Bucket

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

Modifier and Type	Field and Description
static InternalAggregation.Type	TYPE

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

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalFilters()
InternalFilters(String name, List<InternalFilters.Bucket> buckets, boolean keyed)

Method Summary

Modifier and Type	Method and Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
InternalFilters.Bucket	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<InternalFilters.Bucket>	getBuckets() The buckets created by this aggregation.
void	readFrom(StreamInput in)
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
static void	registerStream()
InternalAggregation.Type	type()
void	writeTo(StreamOutput out)

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

getName, readSize, toXContent, 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

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

Constructor Detail

InternalFilters

public InternalFilters()

InternalFilters

public InternalFilters(String name,
                       List<InternalFilters.Bucket> buckets,
                       boolean keyed)

Method Detail

registerStream

public static void registerStream()

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

getBuckets

public Collection<InternalFilters.Bucket> getBuckets()

Description copied from interface: Filters

The buckets created by this aggregation.

Specified by:

getBuckets in interface Filters

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

public InternalFilters.Bucket getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface Filters

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the requested bucket.

Returns:

The bucket

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