Package org.elasticsearch.search.aggregations.bucket.histogram

Class VariableWidthHistogramAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.histogram.VariableWidthHistogramAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class VariableWidthHistogramAggregationBuilder
extends ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

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 String	NAME
static org.elasticsearch.common.xcontent.ObjectParser<VariableWidthHistogramAggregationBuilder,String>	PARSER
static ValuesSourceRegistry.RegistryKey<VariableWidthHistogramAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

Modifier	Constructor	Description
	VariableWidthHistogramAggregationBuilder(String name)	Create a new builder with the given name.
	VariableWidthHistogramAggregationBuilder(StreamInput in)	Read in object data from a stream, for internal use only.
protected	VariableWidthHistogramAggregationBuilder(VariableWidthHistogramAggregationBuilder 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 ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected org.elasticsearch.common.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
int	getInitialBuffer()
int	getNumBuckets()
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
int	getShardSize()
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
VariableWidthHistogramAggregationBuilder	setInitialBuffer(int initialBuffer)
VariableWidthHistogramAggregationBuilder	setNumBuckets(int numBuckets)
VariableWidthHistogramAggregationBuilder	setShardSize(int shardSize)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

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, doRewrite, 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 String NAME

See Also:

Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<VariableWidthHistogramAggregatorSupplier> REGISTRY_KEY

PARSER

public static final org.elasticsearch.common.xcontent.ObjectParser<VariableWidthHistogramAggregationBuilder,String> PARSER

Constructor Details

VariableWidthHistogramAggregationBuilder

public VariableWidthHistogramAggregationBuilder(String name)

Create a new builder with the given name.

VariableWidthHistogramAggregationBuilder

public VariableWidthHistogramAggregationBuilder(StreamInput in)
                                         throws IOException

Read in object data from a stream, for internal use only.

Throws:

IOException

VariableWidthHistogramAggregationBuilder

protected VariableWidthHistogramAggregationBuilder(VariableWidthHistogramAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metaData)

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

setNumBuckets

public VariableWidthHistogramAggregationBuilder setNumBuckets(int numBuckets)

setShardSize

public VariableWidthHistogramAggregationBuilder setShardSize(int shardSize)

setInitialBuffer

public VariableWidthHistogramAggregationBuilder setInitialBuffer(int initialBuffer)

getNumBuckets

public int getNumBuckets()

getShardSize

public int getShardSize()

getInitialBuffer

public int getInitialBuffer()

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

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. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

Throws:

IOException

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

Throws:

IOException

doXContentBody

protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                    throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<VariableWidthHistogramAggregationBuilder>