org.elasticsearch.search.aggregations.bucket.filters

Class FiltersAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<FiltersAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.filters.FiltersAggregationBuilder

All Implemented Interfaces:

ToXContent

public class FiltersAggregationBuilder
extends AggregationBuilder<FiltersAggregationBuilder>

Builder for the Filters aggregation.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
FiltersAggregationBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FiltersAggregationBuilder	filter(QueryBuilder filter) Add a new filter with no key.
FiltersAggregationBuilder	filter(String key, QueryBuilder filter) Add a new filter with the given key.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
FiltersAggregationBuilder	otherBucket(boolean otherBucket) Include a bucket for documents not matching any filter
FiltersAggregationBuilder	otherBucketKey(String otherBucketKey) The key to use for the bucket for documents not matching any filter.

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

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

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

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FiltersAggregationBuilder

public FiltersAggregationBuilder(String name)

Sole constructor.

Method Detail

filter

public FiltersAggregationBuilder filter(String key,
                               QueryBuilder filter)

Add a new filter with the given key. NOTE: if a filter was already defined for this key, then this filter will replace it. NOTE: the same FiltersAggregationBuilder cannot have both keyed and non-keyed filters

filter

public FiltersAggregationBuilder filter(QueryBuilder filter)

Add a new filter with no key. NOTE: the same FiltersAggregationBuilder cannot have both keyed and non-keyed filters.

otherBucket

public FiltersAggregationBuilder otherBucket(boolean otherBucket)

Include a bucket for documents not matching any filter

otherBucketKey

public FiltersAggregationBuilder otherBucketKey(String otherBucketKey)

The key to use for the bucket for documents not matching any filter. Will implicitly enable the other bucket if set.

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                               ToXContent.Params params)
                                    throws IOException

Specified by:

internalXContent in class AggregationBuilder<FiltersAggregationBuilder>

Throws:

IOException