org.elasticsearch.search.aggregations.bucket.filters

Class InternalFilters

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<InternalFilters,InternalFilters.Bucket>

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

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, Filters, MultiBucketsAggregation

public class InternalFilters
extends InternalMultiBucketAggregation<InternalFilters,InternalFilters.Bucket>
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.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

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

metaData, 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, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
InternalFilters	create(List<InternalFilters.Bucket> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalFilters.Bucket	createBucket(InternalAggregations aggregations, InternalFilters.Bucket prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and 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)
InternalFilters.Bucket	getBucketByKey(String key)
List<InternalFilters.Bucket>	getBuckets() The buckets created by this aggregation.
static void	registerStream()
InternalAggregation.Type	type()

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

getProperty

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

getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, 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

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,
               List<PipelineAggregator> pipelineAggregators,
               Map<String,Object> metaData)

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

create

public InternalFilters create(List<InternalFilters.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

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

Specified by:

create in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public InternalFilters.Bucket createBucket(InternalAggregations aggregations,
                                  InternalFilters.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

getBuckets

public List<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)

Specified by:

getBucketByKey in interface Filters

doReduce

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

Specified by:

doReduce 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