Class AbstractAggregationBuilder<AB extends AbstractAggregationBuilder<AB>>
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,BaseAggregationBuilder
- Direct Known Subclasses:
AdjacencyMatrixAggregationBuilder
,CompositeAggregationBuilder
,FilterAggregationBuilder
,FiltersAggregationBuilder
,GlobalAggregationBuilder
,MultiValuesSourceAggregationBuilder
,NestedAggregationBuilder
,ReverseNestedAggregationBuilder
,SamplerAggregationBuilder
,ScriptedMetricAggregationBuilder
,SignificantTextAggregationBuilder
,TopHitsAggregationBuilder
,ValuesSourceAggregationBuilder
public abstract class AbstractAggregationBuilder<AB extends AbstractAggregationBuilder<AB>> extends AggregationBuilder
Base implementation of a
AggregationBuilder
.-
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 protected java.util.Map<java.lang.String,java.lang.Object>
metadata
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Constructor Summary
Constructors Modifier Constructor Description AbstractAggregationBuilder(java.lang.String name)
Constructs a new aggregation builder.protected
AbstractAggregationBuilder(StreamInput in)
Read from a stream.protected
AbstractAggregationBuilder(AbstractAggregationBuilder<AB> clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description AggregatorFactory
build(QueryShardContext queryShardContext, AggregatorFactory parent)
Internal: build anAggregatorFactory
based on the configuration of this builder.protected abstract AggregatorFactory
doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
protected abstract void
doWriteTo(StreamOutput out)
boolean
equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>
getMetadata()
Return any associated metadata with thisAggregationBuilder
.java.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
protected abstract org.elasticsearch.common.xcontent.XContentBuilder
internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
AB
setMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
Associate metadata with thisAggregationBuilder
.AB
subAggregation(AggregationBuilder aggregation)
Add a sub aggregation to this builder.AB
subAggregation(PipelineAggregationBuilder aggregation)
Add a sub aggregation to this aggregation.AB
subAggregations(AggregatorFactories.Builder subFactories)
Registers sub-factories with this factory.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
bucketCardinality, buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder
getType
-
Field Details
-
metadata
protected java.util.Map<java.lang.String,java.lang.Object> metadata
-
-
Constructor Details
-
AbstractAggregationBuilder
public AbstractAggregationBuilder(java.lang.String name)Constructs a new aggregation builder.- Parameters:
name
- The aggregation name
-
AbstractAggregationBuilder
protected AbstractAggregationBuilder(AbstractAggregationBuilder<AB> clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) -
AbstractAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Throws:
java.io.IOException
-
doWriteTo
- Throws:
java.io.IOException
-
subAggregation
Description copied from class:AggregationBuilder
Add a sub aggregation to this builder.- Specified by:
subAggregation
in classAggregationBuilder
-
subAggregation
Add a sub aggregation to this aggregation.- Specified by:
subAggregation
in classAggregationBuilder
-
subAggregations
Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.- Specified by:
subAggregations
in interfaceBaseAggregationBuilder
- Specified by:
subAggregations
in classAggregationBuilder
- Parameters:
subFactories
- The sub-factories- Returns:
- this factory (fluent interface)
-
setMetadata
Description copied from class:AggregationBuilder
Associate metadata with thisAggregationBuilder
.- Specified by:
setMetadata
in interfaceBaseAggregationBuilder
- Specified by:
setMetadata
in classAggregationBuilder
-
getMetadata
public java.util.Map<java.lang.String,java.lang.Object> getMetadata()Description copied from class:AggregationBuilder
Return any associated metadata with thisAggregationBuilder
.- Specified by:
getMetadata
in classAggregationBuilder
-
getWriteableName
public final java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
build
public final AggregatorFactory build(QueryShardContext queryShardContext, AggregatorFactory parent) throws java.io.IOExceptionDescription copied from class:AggregationBuilder
Internal: build anAggregatorFactory
based on the configuration of this builder.- Specified by:
build
in classAggregationBuilder
- Throws:
java.io.IOException
-
doBuild
protected abstract AggregatorFactory doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder) throws java.io.IOException- Throws:
java.io.IOException
-
toXContent
public final org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
internalXContent
protected abstract org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-