com.spatial4j.core.io.jts

Class JtsWktShapeParser

java.lang.Object

com.spatial4j.core.io.WktShapeParser

com.spatial4j.core.io.jts.JtsWktShapeParser

Direct Known Subclasses:

JtsWKTReaderShapeParser

public class JtsWktShapeParser
extends WktShapeParser

Extends WktShapeParser adding support for polygons, using JTS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JtsWktShapeParser.DatelineRule Indicates the algorithm used to process JTS Polygons and JTS LineStrings for detecting dateline crossings.
static class	JtsWktShapeParser.ValidationRule Indicates how JTS geometries (notably polygons but applies to other geometries too) are validated (if at all) and repaired (if at all).

Nested classes/interfaces inherited from class com.spatial4j.core.io.WktShapeParser

WktShapeParser.State

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoIndex
protected JtsSpatialContext	ctx
protected JtsWktShapeParser.DatelineRule	datelineRule
protected JtsWktShapeParser.ValidationRule	validationRule

Constructor Summary

Constructors

Constructor and Description
JtsWktShapeParser(JtsSpatialContext ctx, JtsSpatialContextFactory factory)

Method Summary

Modifier and Type	Method and Description
protected com.vividsolutions.jts.geom.Coordinate	coordinate(WktShapeParser.State state) Reads a Coordinate from the current position.
protected com.vividsolutions.jts.geom.Coordinate[]	coordinateSequence(WktShapeParser.State state) Reads a JTS Coordinate sequence from the current position.
protected List<com.vividsolutions.jts.geom.Coordinate[]>	coordinateSequenceList(WktShapeParser.State state) Reads a list of JTS Coordinate sequences from the current position.
JtsWktShapeParser.DatelineRule	getDatelineRule()
JtsWktShapeParser.ValidationRule	getValidationRule()
boolean	isAutoIndex() If JtsGeometry shapes should be automatically prepared (i.e.
boolean	isAutoValidate() JtsGeometry shapes are automatically validated when getValidationRule() isn't none.
protected Rectangle	makeRectFromPoly(com.vividsolutions.jts.geom.Geometry geometry)
protected JtsGeometry	makeShapeFromGeometry(com.vividsolutions.jts.geom.Geometry geometry) Creates the JtsGeometry, potentially validating, repairing, and preparing.
protected double	normDist(double v) Called to normalize a value that isn't X or Y.
protected Shape	parseLineStringShape(WktShapeParser.State state) Bypasses JtsSpatialContext.makeLineString(java.util.List) so that we can more efficiently get the LineString without creating a List<Point>.
protected Shape	parseMulitPolygonShape(WktShapeParser.State state) Parses a MULTIPOLYGON shape from the raw string.
protected Shape	parsePolygonShape(WktShapeParser.State state) Parses a POLYGON shape from the raw string.
protected Shape	parseShapeByType(WktShapeParser.State state, String shapeType) (internal) Parses the remainder of a shape definition following the shape's name given as shapeType already consumed via WktShapeParser.State.nextWord().
protected com.vividsolutions.jts.geom.Polygon	polygon(WktShapeParser.State state) Reads a polygon, returning a JTS polygon.

Methods inherited from class com.spatial4j.core.io.WktShapeParser

getCtx, newState, parse, parseBufferShape, parseEnvelopeShape, parseGeometryCollectionShape, parseIfSupported, parseMultiLineStringShape, parseMultiPointShape, parsePointShape, point, pointList, shape

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected final JtsSpatialContext ctx

datelineRule

protected final JtsWktShapeParser.DatelineRule datelineRule

validationRule

protected final JtsWktShapeParser.ValidationRule validationRule

autoIndex

protected final boolean autoIndex

Constructor Detail

JtsWktShapeParser

public JtsWktShapeParser(JtsSpatialContext ctx,
                         JtsSpatialContextFactory factory)

Method Detail

getValidationRule

public JtsWktShapeParser.ValidationRule getValidationRule()

See Also:

JtsWktShapeParser.ValidationRule

isAutoValidate

public boolean isAutoValidate()

JtsGeometry shapes are automatically validated when getValidationRule() isn't none.

isAutoIndex

public boolean isAutoIndex()

If JtsGeometry shapes should be automatically prepared (i.e. optimized) when read via WKT.

See Also:

JtsGeometry.index()

getDatelineRule

public JtsWktShapeParser.DatelineRule getDatelineRule()

See Also:

JtsWktShapeParser.DatelineRule

parseShapeByType

protected Shape parseShapeByType(WktShapeParser.State state,
                                 String shapeType)
                          throws ParseException

Description copied from class: WktShapeParser

(internal) Parses the remainder of a shape definition following the shape's name given as shapeType already consumed via WktShapeParser.State.nextWord(). If it's able to parse the shape, WktShapeParser.State.offset should be advanced beyond it (e.g. to the ',' or ')' or EOF in general). The default implementation checks the name against some predefined names and calls corresponding parse methods to handle the rest. Overriding this method is an excellent extension point for additional shape types. Or, use this class by delegation to this method.

When writing a parse method that reacts to a specific shape type, remember to handle the dimension and EMPTY token via WktShapeParser.State.nextIfEmptyAndSkipZM().

Overrides:

parseShapeByType in class WktShapeParser

shapeType - Non-Null string; could have mixed case. The first character is a letter.

Returns:

The shape or null if not supported / unknown.

Throws:

ParseException

parseLineStringShape

protected Shape parseLineStringShape(WktShapeParser.State state)
                              throws ParseException

Bypasses JtsSpatialContext.makeLineString(java.util.List) so that we can more efficiently get the LineString without creating a List<Point>.

Overrides:

parseLineStringShape in class WktShapeParser

Throws:

ParseException

See Also:

WktShapeParser.pointList(WktShapeParser.State)

parsePolygonShape

protected Shape parsePolygonShape(WktShapeParser.State state)
                           throws ParseException

Parses a POLYGON shape from the raw string. It might return a Rectangle if the polygon is one.

   coordinateSequenceList
 

Throws:

ParseException

makeRectFromPoly

protected Rectangle makeRectFromPoly(com.vividsolutions.jts.geom.Geometry geometry)

polygon

protected com.vividsolutions.jts.geom.Polygon polygon(WktShapeParser.State state)
                                               throws ParseException

Reads a polygon, returning a JTS polygon.

Throws:

ParseException

parseMulitPolygonShape

protected Shape parseMulitPolygonShape(WktShapeParser.State state)
                                throws ParseException

Parses a MULTIPOLYGON shape from the raw string.

   '(' polygon (',' polygon )* ')'
 

Throws:

ParseException

coordinateSequenceList

protected List<com.vividsolutions.jts.geom.Coordinate[]> coordinateSequenceList(WktShapeParser.State state)
                                                                         throws ParseException

Reads a list of JTS Coordinate sequences from the current position.

   '(' coordinateSequence (',' coordinateSequence )* ')'
 

Throws:

ParseException

coordinateSequence

protected com.vividsolutions.jts.geom.Coordinate[] coordinateSequence(WktShapeParser.State state)
                                                               throws ParseException

Reads a JTS Coordinate sequence from the current position.

   '(' coordinate (',' coordinate )* ')'
 

Throws:

ParseException

coordinate

protected com.vividsolutions.jts.geom.Coordinate coordinate(WktShapeParser.State state)
                                                     throws ParseException

Reads a Coordinate from the current position. It's akin to WktShapeParser.point(com.spatial4j.core.io.WktShapeParser.State) but for a JTS Coordinate. Only the first 2 numbers are parsed; any remaining are ignored.

Throws:

ParseException

normDist

protected double normDist(double v)

Description copied from class: WktShapeParser

Called to normalize a value that isn't X or Y. X & Y or normalized via SpatialContext.normX(double) & normY.

Overrides:

normDist in class WktShapeParser

makeShapeFromGeometry

protected JtsGeometry makeShapeFromGeometry(com.vividsolutions.jts.geom.Geometry geometry)

Creates the JtsGeometry, potentially validating, repairing, and preparing.