org.elasticsearch.common.geo.builders

Class ShapeBuilder

java.lang.Object

org.elasticsearch.common.geo.builders.ShapeBuilder

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

BasePolygonBuilder, CircleBuilder, EnvelopeBuilder, GeometryCollectionBuilder, MultiLineStringBuilder, MultiPolygonBuilder, PointBuilder, PointCollection

public abstract class ShapeBuilder
extends Object
implements ToXContent

Basic class for building GeoJSON shapes like Polygons, Linestrings, etc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ShapeBuilder.CoordinateNode Node used to represent a tree of coordinates.
protected static class	ShapeBuilder.Edge This helper class implements a linked list for Coordinate.
static class	ShapeBuilder.GeoShapeType Enumeration that lists all ShapeBuilder.GeoShapeTypes that can be handled
static class	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 boolean	autoIndexJtsGeometry
protected boolean	autoValidateJtsGeometry
static double	DATELINE
static com.vividsolutions.jts.geom.GeometryFactory	FACTORY
static String	FIELD_COORDINATES
static String	FIELD_GEOMETRIES
static String	FIELD_ORIENTATION
static String	FIELD_TYPE
protected static org.elasticsearch.common.geo.builders.ShapeBuilder.IntersectionOrder	INTERSECTION_ORDER
protected static ESLogger	LOGGER
protected boolean	multiPolygonMayOverlap It's possible that some geometries in a MULTI* shape might overlap.
protected ShapeBuilder.Orientation	orientation
static com.spatial4j.core.context.jts.JtsSpatialContext	SPATIAL_CONTEXT
protected boolean	wrapdateline We're expecting some geometries might cross the dateline.

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShapeBuilder()
protected	ShapeBuilder(ShapeBuilder.Orientation orientation)

Method Summary

Methods

Modifier and Type	Method and Description
abstract com.spatial4j.core.shape.Shape	build() Create a new Shape from this builder.
protected static com.vividsolutions.jts.geom.Coordinate	coordinate(double longitude, double latitude)
protected static boolean	debugEnabled()
protected static double	intersection(com.vividsolutions.jts.geom.Coordinate p1, com.vividsolutions.jts.geom.Coordinate p2, double dateline) Calculate the intersection of a line segment and a vertical dateline.
protected static int	intersections(double dateline, ShapeBuilder.Edge[] edges) Calculate all intersections of line segments and a vertical line.
protected com.spatial4j.core.shape.jts.JtsGeometry	jtsGeometry(com.vividsolutions.jts.geom.Geometry geom)
static CircleBuilder	newCircleBuilder() create a new Circle
static EnvelopeBuilder	newEnvelope() create a new rectangle
static EnvelopeBuilder	newEnvelope(ShapeBuilder.Orientation orientation) create a new rectangle
static GeometryCollectionBuilder	newGeometryCollection() Create a new GeometryCollection
static GeometryCollectionBuilder	newGeometryCollection(ShapeBuilder.Orientation orientation) Create a new GeometryCollection
static LineStringBuilder	newLineString() Create a new lineString
static MultiLineStringBuilder	newMultiLinestring() Create a new Collection of lineStrings
static MultiPointBuilder	newMultiPoint() Create a new set of points
static MultiPolygonBuilder	newMultiPolygon() Create a new Collection of polygons
static MultiPolygonBuilder	newMultiPolygon(ShapeBuilder.Orientation orientation) Create a new Collection of polygons
static PointBuilder	newPoint(com.vividsolutions.jts.geom.Coordinate coordinate) Create a new PointBuilder from a Coordinate
static PointBuilder	newPoint(double longitude, double latitude) Create a new point
static PolygonBuilder	newPolygon() Create a new Polygon
static PolygonBuilder	newPolygon(ShapeBuilder.Orientation orientation) Create a new Polygon
static ShapeBuilder.Orientation	orientationFromString(String orientation)
static ShapeBuilder	parse(XContentParser parser) Create a new ShapeBuilder from XContent
static ShapeBuilder	parse(XContentParser parser, GeoShapeFieldMapper geoDocMapper) Create a new ShapeBuilder from XContent
protected static com.vividsolutions.jts.geom.Coordinate	shift(com.vividsolutions.jts.geom.Coordinate coordinate, double dateline)
String	toString()
protected static XContentBuilder	toXContent(XContentBuilder builder, com.vividsolutions.jts.geom.Coordinate coordinate)
abstract ShapeBuilder.GeoShapeType	type() get the shapes type

Methods inherited from class java.lang.Object

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

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

toXContent

Field Detail

LOGGER

protected static final ESLogger LOGGER

DATELINE

public static final double DATELINE

See Also:

Constant Field Values

SPATIAL_CONTEXT

public static final com.spatial4j.core.context.jts.JtsSpatialContext SPATIAL_CONTEXT

FACTORY

public static final com.vividsolutions.jts.geom.GeometryFactory FACTORY

wrapdateline

protected final boolean wrapdateline

We're expecting some geometries might cross the dateline.

multiPolygonMayOverlap

protected final boolean multiPolygonMayOverlap

It's possible that some geometries in a MULTI* shape might overlap. With the possible exception of GeometryCollection, this normally isn't allowed.

See Also:

Constant Field Values

autoValidateJtsGeometry

protected final boolean autoValidateJtsGeometry

See Also:

JtsGeometry.validate(), Constant Field Values

autoIndexJtsGeometry

protected final boolean autoIndexJtsGeometry

See Also:

JtsGeometry.index(), Constant Field Values

orientation

protected ShapeBuilder.Orientation orientation

INTERSECTION_ORDER

protected static final org.elasticsearch.common.geo.builders.ShapeBuilder.IntersectionOrder INTERSECTION_ORDER

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

FIELD_COORDINATES

public static final String FIELD_COORDINATES

See Also:

Constant Field Values

FIELD_GEOMETRIES

public static final String FIELD_GEOMETRIES

See Also:

Constant Field Values

FIELD_ORIENTATION

public static final String FIELD_ORIENTATION

See Also:

Constant Field Values

Constructor Detail

ShapeBuilder

protected ShapeBuilder()

ShapeBuilder

protected ShapeBuilder(ShapeBuilder.Orientation orientation)

Method Detail

coordinate

protected static com.vividsolutions.jts.geom.Coordinate coordinate(double longitude,
                                                double latitude)

jtsGeometry

protected com.spatial4j.core.shape.jts.JtsGeometry jtsGeometry(com.vividsolutions.jts.geom.Geometry geom)

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

newPoint

public static PointBuilder newPoint(com.vividsolutions.jts.geom.Coordinate coordinate)

Create a new PointBuilder from a Coordinate

Parameters:

coordinate - coordinate defining the position of the point

Returns:

a new PointBuilder

newMultiPoint

public static MultiPointBuilder newMultiPoint()

Create a new set of points

Returns:

new MultiPointBuilder

newLineString

public static LineStringBuilder newLineString()

Create a new lineString

Returns:

a new LineStringBuilder

newMultiLinestring

public static MultiLineStringBuilder newMultiLinestring()

Create a new Collection of lineStrings

Returns:

a new MultiLineStringBuilder

newPolygon

public static PolygonBuilder newPolygon()

Create a new Polygon

Returns:

a new PointBuilder

newPolygon

public static PolygonBuilder newPolygon(ShapeBuilder.Orientation orientation)

Create a new Polygon

Returns:

a new PointBuilder

newMultiPolygon

public static MultiPolygonBuilder newMultiPolygon()

Create a new Collection of polygons

Returns:

a new MultiPolygonBuilder

newMultiPolygon

public static MultiPolygonBuilder newMultiPolygon(ShapeBuilder.Orientation orientation)

Create a new Collection of polygons

Returns:

a new MultiPolygonBuilder

newGeometryCollection

public static GeometryCollectionBuilder newGeometryCollection()

Create a new GeometryCollection

Returns:

a new GeometryCollectionBuilder

newGeometryCollection

public static GeometryCollectionBuilder newGeometryCollection(ShapeBuilder.Orientation orientation)

Create a new GeometryCollection

Returns:

a new GeometryCollectionBuilder

newCircleBuilder

public static CircleBuilder newCircleBuilder()

create a new Circle

Returns:

a new CircleBuilder

newEnvelope

public static EnvelopeBuilder newEnvelope()

create a new rectangle

Returns:

a new EnvelopeBuilder

newEnvelope

public static EnvelopeBuilder newEnvelope(ShapeBuilder.Orientation orientation)

create a new rectangle

Returns:

a new EnvelopeBuilder

toString

public String toString()

Overrides:

toString in class Object

build

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

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

Returns:

new Shape defined by the builder

parse

public static ShapeBuilder parse(XContentParser parser)
                          throws IOException

Create a new ShapeBuilder from XContent

Parameters:

parser - parser to read the GeoShape from

Returns:

ShapeBuilder read from the parser or null if the parsers current token has been null

Throws:

IOException - if the input could not be read

parse

public static ShapeBuilder parse(XContentParser parser,
                 GeoShapeFieldMapper geoDocMapper)
                          throws IOException

Create a new ShapeBuilder from XContent

Parameters:

parser - parser to read the GeoShape from

geoDocMapper - document field mapper reference required for spatial parameters relevant to the shape construction process (e.g., orientation) todo: refactor to place build specific parameters in the SpatialContext

Returns:

ShapeBuilder read from the parser or null if the parsers current token has been null

Throws:

IOException - if the input could not be read

toXContent

protected static XContentBuilder toXContent(XContentBuilder builder,
                         com.vividsolutions.jts.geom.Coordinate coordinate)
                                     throws IOException

Throws:

IOException

orientationFromString

public static ShapeBuilder.Orientation orientationFromString(String orientation)

shift

protected static com.vividsolutions.jts.geom.Coordinate shift(com.vividsolutions.jts.geom.Coordinate coordinate,
                                           double dateline)

type

public abstract ShapeBuilder.GeoShapeType type()

get the shapes type

Returns:

type of the shape

intersection

protected static final double intersection(com.vividsolutions.jts.geom.Coordinate p1,
                  com.vividsolutions.jts.geom.Coordinate p2,
                  double dateline)

Calculate the intersection of a line segment and a vertical dateline.

Parameters:

p1 - start-point of the line segment

p2 - end-point of the line segment

dateline - x-coordinate of the vertical dateline

Returns:

position of the intersection in the open range (0..1] if the line segment intersects with the line segment. Otherwise this method returns Double.NaN

intersections

protected static int intersections(double dateline,
                ShapeBuilder.Edge[] edges)

Calculate all intersections of line segments and a vertical line. The Array of edges will be ordered asc by the y-coordinate of the intersections of edges.

Parameters:

dateline - x-coordinate of the dateline

edges - set of edges that may intersect with the dateline

Returns:

number of intersecting edges

debugEnabled

protected static final boolean debugEnabled()