Package org.opensearch.geo.search.aggregations.bucket.geogrid

Class GeoGridAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

Direct Known Subclasses:

GeoHashGridAggregationBuilder, GeoTileGridAggregationBuilder

public abstract class GeoGridAggregationBuilder
extends ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

Base Aggregation Builder for geohash_grid and geotile_grid aggs

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	GeoGridAggregationBuilder.PrecisionParser	A precision parser

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

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

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	precision
protected int	requiredSize
protected int	shardSize

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

config

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

metadata

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

factoriesBuilder, name

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final AggregationBuilder.BucketCardinality	bucketCardinality()
protected abstract ValuesSourceAggregatorFactory	createFactory(String name, ValuesSourceConfig config, int precision, int requiredSize, int shardSize, GeoBoundingBox geoBoundingBox, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metadata)	Creates a new instance of the ValuesSourceAggregatorFactory-derived class specific to the geo aggregation.
static <T extends GeoGridAggregationBuilder> ObjectParser<T,String>	createParser(String name, GeoGridAggregationBuilder.PrecisionParser precisionParser, Function<String,T> ctor)
protected ValuesSourceType	defaultValueSourceType()
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
GeoBoundingBox	geoBoundingBox()
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)
int	precision()
abstract GeoGridAggregationBuilder	precision(int precision)	method to validate and set the precision value
GeoGridAggregationBuilder	setGeoBoundingBox(GeoBoundingBox geoBoundingBox)
int	shardSize()
GeoGridAggregationBuilder	shardSize(int shardSize)
int	size()
GeoGridAggregationBuilder	size(int size)

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

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

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

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

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

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.opensearch.search.aggregations.BaseAggregationBuilder

getType

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

precision

protected int precision

requiredSize

protected int requiredSize

shardSize

protected int shardSize

Constructor Details

GeoGridAggregationBuilder

public GeoGridAggregationBuilder(String name)

GeoGridAggregationBuilder

protected GeoGridAggregationBuilder(GeoGridAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

GeoGridAggregationBuilder

public GeoGridAggregationBuilder(StreamInput in)
                          throws IOException

Read from a stream.

Throws:

IOException

Method Details

createParser

public static <T extends GeoGridAggregationBuilder>
ObjectParser<T,String> createParser(String name,
 GeoGridAggregationBuilder.PrecisionParser precisionParser,
 Function<String,T> ctor)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

Throws:

IOException

precision

public abstract GeoGridAggregationBuilder precision(int precision)

method to validate and set the precision value

Parameters:

precision - the precision to set for the aggregation

Returns:

the GeoGridAggregationBuilder builder

createFactory

protected abstract ValuesSourceAggregatorFactory createFactory(String name,
 ValuesSourceConfig config,
 int precision,
 int requiredSize,
 int shardSize,
 GeoBoundingBox geoBoundingBox,
 QueryShardContext queryShardContext,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder,
 Map<String,Object> metadata)
                                                        throws IOException

Creates a new instance of the ValuesSourceAggregatorFactory-derived class specific to the geo aggregation.

Throws:

IOException

precision

public int precision()

size

public GeoGridAggregationBuilder size(int size)

size

public int size()

shardSize

public GeoGridAggregationBuilder shardSize(int shardSize)

shardSize

public int shardSize()

setGeoBoundingBox

public GeoGridAggregationBuilder setGeoBoundingBox(GeoBoundingBox geoBoundingBox)

geoBoundingBox

public GeoBoundingBox geoBoundingBox()

bucketCardinality

public final AggregationBuilder.BucketCardinality bucketCardinality()

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

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

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>