Module org.elasticsearch.server

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, VersionedNamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class FiltersAggregationBuilder
extends AbstractAggregationBuilder<FiltersAggregationBuilder>

Nested Class Summary

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.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 final String	NAME

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected AggregationBuilder	doRewrite(QueryRewriteContext queryRewriteContext)	Rewrites this aggregation builder into its primitive form.
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
List<FiltersAggregator.KeyedFilter>	filters()	Get the filters.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
boolean	isKeyed()
boolean	keyedBucket()	Get whether to return keyed bucket in array
FiltersAggregationBuilder	keyedBucket(boolean keyedBucket)	Set whether to return keyed bucket in array
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
String	otherBucketKey()	Get the key to use for the bucket for documents not matching any filter.
FiltersAggregationBuilder	otherBucketKey(String otherBucketKey)	Set the key to use for the bucket for documents not matching any filter.
static FiltersAggregationBuilder	parse(String aggregationName, XContentParser parser)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
boolean	supportsSampling()	Does this aggregation support running with in a sampling context.

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, deepCopy, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsParallelCollection, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

FiltersAggregationBuilder

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

Parameters:

name - the name of this aggregation

filters - the KeyedFilters to use with this aggregation.

FiltersAggregationBuilder

public FiltersAggregationBuilder(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,
 Map<String,Object> metadata)

FiltersAggregationBuilder

public FiltersAggregationBuilder(StreamInput in)
                          throws IOException

Read from a stream.

Throws:

IOException

Method Details

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

Specified by:

shallowCopy in class AggregationBuilder

supportsSampling

public boolean supportsSampling()

Description copied from class: AggregationBuilder

Does this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override the InternalAggregation.finalizeSampling(SamplingContext) and scales any values that require scaling.

Overrides:

supportsSampling in class AggregationBuilder

Returns:

does this aggregation builder support sampling

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

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 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(String otherBucketKey)

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

otherBucketKey

public String otherBucketKey()

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

keyedBucket

public FiltersAggregationBuilder keyedBucket(boolean keyedBucket)

Set whether to return keyed bucket in array

keyedBucket

public boolean keyedBucket()

Get whether to return keyed bucket in array

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doRewrite

protected AggregationBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                                throws 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:

IOException

doBuild

protected AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                             throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<FiltersAggregationBuilder>

Throws:

IOException

parse

public static FiltersAggregationBuilder parse(String aggregationName,
 XContentParser parser)
                                       throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<FiltersAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<FiltersAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to