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

Class InternalGeoHashGrid

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

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

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

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

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, GeoGrid, Aggregation, MultiBucketsAggregation

public class InternalGeoHashGrid
extends InternalGeoGrid<InternalGeoHashGridBucket>

Represents a grid of cells where each cell's location is determined by a geohash. All geohashes 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.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.InternalGeoGrid

buckets, 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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalGeoHashGrid(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected InternalGeoGrid	create(String name, int requiredSize, List buckets, Map metadata)
InternalGeoGrid	create(List<InternalGeoGridBucket> buckets)
protected InternalGeoHashGridBucket	createBucket(long hashAsLong, long docCount, InternalAggregations aggregations)
InternalGeoGridBucket	createBucket(InternalAggregations aggregations, InternalGeoGridBucket prototype)
protected org.opensearch.core.common.io.stream.Writeable.Reader<InternalGeoHashGridBucket>	getBucketReader()
String	getWriteableName()

Methods inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.InternalGeoGrid

doWriteTo, doXContentBody, equals, getBuckets, hashCode, reduce, reduceBucket

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

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, 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.core.xcontent.ToXContent

toXContent

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

isFragment

Constructor Details

InternalGeoHashGrid

public InternalGeoHashGrid(org.opensearch.core.common.io.stream.StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

create

public InternalGeoGrid create(List<InternalGeoGridBucket> buckets)

Specified by:

create in class InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>

createBucket

public InternalGeoGridBucket createBucket(InternalAggregations aggregations,
 InternalGeoGridBucket prototype)

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalGeoGrid,InternalGeoGridBucket>

create

protected InternalGeoGrid create(String name,
 int requiredSize,
 List buckets,
 Map metadata)

Specified by:

create in class InternalGeoGrid<InternalGeoHashGridBucket>

createBucket

protected InternalGeoHashGridBucket createBucket(long hashAsLong,
 long docCount,
 InternalAggregations aggregations)

Specified by:

createBucket in class InternalGeoGrid<InternalGeoHashGridBucket>

getBucketReader

protected org.opensearch.core.common.io.stream.Writeable.Reader<InternalGeoHashGridBucket> getBucketReader()

Specified by:

getBucketReader in class InternalGeoGrid<InternalGeoHashGridBucket>

getWriteableName

public String getWriteableName()