Package org.opensearch.common.geo.builders

Class GeometryCollectionBuilder

java.lang.Object

org.opensearch.common.geo.builders.ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

org.opensearch.common.geo.builders.GeometryCollectionBuilder

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 GeometryCollectionBuilder
extends ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

Builds a geometry collection

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
GeometryCollectionBuilder()	Build and empty GeometryCollectionBuilder.
GeometryCollectionBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>	buildGeometry()	build lucene geometry.
org.locationtech.spatial4j.shape.Shape	buildS4J()	Create a new Shape from this builder.
GeometryCollectionBuilder	circle(CircleBuilder circle)
protected StringBuilder	contentToWKT()
GeometryCollectionBuilder	envelope(EnvelopeBuilder envelope)
boolean	equals(Object obj)
ShapeBuilder	getShapeAt(int i)
int	hashCode()
GeometryCollectionBuilder	line(LineStringBuilder line)
GeometryCollectionBuilder	multiLine(MultiLineStringBuilder multiLine)
GeometryCollectionBuilder	multiPoint(MultiPointBuilder multiPoint)
GeometryCollectionBuilder	multiPolygon(MultiPolygonBuilder multiPolygon)
int	numDimensions()	tracks number of dimensions for this shape
int	numShapes()
GeometryCollectionBuilder	point(PointBuilder point)
GeometryCollectionBuilder	polygon(PolygonBuilder polygon)
GeometryCollectionBuilder	shape(ShapeBuilder shape)
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

GeometryCollectionBuilder

public GeometryCollectionBuilder()

Build and empty GeometryCollectionBuilder.

GeometryCollectionBuilder

public GeometryCollectionBuilder(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.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

Throws:

IOException

shape

public GeometryCollectionBuilder shape(ShapeBuilder shape)

point

public GeometryCollectionBuilder point(PointBuilder point)

multiPoint

public GeometryCollectionBuilder multiPoint(MultiPointBuilder multiPoint)

line

public GeometryCollectionBuilder line(LineStringBuilder line)

multiLine

public GeometryCollectionBuilder multiLine(MultiLineStringBuilder multiLine)

polygon

public GeometryCollectionBuilder polygon(PolygonBuilder polygon)

multiPolygon

public GeometryCollectionBuilder multiPolygon(MultiPolygonBuilder multiPolygon)

envelope

public GeometryCollectionBuilder envelope(EnvelopeBuilder envelope)

circle

public GeometryCollectionBuilder circle(CircleBuilder circle)

getShapeAt

public ShapeBuilder getShapeAt(int i)

numShapes

public int numShapes()

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

contentToWKT

protected StringBuilder contentToWKT()

Overrides:

contentToWKT in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

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.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

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.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

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.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

Returns:

new Shape defined by the builder

buildGeometry

public org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry> buildGeometry()

Description copied from class: ShapeBuilder

build lucene geometry.

Specified by:

buildGeometry in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

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.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ShapeBuilder<org.locationtech.spatial4j.shape.Shape,org.opensearch.geometry.GeometryCollection<org.opensearch.geometry.Geometry>,GeometryCollectionBuilder>