Package org.elasticsearch.search.aggregations.bucket.filter

Class FiltersAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder, MultiBucketAggregationBuilder

public class FiltersAggregationBuilder
extends AbstractAggregationBuilder<FiltersAggregationBuilder>
implements MultiBucketAggregationBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

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

metaData

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

factoriesBuilder, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FiltersAggregationBuilder(java.lang.String name, QueryBuilder... filters)
FiltersAggregationBuilder(java.lang.String name, FiltersAggregator.KeyedFilter... filters)
FiltersAggregationBuilder(StreamInput in)	Read from a stream.
FiltersAggregationBuilder(FiltersAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
protected AggregatorFactory<?>	doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected AggregationBuilder	doRewrite(QueryRewriteContext queryShardContext)	Rewrites this aggregation builder into its primitive form.
protected void	doWriteTo(StreamOutput out)
java.util.List<FiltersAggregator.KeyedFilter>	filters()	Get the filters.
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
boolean	isKeyed()
boolean	otherBucket()	Get whether to include a bucket for documents not matching any filter
FiltersAggregationBuilder	otherBucket(boolean otherBucket)	Set whether to include a bucket for documents not matching any filter
java.lang.String	otherBucketKey()	Get the key to use for the bucket for documents not matching any filter.
FiltersAggregationBuilder	otherBucketKey(java.lang.String otherBucketKey)	Set the key to use for the bucket for documents not matching any filter.
static FiltersAggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData.

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

build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

FiltersAggregationBuilder

public FiltersAggregationBuilder(java.lang.String name,
                                 FiltersAggregator.KeyedFilter... filters)

Parameters:

name - the name of this aggregation

filters - the KeyedFilters to use with this aggregation.

FiltersAggregationBuilder

public FiltersAggregationBuilder(java.lang.String name,
                                 QueryBuilder... filters)

Parameters:

name - the name of this aggregation

filters - the filters to use with this aggregation

FiltersAggregationBuilder

public FiltersAggregationBuilder(FiltersAggregationBuilder clone,
                                 AggregatorFactories.Builder factoriesBuilder,
                                 java.util.Map<java.lang.String,java.lang.Object> metaData)

FiltersAggregationBuilder

public FiltersAggregationBuilder(StreamInput in)
                          throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
                                         java.util.Map<java.lang.String,java.lang.Object> metaData)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

java.io.IOException

otherBucket

public FiltersAggregationBuilder otherBucket(boolean otherBucket)

Set whether to include a bucket for documents not matching any filter

otherBucket

public boolean otherBucket()

Get whether to include a bucket for documents not matching any filter

filters

public java.util.List<FiltersAggregator.KeyedFilter> filters()

Get the filters. This will be an unmodifiable list

isKeyed

public boolean isKeyed()

Returns:

true if this builders filters have a key

otherBucketKey

public FiltersAggregationBuilder otherBucketKey(java.lang.String otherBucketKey)

Set the key to use for the bucket for documents not matching any filter.

otherBucketKey

public java.lang.String otherBucketKey()

Get the key to use for the bucket for documents not matching any filter.

doRewrite

protected AggregationBuilder doRewrite(QueryRewriteContext queryShardContext)
                                throws java.io.IOException

Description copied from class: AggregationBuilder

Rewrites this aggregation builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Overrides:

doRewrite in class AggregationBuilder

Throws:

java.io.IOException

doBuild

protected AggregatorFactory<?> doBuild(SearchContext context,
                                       AggregatorFactory<?> parent,
                                       AggregatorFactories.Builder subFactoriesBuilder)
                                throws java.io.IOException

Specified by:

doBuild in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

java.io.IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

java.io.IOException

parse

public static FiltersAggregationBuilder parse(java.lang.String aggregationName,
                                              XContentParser parser)
                                       throws java.io.IOException

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractAggregationBuilder<FiltersAggregationBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractAggregationBuilder<FiltersAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

Specified by:

getType in interface BaseAggregationBuilder