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

Class InternalGeoGrid<B extends InternalGeoGridBucket>

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>

org.opensearch.geo.search.aggregations.bucket.geogrid.InternalGeoGrid<B>

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, GeoGrid, Aggregation, MultiBucketsAggregation

Direct Known Subclasses:

InternalGeoHashGrid, InternalGeoTileGrid

public abstract class InternalGeoGrid<B extends InternalGeoGridBucket>
extends InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>
implements GeoGrid

Represents a grid of cells where each cell's location is determined by a specific geo hashing algorithm. All geo-grid hash-encoding in a grid are of the same precision and held internally as a single long for efficiency's sake.

Opensearch.internal:

Nested Class Summary

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

InternalMultiBucketAggregation.InternalBucket

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

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGrid

GeoGrid.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

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 final List<InternalGeoGridBucket>	buckets
protected final int	requiredSize

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

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalGeoGrid(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
List<InternalGeoGridBucket>	getBuckets()
int	hashCode()
InternalGeoGrid	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected InternalGeoGridBucket	reduceBucket(List<InternalGeoGridBucket> buckets, InternalAggregation.ReduceContext context)

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

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, create, createBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

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

getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.common.io.stream.NamedWriteable

getWriteableName

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

toXContent

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

isFragment

Field Details

requiredSize

protected final int requiredSize

buckets

protected final List<InternalGeoGridBucket> buckets

Constructor Details

InternalGeoGrid

public InternalGeoGrid(StreamInput in)
                throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getBuckets

public List<InternalGeoGridBucket> getBuckets()

Specified by:

getBuckets in interface GeoGrid

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>

Returns:

The buckets of this aggregation (each bucket representing a geo-grid cell)

reduce

public InternalGeoGrid reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Specified by:

reduce in class InternalAggregation

reduceBucket

protected InternalGeoGridBucket reduceBucket(List<InternalGeoGridBucket> buckets,
 InternalAggregation.ReduceContext context)

Specified by:

reduceBucket in class InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation