Package org.opensearch.common.geo.builders

Class PointBuilder

java.lang.Object

org.opensearch.common.geo.builders.ShapeBuilder<org.locationtech.spatial4j.shape.Point,org.opensearch.geometry.Point,PointBuilder>

org.opensearch.common.geo.builders.PointBuilder

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 PointBuilder
extends ShapeBuilder<org.locationtech.spatial4j.shape.Point,org.opensearch.geometry.Point,PointBuilder>

Builds a point 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
PointBuilder()	Create a point at [0.0,0.0]
PointBuilder(double lon, double lat)
PointBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
org.opensearch.geometry.Point	buildGeometry()	build lucene geometry.
org.locationtech.spatial4j.shape.Point	buildS4J()	Create a new Shape from this builder.
PointBuilder	coordinate(org.locationtech.jts.geom.Coordinate coordinate)	Add a new coordinate to the collection
double	latitude()
double	longitude()
static PointBuilder	newPoint(double longitude, double latitude)	Create a new point
int	numDimensions()	tracks number of dimensions for this 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

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

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

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

PointBuilder

public PointBuilder()

Create a point at [0.0,0.0]

PointBuilder

public PointBuilder(double lon,
 double lat)

PointBuilder

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

Throws:

IOException

Method Details

coordinate

public PointBuilder coordinate(org.locationtech.jts.geom.Coordinate coordinate)

Description copied from class: ShapeBuilder

Add a new coordinate to the collection

Overrides:

coordinate in class ShapeBuilder<org.locationtech.spatial4j.shape.Point,org.opensearch.geometry.Point,PointBuilder>

Parameters:

coordinate - coordinate of the point

Returns:

this

longitude

public double longitude()

latitude

public double latitude()

newPoint

public static PointBuilder newPoint(double longitude,
 double latitude)

Create a new point

Parameters:

longitude - longitude of the point

latitude - latitude of the point

Returns:

a new PointBuilder

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.Point 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.Point,org.opensearch.geometry.Point,PointBuilder>

Returns:

new Shape defined by the builder

buildGeometry

public org.opensearch.geometry.Point buildGeometry()

Description copied from class: ShapeBuilder

build lucene geometry.

Specified by:

buildGeometry in class ShapeBuilder<org.locationtech.spatial4j.shape.Point,org.opensearch.geometry.Point,PointBuilder>

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.Point,org.opensearch.geometry.Point,PointBuilder>

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.Point,org.opensearch.geometry.Point,PointBuilder>