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

Class InternalGeoGridBucket<B extends InternalGeoGridBucket>

java.lang.Object

org.opensearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.opensearch.search.aggregations.bucket.geogrid.InternalGeoGridBucket<B>

All Implemented Interfaces:

Comparable<InternalGeoGridBucket>, Writeable, org.opensearch.common.xcontent.ToXContent, GeoGrid.Bucket, MultiBucketsAggregation.Bucket, HasAggregations

Direct Known Subclasses:

InternalGeoHashGridBucket, InternalGeoTileGridBucket

public abstract class InternalGeoGridBucket<B extends InternalGeoGridBucket>
extends InternalMultiBucketAggregation.InternalBucket
implements GeoGrid.Bucket, Comparable<InternalGeoGridBucket>

Base implementation of geogrid aggs

Opensearch.internal:

Nested Class Summary

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected InternalAggregations	aggregations
protected long	docCount
protected long	hashAsLong

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalGeoGridBucket(long hashAsLong, long docCount, InternalAggregations aggregations)
InternalGeoGridBucket(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
int	compareTo(InternalGeoGridBucket other)
boolean	equals(Object o)
Aggregations	getAggregations()
long	getDocCount()
int	hashCode()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

getKey, getKeyAsString

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

isFragment

Field Details

hashAsLong

protected long hashAsLong

docCount

protected long docCount

aggregations

protected InternalAggregations aggregations

Constructor Details

InternalGeoGridBucket

public InternalGeoGridBucket(long hashAsLong,
 long docCount,
 InternalAggregations aggregations)

InternalGeoGridBucket

public InternalGeoGridBucket(StreamInput in)
                      throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Returns:

The sub-aggregations of this bucket

compareTo

public int compareTo(InternalGeoGridBucket other)

Specified by:

compareTo in interface Comparable<B extends InternalGeoGridBucket>

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object