com.spatial4j.core.io

Interface ShapeReader

All Superinterfaces:

ShapeIO

All Known Implementing Classes:

GeoJSONReader, JtsGeoJSONReader, JtsPolyshapeReader, JtsWKTReader, JtsWKTReaderShapeParser, LegacyShapeReader, PolyshapeReader, WKTReader, WktShapeParser

public interface ShapeReader
extends ShapeIO

Implementations are expected to be thread safe

Field Summary

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

GeoJSON, LEGACY, POLY, WKT

Method Summary

Modifier and Type	Method and Description
Shape	read(Object value)
Shape	read(Reader reader) Read a Shape from the reader.
Shape	readIfSupported(Object value)

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

getFormatName

Method Detail

read

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

Parameters:

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

Returns:

a shape valid shape (not null)

Throws:

IOException

ParseException

InvalidShapeException

readIfSupported

Shape readIfSupported(Object value)
               throws InvalidShapeException

Parameters:

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

error - -- flag if we should throw an error or not (true will throw an error)

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

read

Shape read(Reader reader)
    throws IOException,
           ParseException,
           InvalidShapeException

Read a Shape from the reader.

Parameters:

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

Returns:

a valid Shape (never null)

Throws:

IOException

ParseException

InvalidShapeException