Package org.locationtech.spatial4j.io

Class GeoJSONReader

java.lang.Object

org.locationtech.spatial4j.io.GeoJSONReader

All Implemented Interfaces:

ShapeIO, ShapeReader

public class GeoJSONReader
extends Object
implements ShapeReader

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BUFFER
protected static String	BUFFER_UNITS
protected SpatialContext	ctx
protected ShapeFactory	shapeFactory

Fields inherited from interface org.locationtech.spatial4j.io.ShapeIO

GeoJSON, LEGACY, POLY, WKT

Constructor Summary

Constructors

Constructor	Description
GeoJSONReader(SpatialContext ctx, SpatialContextFactory factory)

Method Summary

Modifier and Type	Method	Description
String	getFormatName()
Shape	read(Reader reader)	Read a Shape from the reader.
Shape	read(Object value)
protected Circle	readCircle(JSONParser parser)
protected void	readCoordListXYZ(JSONParser parser, ShapeFactory.PointsBuilder pointsBuilder)
protected void	readCoordXYZ(JSONParser parser, ShapeFactory.PointsBuilder pointsBuilder)
protected double	readDistance(String distProperty, String distUnitsProperty, JSONParser parser)	Helper method to read a up until a distance value (radius, buffer) and it's corresponding unit are found.
Shape	readIfSupported(Object value)
protected Shape	readLineString(JSONParser parser)
protected Shape	readMultiLineString(JSONParser parser)
protected Shape	readMultiPoint(JSONParser parser)
protected Shape	readMultiPolygon(JSONParser parser)
protected Shape	readPoint(JSONParser parser)
protected ShapeFactory.PolygonBuilder	readPolygon(JSONParser parser, ShapeFactory.PolygonBuilder polygonBuilder)
protected Shape	readShape(JSONParser parser)
protected Shape	readShapeFromCoordinates(String type, JSONParser parser)
protected void	readUntilEvent(JSONParser parser, int event)

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER

protected static final String BUFFER

See Also:

Constant Field Values

BUFFER_UNITS

protected static final String BUFFER_UNITS

See Also:

Constant Field Values

ctx

protected final SpatialContext ctx

shapeFactory

protected final ShapeFactory shapeFactory

Constructor Detail

GeoJSONReader

public GeoJSONReader(SpatialContext ctx,
                     SpatialContextFactory factory)

Method Detail

getFormatName

public String getFormatName()

Specified by:

getFormatName in interface ShapeIO

Returns:

the format name

read

public final Shape read(Reader reader)
                 throws IOException,
                        ParseException

Description copied from interface: ShapeReader

Read a Shape from the reader.

Specified by:

read in interface ShapeReader

Parameters:

reader - -- the input. Note, it will not be closed by this function

Returns:

a valid Shape (never null)

Throws:

IOException

ParseException

read

public Shape read(Object value)
           throws IOException,
                  ParseException,
                  InvalidShapeException

Specified by:

read in interface ShapeReader

Parameters:

value - -- the input value, could be a String or other object

Returns:

a shape valid shape (not null)

Throws:

IOException

ParseException

InvalidShapeException

readIfSupported

public Shape readIfSupported(Object value)
                      throws InvalidShapeException

Specified by:

readIfSupported in interface ShapeReader

Parameters:

value - -- the input value, could be a String or other object

Returns:

a shape or null, if the input was un readable. This will throw InvalidShapeException when we could read a shape, but it was invalid

Throws:

InvalidShapeException

readCoordXYZ

protected void readCoordXYZ(JSONParser parser,
                            ShapeFactory.PointsBuilder pointsBuilder)
                     throws IOException,
                            ParseException

Throws:

IOException

ParseException

readCoordListXYZ

protected void readCoordListXYZ(JSONParser parser,
                                ShapeFactory.PointsBuilder pointsBuilder)
                         throws IOException,
                                ParseException

Throws:

IOException

ParseException

readUntilEvent

protected void readUntilEvent(JSONParser parser,
                              int event)
                       throws IOException

Throws:

IOException

readPoint

protected Shape readPoint(JSONParser parser)
                   throws IOException,
                          ParseException

Throws:

IOException

ParseException

readLineString

protected Shape readLineString(JSONParser parser)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

readCircle

protected Circle readCircle(JSONParser parser)
                     throws IOException,
                            ParseException

Throws:

IOException

ParseException

readDistance

protected double readDistance(String distProperty,
                              String distUnitsProperty,
                              JSONParser parser)
                       throws IOException

Helper method to read a up until a distance value (radius, buffer) and it's corresponding unit are found.

This method returns 0 if no distance value is found. This method currently only handles distance units of "km".

Parameters:

distProperty - The name of the property containing the distance value.

distUnitsProperty - The name of the property containing the distance unit.

Throws:

IOException

readShape

protected Shape readShape(JSONParser parser)
                   throws IOException,
                          ParseException

Throws:

IOException

ParseException

readShapeFromCoordinates

protected Shape readShapeFromCoordinates(String type,
                                         JSONParser parser)
                                  throws IOException,
                                         ParseException

Throws:

IOException

ParseException

readPolygon

protected ShapeFactory.PolygonBuilder readPolygon(JSONParser parser,
                                                  ShapeFactory.PolygonBuilder polygonBuilder)
                                           throws IOException,
                                                  ParseException

Throws:

IOException

ParseException

readMultiPoint

protected Shape readMultiPoint(JSONParser parser)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

readMultiLineString

protected Shape readMultiLineString(JSONParser parser)
                             throws IOException,
                                    ParseException

Throws:

IOException

ParseException

readMultiPolygon

protected Shape readMultiPolygon(JSONParser parser)
                          throws IOException,
                                 ParseException

Throws:

IOException

ParseException