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

Class FilterAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.filter.FilterAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class FilterAggregationBuilder
extends AbstractAggregationBuilder<FilterAggregationBuilder>

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

Modifier	Constructor	Description
	FilterAggregationBuilder(java.lang.String name, QueryBuilder filter)
	FilterAggregationBuilder(StreamInput in)	Read from a stream.
protected	FilterAggregationBuilder(FilterAggregationBuilder 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)
QueryBuilder	getFilter()
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static FilterAggregationBuilder	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

FilterAggregationBuilder

public FilterAggregationBuilder(java.lang.String name,
                                QueryBuilder filter)

Parameters:

name - the name of this aggregation

filter - Set the filter to use, only documents that match this filter will fall into the bucket defined by this Filter aggregation.

FilterAggregationBuilder

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

FilterAggregationBuilder

public FilterAggregationBuilder(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<FilterAggregationBuilder>

Throws:

java.io.IOException

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<FilterAggregationBuilder>

Throws:

java.io.IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<FilterAggregationBuilder>

Throws:

java.io.IOException

parse

public static FilterAggregationBuilder 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<FilterAggregationBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractAggregationBuilder<FilterAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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

getFilter

public QueryBuilder getFilter()