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
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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
DEFAULT_PREALLOCATION, factoriesBuilder, name
Fields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDS
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 AggregationBuilder.BucketCardinality
bucketCardinality()
A rough count of the number of buckets thatAggregator
s 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(java.lang.Object obj)
java.util.List<FiltersAggregator.KeyedFilter>
filters()
Get the filters.java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
protected org.elasticsearch.common.xcontent.XContentBuilder
internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean
isKeyed()
boolean
otherBucket()
Get whether to include a bucket for documents not matching any filterFiltersAggregationBuilder
otherBucket(boolean otherBucket)
Set whether to include a bucket for documents not matching any filterjava.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, org.elasticsearch.common.xcontent.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 replacingAggregationBuilder.factoriesBuilder
andmetadata
.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, getName, getOutputFieldNames, 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 Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
FiltersAggregationBuilder
- Parameters:
name
- the name of this aggregationfilters
- the KeyedFilters to use with this aggregation.
-
FiltersAggregationBuilder
- Parameters:
name
- the name of this aggregationfilters
- 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
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
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 replacingAggregationBuilder.factoriesBuilder
andmetadata
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<FiltersAggregationBuilder>
- Throws:
java.io.IOException
-
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
Get the filters. This will be an unmodifiable list -
isKeyed
public boolean isKeyed()- Returns:
- true if this builders filters have a key
-
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. -
bucketCardinality
Description copied from class:AggregationBuilder
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinality
in classAggregationBuilder
-
doRewrite
protected AggregationBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOExceptionDescription 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 classAggregationBuilder
- Throws:
java.io.IOException
-
doBuild
protected AggregatorFactory doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
doBuild
in classAbstractAggregationBuilder<FiltersAggregationBuilder>
- Throws:
java.io.IOException
-
internalXContent
protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
internalXContent
in classAbstractAggregationBuilder<FiltersAggregationBuilder>
- Throws:
java.io.IOException
-
parse
public static FiltersAggregationBuilder parse(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractAggregationBuilder<FiltersAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classAbstractAggregationBuilder<FiltersAggregationBuilder>
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-