BasePolygonBuilder

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

All Methods

Static Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`com.spatial4j.core.shape.Shape`	`build()` Create a new Shape from this builder.
`Geometry`	`buildGeometry(GeometryFactory factory, boolean fixDateline)`
`ShapeBuilder`	`close()` Close the shell of the polygon
`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 LinearRing`	`linearRing(GeometryFactory factory, ArrayList<Coordinate> coordinates)`
`protected static MultiPolygon`	`multipolygon(GeometryFactory factory, Coordinate[][][] polygons)` Create a Multipolygon from a set of coordinates.
`E`	`point(Coordinate coordinate)` Add a point to the shell of the polygon
`E`	`point(double longitude, double latitude)`
`E`	`points(Coordinate... coordinates)` Add a array of points to the shell of the polygon
`protected static Polygon`	`polygon(GeometryFactory factory, Coordinate[][] polygon)`
`Polygon`	`toPolygon()`
`protected Polygon`	`toPolygon(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

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(Coordinate coordinate)
```
    Add a point to the shell of the polygon
    
    Parameters:
    
    coordinate - coordinate of the new point
    
    Returns:
    
    this
  - points
```
public E points(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
    
    Parameters:
    
    hole - linear ring defining the hole
    
    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 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
```
    Specified by:
    
    toXContent in interface ToXContent
    
    Overrides:
    
    toXContent in class ShapeBuilder
    
    Throws:
    
    IOException
  - buildGeometry
```
public Geometry buildGeometry(GeometryFactory factory,
                              boolean fixDateline)
```
  - toPolygon
```
public Polygon toPolygon()
```
  - toPolygon
```
protected Polygon toPolygon(GeometryFactory factory)
```
  - linearRing
```
protected static LinearRing linearRing(GeometryFactory factory,
                                       ArrayList<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 Polygon polygon(GeometryFactory factory,
                                 Coordinate[][] polygon)
```
  - multipolygon
```
protected static MultiPolygon multipolygon(GeometryFactory factory,
                                           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

Class BasePolygonBuilder<E extends BasePolygonBuilder<E>>

Nested Class Summary

Nested Classes

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

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

Field Summary

Fields

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

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

Constructor Summary

Constructors

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

TYPE

shell

holes

Constructor Detail

BasePolygonBuilder

Method Detail

point

point

points

hole

hole

close

validateHole

coordinates

build

coordinatesArray

toXContent

buildGeometry

toPolygon

toPolygon

linearRing

type

polygon

multipolygon