com.spatial4j.core.io

Class GeoJSONReader

java.lang.Object

com.spatial4j.core.io.GeoJSONReader

All Implemented Interfaces:

ShapeIO, ShapeReader

Direct Known Subclasses:

JtsGeoJSONReader

public class GeoJSONReader
extends Object
implements ShapeReader

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BUFFER
protected static String	BUFFER_UNITS

Fields inherited from interface com.spatial4j.core.io.ShapeIO

GeoJSON, LEGACY, POLY, WKT

Constructor Summary

Constructors

Constructor and Description
GeoJSONReader(SpatialContext ctx, SpatialContextFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormatName()
protected Shape	makeShapeFromCoords(String type, List coords)
Shape	read(Object value)
Shape	read(Reader reader) Read a Shape from the reader.
protected Circle	readCircle(org.noggit.JSONParser parser)
List<?>	readCoordinates(org.noggit.JSONParser parser)
List<double[]>	readCoordListXY(org.noggit.JSONParser parser)
double[]	readCoordXY(org.noggit.JSONParser parser)
protected double	readDistance(String distProperty, String distUnitsProperty, org.noggit.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(org.noggit.JSONParser parser)
protected Shape	readPoint(org.noggit.JSONParser parser)
protected Shape	readPolygon(org.noggit.JSONParser parser) This method takes a polygon and makes a bbox from it NOTE: not currently used! polygon is currently implemented in: makeShapeFromCoords(String, List) We could add a 'strict' or 'leinent' mode that would try the best it can
Shape	readShape(org.noggit.JSONParser parser)
protected void	readUntilEvent(org.noggit.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

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

readCoordinates

public List<?> readCoordinates(org.noggit.JSONParser parser)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

readCoordXY

public double[] readCoordXY(org.noggit.JSONParser parser)
                     throws IOException,
                            ParseException

Throws:

IOException

ParseException

readCoordListXY

public List<double[]> readCoordListXY(org.noggit.JSONParser parser)
                               throws IOException,
                                      ParseException

Throws:

IOException

ParseException

readUntilEvent

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

Throws:

IOException

readPoint

protected Shape readPoint(org.noggit.JSONParser parser)
                   throws IOException,
                          ParseException

Throws:

IOException

ParseException

readLineString

protected Shape readLineString(org.noggit.JSONParser parser)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

readCircle

protected Circle readCircle(org.noggit.JSONParser parser)
                     throws IOException,
                            ParseException

Throws:

IOException

ParseException

readDistance

protected double readDistance(String distProperty,
                  String distUnitsProperty,
                  org.noggit.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

readPolygon

protected Shape readPolygon(org.noggit.JSONParser parser)
                     throws IOException,
                            ParseException

This method takes a polygon and makes a bbox from it NOTE: not currently used! polygon is currently implemented in: makeShapeFromCoords(String, List) We could add a 'strict' or 'leinent' mode that would try the best it can

Throws:

ParseException

IOException

readShape

public Shape readShape(org.noggit.JSONParser parser)
                throws IOException,
                       ParseException

Throws:

IOException

ParseException

makeShapeFromCoords

protected Shape makeShapeFromCoords(String type,
                        List coords)