Package org.opensearch.common.geo.builders

Class MultiPolygonBuilder

java.lang.Object

org.opensearch.common.geo.builders.ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

org.opensearch.common.geo.builders.MultiPolygonBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class MultiPolygonBuilder
extends ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

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.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
static 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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MultiPolygonBuilder()	Build a MultiPolygonBuilder with RIGHT orientation.
MultiPolygonBuilder(ShapeBuilder.Orientation orientation)	Build a MultiPolygonBuilder with an arbitrary orientation.
MultiPolygonBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
org.opensearch.geometry.MultiPolygon	buildGeometry()	build lucene geometry.
org.locationtech.spatial4j.shape.Shape	buildS4J()	Create a new Shape from this builder.
protected java.lang.StringBuilder	contentToWKT()
boolean	equals(java.lang.Object obj)
int	hashCode()
int	numDimensions()	tracks number of dimensions for this shape
ShapeBuilder.Orientation	orientation()
MultiPolygonBuilder	polygon(PolygonBuilder polygon)	Add a shallow copy of the polygon to the multipolygon.
java.util.List<PolygonBuilder>	polygons()	get the list of polygons
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
GeoShapeType	type()	get the shapes type
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

isFragment

Field Details

TYPE

public static final GeoShapeType TYPE

Constructor Details

MultiPolygonBuilder

public MultiPolygonBuilder()

Build a MultiPolygonBuilder with RIGHT orientation.

MultiPolygonBuilder

public MultiPolygonBuilder(ShapeBuilder.Orientation orientation)

Build a MultiPolygonBuilder with an arbitrary orientation.

MultiPolygonBuilder

public MultiPolygonBuilder(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

Throws:

java.io.IOException

orientation

public ShapeBuilder.Orientation orientation()

polygon

public MultiPolygonBuilder polygon(PolygonBuilder polygon)

Add a shallow copy of the polygon to the multipolygon. This will apply the orientation of the MultiPolygonBuilder to the polygon if polygon has different orientation.

polygons

public java.util.List<PolygonBuilder> polygons()

get the list of polygons

contentToWKT

protected java.lang.StringBuilder contentToWKT()

Overrides:

contentToWKT in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

toXContent

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

Throws:

java.io.IOException

type

public GeoShapeType type()

Description copied from class: ShapeBuilder

get the shapes type

Specified by:

type in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

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.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

buildS4J

public org.locationtech.spatial4j.shape.Shape 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.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

Returns:

new Shape defined by the builder

buildGeometry

public org.opensearch.geometry.MultiPolygon buildGeometry()

Description copied from class: ShapeBuilder

build lucene geometry.

Specified by:

buildGeometry in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.MultiPolygon,MultiPolygonBuilder>