Package org.opensearch.common.geo.builders

Class EnvelopeBuilder

java.lang.Object

org.opensearch.common.geo.builders.ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

org.opensearch.common.geo.builders.EnvelopeBuilder

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

public class EnvelopeBuilder
extends ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

Builds an envelope geometry

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.common.geo.builders.ShapeBuilder

ShapeBuilder.Edge, ShapeBuilder.Orientation

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
static final GeoShapeType	TYPE

Fields inherited from class org.opensearch.common.geo.builders.ShapeBuilder

AUTO_INDEX_JTS_GEOMETRY, AUTO_VALIDATE_JTS_GEOMETRY, coordinates, DATELINE, FACTORY, INTERSECTION_ORDER, LOGGER, MULTI_POLYGON_MAY_OVERLAP, SPATIAL_CONTEXT, wrapdateline, ZERO_ZERO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EnvelopeBuilder(org.locationtech.jts.geom.Coordinate topLeft, org.locationtech.jts.geom.Coordinate bottomRight)	Build an envelope from the top left and bottom right coordinates.
EnvelopeBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
org.locationtech.jts.geom.Coordinate	bottomRight()
org.opensearch.geometry.Rectangle	buildGeometry()	build lucene geometry.
org.locationtech.spatial4j.shape.Rectangle	buildS4J()	Create a new Shape from this builder.
protected StringBuilder	contentToWKT()
boolean	equals(Object obj)
int	hashCode()
int	numDimensions()	tracks number of dimensions for this shape
org.locationtech.jts.geom.Coordinate	topLeft()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
GeoShapeType	type()	get the shapes type
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.common.geo.builders.ShapeBuilder

coordinate, coordinate, coordinateListToWKT, coordinates, coordinates, coordinates, coordinatesToXcontent, debugEnabled, getWriteableName, intersection, intersections, jtsGeometry, readFromStream, shift, toString, toWKT, toXContent, writeCoordinateTo

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

TYPE

public static final GeoShapeType TYPE

Constructor Details

EnvelopeBuilder

public EnvelopeBuilder(org.locationtech.jts.geom.Coordinate topLeft,
 org.locationtech.jts.geom.Coordinate bottomRight)

Build an envelope from the top left and bottom right coordinates.

EnvelopeBuilder

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

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

Throws:

IOException

topLeft

public org.locationtech.jts.geom.Coordinate topLeft()

bottomRight

public org.locationtech.jts.geom.Coordinate bottomRight()

contentToWKT

protected StringBuilder contentToWKT()

Overrides:

contentToWKT in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

toXContent

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

Throws:

IOException

buildS4J

public org.locationtech.spatial4j.shape.Rectangle buildS4J()

Description copied from class: ShapeBuilder

Create a new Shape from this builder. Since calling this method could change the defined shape. (by inserting new coordinates or change the position of points) the builder looses its validity. So this method should only be called once on a builder

Specified by:

buildS4J in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

Returns:

new Shape defined by the builder

buildGeometry

public org.opensearch.geometry.Rectangle buildGeometry()

Description copied from class: ShapeBuilder

build lucene geometry.

Specified by:

buildGeometry in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

Returns:

GeoPoint, double[][], Line, Line[], Polygon, Polygon[], Rectangle, Object[]

type

public GeoShapeType type()

Description copied from class: ShapeBuilder

get the shapes type

Specified by:

type in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

Returns:

type of the shape

numDimensions

public int numDimensions()

Description copied from class: ShapeBuilder

tracks number of dimensions for this shape

Specified by:

numDimensions in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ShapeBuilder<org.locationtech.spatial4j.shape.Rectangle,org.opensearch.geometry.Rectangle,EnvelopeBuilder>