org.elasticsearch.common.geo.builders

Class BasePolygonBuilder<E extends BasePolygonBuilder<E>>

java.lang.Object

org.elasticsearch.common.geo.builders.ShapeBuilder

org.elasticsearch.common.geo.builders.BasePolygonBuilder<E>

Type Parameters:

E - type of the embedding class

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

MultiPolygonBuilder.InternalPolygonBuilder, PolygonBuilder

public abstract class BasePolygonBuilder<E extends BasePolygonBuilder<E>>
extends ShapeBuilder

The BasePolygonBuilder implements the groundwork to create polygons. This contains Methods to wrap polygons at the dateline and building shapes from the data held by the builder. Since this Builder can be embedded to other builders (i.e. MultiPolygonBuilder) the class of the embedding builder is given by the generic argument E

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePolygonBuilder.Ring<P extends ShapeBuilder>

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

ShapeBuilder.CoordinateNode, ShapeBuilder.Edge, ShapeBuilder.GeoShapeType, ShapeBuilder.Orientation

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<BaseLineStringBuilder<?>>	holes
protected BasePolygonBuilder.Ring<E>	shell
static ShapeBuilder.GeoShapeType	TYPE

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

autoIndexJtsGeometry, autoValidateJtsGeometry, DATELINE, FACTORY, FIELD_COORDINATES, FIELD_GEOMETRIES, FIELD_ORIENTATION, FIELD_TYPE, INTERSECTION_ORDER, LOGGER, multiPolygonMayOverlap, orientation, SPATIAL_CONTEXT, wrapdateline

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BasePolygonBuilder(ShapeBuilder.Orientation orientation)

Method Summary

Modifier and Type	Method and Description
com.spatial4j.core.shape.Shape	build() Create a new Shape from this builder.
com.vividsolutions.jts.geom.Geometry	buildGeometry(com.vividsolutions.jts.geom.GeometryFactory factory, boolean fixDateline)
ShapeBuilder	close() Close the shell of the polygon
com.vividsolutions.jts.geom.Coordinate[][][]	coordinates() The coordinates setup by the builder will be assembled to a polygon.
protected XContentBuilder	coordinatesArray(XContentBuilder builder, ToXContent.Params params)
BasePolygonBuilder.Ring<E>	hole() build new hole to the polygon
E	hole(BaseLineStringBuilder<?> hole) Add a new hole to the polygon
protected static com.vividsolutions.jts.geom.LinearRing	linearRing(com.vividsolutions.jts.geom.GeometryFactory factory, ArrayList<com.vividsolutions.jts.geom.Coordinate> coordinates)
protected static com.vividsolutions.jts.geom.MultiPolygon	multipolygon(com.vividsolutions.jts.geom.GeometryFactory factory, com.vividsolutions.jts.geom.Coordinate[][][] polygons) Create a Multipolygon from a set of coordinates.
E	point(com.vividsolutions.jts.geom.Coordinate coordinate) Add a point to the shell of the polygon
E	point(double longitude, double latitude)
E	points(com.vividsolutions.jts.geom.Coordinate... coordinates) Add a array of points to the shell of the polygon
protected static com.vividsolutions.jts.geom.Polygon	polygon(com.vividsolutions.jts.geom.GeometryFactory factory, com.vividsolutions.jts.geom.Coordinate[][] polygon)
com.vividsolutions.jts.geom.Polygon	toPolygon()
protected com.vividsolutions.jts.geom.Polygon	toPolygon(com.vividsolutions.jts.geom.GeometryFactory factory)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ShapeBuilder.GeoShapeType	type() get the shapes type
protected void	validateHole(BaseLineStringBuilder shell, BaseLineStringBuilder hole) Validates only 1 vertex is tangential (shared) between the interior and exterior of a polygon

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

coordinate, debugEnabled, intersection, intersections, jtsGeometry, newCircleBuilder, newEnvelope, newEnvelope, newGeometryCollection, newGeometryCollection, newLineString, newMultiLinestring, newMultiPoint, newMultiPolygon, newMultiPolygon, newPoint, newPoint, newPolygon, newPolygon, orientationFromString, parse, parse, shift, toString, toXContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final ShapeBuilder.GeoShapeType TYPE

shell

protected BasePolygonBuilder.Ring<E extends BasePolygonBuilder<E>> shell

holes

protected final ArrayList<BaseLineStringBuilder<?>> holes

Constructor Detail

BasePolygonBuilder

public BasePolygonBuilder(ShapeBuilder.Orientation orientation)

Method Detail

point

public E point(double longitude,
               double latitude)

point

public E point(com.vividsolutions.jts.geom.Coordinate coordinate)

Add a point to the shell of the polygon

Parameters:

coordinate - coordinate of the new point

Returns:

this

points

public E points(com.vividsolutions.jts.geom.Coordinate... coordinates)

Add a array of points to the shell of the polygon

Parameters:

coordinates - coordinates of the new points to add

Returns:

this

hole

public E hole(BaseLineStringBuilder<?> hole)

Add a new hole to the polygon

Parameters:

hole - linear ring defining the hole

Returns:

this

hole

public BasePolygonBuilder.Ring<E> hole()

build new hole to the polygon

Returns:

this

close

public ShapeBuilder close()

Close the shell of the polygon

Returns:

parent

validateHole

protected void validateHole(BaseLineStringBuilder shell,
                            BaseLineStringBuilder hole)

Validates only 1 vertex is tangential (shared) between the interior and exterior of a polygon

coordinates

public com.vividsolutions.jts.geom.Coordinate[][][] coordinates()

The coordinates setup by the builder will be assembled to a polygon. The result will consist of a set of polygons. Each of these components holds a list of linestrings defining the polygon: the first set of coordinates will be used as the shell of the polygon. The others are defined to holes within the polygon. This Method also wraps the polygons at the dateline. In order to this fact the result may contains more polygons and less holes than defined in the builder it self.

Returns:

coordinates of the polygon

build

public com.spatial4j.core.shape.Shape build()

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:

build in class ShapeBuilder

Returns:

new Shape defined by the builder

coordinatesArray

protected XContentBuilder coordinatesArray(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Throws:

IOException

buildGeometry

public com.vividsolutions.jts.geom.Geometry buildGeometry(com.vividsolutions.jts.geom.GeometryFactory factory,
                                                          boolean fixDateline)

toPolygon

public com.vividsolutions.jts.geom.Polygon toPolygon()

toPolygon

protected com.vividsolutions.jts.geom.Polygon toPolygon(com.vividsolutions.jts.geom.GeometryFactory factory)

linearRing

protected static com.vividsolutions.jts.geom.LinearRing linearRing(com.vividsolutions.jts.geom.GeometryFactory factory,
                                                                   ArrayList<com.vividsolutions.jts.geom.Coordinate> coordinates)

type

public ShapeBuilder.GeoShapeType type()

Description copied from class: ShapeBuilder

get the shapes type

Specified by:

type in class ShapeBuilder

Returns:

type of the shape

polygon

protected static com.vividsolutions.jts.geom.Polygon polygon(com.vividsolutions.jts.geom.GeometryFactory factory,
                                                             com.vividsolutions.jts.geom.Coordinate[][] polygon)

multipolygon

protected static com.vividsolutions.jts.geom.MultiPolygon multipolygon(com.vividsolutions.jts.geom.GeometryFactory factory,
                                                                       com.vividsolutions.jts.geom.Coordinate[][][] polygons)

Create a Multipolygon from a set of coordinates. Each primary array contains a polygon which in turn contains an array of linestrings. These line Strings are represented as an array of coordinates. The first linestring will be the shell of the polygon the others define holes within the polygon.

Parameters:

factory - GeometryFactory to use

polygons - definition of polygons

Returns:

a new Multipolygon