Package org.opensearch.geo.search.aggregations.metrics

Class InternalGeoBounds

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.geo.search.aggregations.metrics.InternalGeoBounds

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, GeoBounds, Aggregation

public class InternalGeoBounds
extends InternalAggregation
implements GeoBounds

Implementation of geo bounds agg

Opensearch.internal:

Nested Class Summary

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.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

Modifier and Type	Field	Description
final double	bottom
final double	negLeft
final double	negRight
final double	posLeft
final double	posRight
final double	top
final boolean	wrapLongitude

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
InternalGeoBounds(String name, double top, double bottom, double posLeft, double posRight, double negLeft, double negRight, boolean wrapLongitude, Map<String,Object> metadata)
InternalGeoBounds(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
GeoPoint	bottomRight()	Get the bottom-right location of the bounding box.
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
Object	getProperty(List<String> path)
String	getWriteableName()
int	hashCode()
protected boolean	mustReduceOnSingleInternalAgg()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
GeoPoint	topLeft()	Get the top-left location of the bounding box.

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

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, 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

Field Details

top

public final double top

bottom

public final double bottom

posLeft

public final double posLeft

posRight

public final double posRight

negLeft

public final double negLeft

negRight

public final double negRight

wrapLongitude

public final boolean wrapLongitude

Constructor Details

InternalGeoBounds

public InternalGeoBounds(String name,
 double top,
 double bottom,
 double posLeft,
 double posRight,
 double negLeft,
 double negRight,
 boolean wrapLongitude,
 Map<String,Object> metadata)

InternalGeoBounds

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

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

reduce

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

Specified by:

reduce in class InternalAggregation

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

doXContentBody

public org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                            throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

topLeft

public GeoPoint topLeft()

Description copied from interface: GeoBounds

Get the top-left location of the bounding box.

Specified by:

topLeft in interface GeoBounds

bottomRight

public GeoPoint bottomRight()

Description copied from interface: GeoBounds

Get the bottom-right location of the bounding box.

Specified by:

bottomRight in interface GeoBounds

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation