Package org.elasticsearch.search.aggregations.bucket.geogrid

Class GeoGridAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder, MultiBucketAggregationBuilder

public class GeoGridAggregationBuilder
extends ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>
implements MultiBucketAggregationBuilder

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 class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

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

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 int	DEFAULT_MAX_NUM_CELLS
static int	DEFAULT_PRECISION
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

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

config

Constructor Summary

Constructors

Modifier	Constructor	Description
	GeoGridAggregationBuilder(java.lang.String name)
	GeoGridAggregationBuilder(StreamInput in)	Read from a stream.
protected	GeoGridAggregationBuilder(GeoGridAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected ValuesSourceAggregatorFactory<ValuesSource.GeoPoint,?>	innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource.GeoPoint> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
static GeoGridAggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
int	precision()
GeoGridAggregationBuilder	precision(int precision)
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.
int	shardSize()
GeoGridAggregationBuilder	shardSize(int shardSize)
int	size()
GeoGridAggregationBuilder	size(int size)

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

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

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

doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

DEFAULT_MAX_NUM_CELLS

public static final int DEFAULT_MAX_NUM_CELLS

See Also:

Constant Field Values

Constructor Detail

GeoGridAggregationBuilder

public GeoGridAggregationBuilder(java.lang.String name)

GeoGridAggregationBuilder

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

GeoGridAggregationBuilder

public GeoGridAggregationBuilder(StreamInput in)
                          throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

public static GeoGridAggregationBuilder parse(java.lang.String aggregationName,
                                              XContentParser parser)
                                       throws java.io.IOException

Throws:

java.io.IOException

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

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws java.io.IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

Throws:

java.io.IOException

precision

public GeoGridAggregationBuilder precision(int precision)

precision

public int precision()

size

public GeoGridAggregationBuilder size(int size)

size

public int size()

shardSize

public GeoGridAggregationBuilder shardSize(int shardSize)

shardSize

public int shardSize()

innerBuild

protected ValuesSourceAggregatorFactory<ValuesSource.GeoPoint,?> innerBuild(SearchContext context,
                                                                            ValuesSourceConfig<ValuesSource.GeoPoint> config,
                                                                            AggregatorFactory<?> parent,
                                                                            AggregatorFactories.Builder subFactoriesBuilder)
                                                                     throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

Throws:

java.io.IOException

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class ValuesSourceAggregationBuilder<ValuesSource.GeoPoint,GeoGridAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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

Specified by:

getType in interface BaseAggregationBuilder