org.elasticsearch.common.geo.builders

Class ShapeBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.common.geo.builders.ShapeBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

Direct Known Subclasses:

CircleBuilder, CoordinateCollection, EnvelopeBuilder, GeometryCollectionBuilder, MultiLineStringBuilder, MultiPolygonBuilder, PointBuilder, PolygonBuilder

public abstract class ShapeBuilder
extends ToXContentToBytes
implements NamedWriteable

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.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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 static boolean	AUTO_INDEX_JTS_GEOMETRY
protected static boolean	AUTO_VALIDATE_JTS_GEOMETRY
static double	DATELINE
static com.vividsolutions.jts.geom.GeometryFactory	FACTORY
static java.lang.String	FIELD_COORDINATES
static java.lang.String	FIELD_GEOMETRIES
static java.lang.String	FIELD_ORIENTATION
static java.lang.String	FIELD_TYPE
protected static org.elasticsearch.common.geo.builders.ShapeBuilder.IntersectionOrder	INTERSECTION_ORDER
protected static org.apache.logging.log4j.Logger	LOGGER
protected static boolean	MULTI_POLYGON_MAY_OVERLAP It's possible that some geometries in a MULTI* shape might overlap.
static org.locationtech.spatial4j.context.jts.JtsSpatialContext	SPATIAL_CONTEXT
protected boolean	wrapdateline We're expecting some geometries might cross the dateline.
static com.vividsolutions.jts.geom.Coordinate	ZERO_ZERO coordinate at [0.0, 0.0]

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShapeBuilder()

Method Summary

Modifier and Type	Method and Description
abstract org.locationtech.spatial4j.shape.Shape	build() Create a new Shape from this builder.
protected static boolean	debugEnabled()
java.lang.String	getWriteableName() Returns the name of the writeable object
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 org.locationtech.spatial4j.shape.jts.JtsGeometry	jtsGeometry(com.vividsolutions.jts.geom.Geometry geom)
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	readFromStream(StreamInput in)
protected static com.vividsolutions.jts.geom.Coordinate	shift(com.vividsolutions.jts.geom.Coordinate coordinate, double dateline)
protected static XContentBuilder	toXContent(XContentBuilder builder, com.vividsolutions.jts.geom.Coordinate coordinate)
abstract ShapeBuilder.GeoShapeType	type() get the shapes type
protected static void	writeCoordinateTo(com.vividsolutions.jts.geom.Coordinate coordinate, StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

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

isFragment, toXContent

Field Detail

LOGGER

protected static final org.apache.logging.log4j.Logger LOGGER

DATELINE

public static final double DATELINE

See Also:

Constant Field Values

ZERO_ZERO

public static final com.vividsolutions.jts.geom.Coordinate ZERO_ZERO

coordinate at [0.0, 0.0]

SPATIAL_CONTEXT

public static final org.locationtech.spatial4j.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.

MULTI_POLYGON_MAY_OVERLAP

protected static final boolean MULTI_POLYGON_MAY_OVERLAP

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

AUTO_VALIDATE_JTS_GEOMETRY

protected static final boolean AUTO_VALIDATE_JTS_GEOMETRY

See Also:

JtsGeometry.validate(), Constant Field Values

AUTO_INDEX_JTS_GEOMETRY

protected static final boolean AUTO_INDEX_JTS_GEOMETRY

See Also:

JtsGeometry.index(), Constant Field Values

INTERSECTION_ORDER

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

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_COORDINATES

public static final java.lang.String FIELD_COORDINATES

See Also:

Constant Field Values

FIELD_GEOMETRIES

public static final java.lang.String FIELD_GEOMETRIES

See Also:

Constant Field Values

FIELD_ORIENTATION

public static final java.lang.String FIELD_ORIENTATION

See Also:

Constant Field Values

Constructor Detail

ShapeBuilder

protected ShapeBuilder()

Method Detail

jtsGeometry

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

build

public abstract org.locationtech.spatial4j.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 java.io.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:

java.io.IOException - if the input could not be read

parse

public static ShapeBuilder parse(XContentParser parser,
                                 GeoShapeFieldMapper geoDocMapper)
                          throws java.io.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:

java.io.IOException - if the input could not be read

toXContent

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

Throws:

java.io.IOException

writeCoordinateTo

protected static void writeCoordinateTo(com.vividsolutions.jts.geom.Coordinate coordinate,
                                        StreamOutput out)
                                 throws java.io.IOException

Throws:

java.io.IOException

readFromStream

protected static com.vividsolutions.jts.geom.Coordinate readFromStream(StreamInput in)
                                                                throws java.io.IOException

Throws:

java.io.IOException

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()

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable