com.spatial4j.core.io

Class LegacyShapeReader

java.lang.Object

com.spatial4j.core.io.LegacyShapeReader

All Implemented Interfaces:

ShapeIO, ShapeReader

Deprecated.

@Deprecated
public class LegacyShapeReader
extends Object
implements ShapeReader

Reads a shape from the old format.

• Point: X Y
  1.23 4.56
• Rect: XMin YMin XMax YMax
  1.23 4.56 7.87 4.56
• {CIRCLE} '(' {POINT} {DISTANCE} ')'
  CIRCLE is "CIRCLE" or "Circle" (no other case), and POINT is "X Y" order pair of doubles, or "Y,X" (lat,lon) pair of doubles, and DISTANCE is "d=RADIUS" or "distance=RADIUS" where RADIUS is a double that is the distance radius in degrees.

Field Summary

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

GeoJSON, LEGACY, POLY, WKT

Constructor Summary

Constructors

Constructor and Description
LegacyShapeReader(SpatialContext ctx, SpatialContextFactory factory) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormatName() Deprecated.
Shape	read(Object value) Deprecated.
Shape	read(Reader reader) Deprecated. Read a Shape from the reader.
Shape	readIfSupported(Object value) Deprecated.
static Shape	readShapeOrNull(String str, SpatialContext ctx) Deprecated. Reads the shape specification as defined in the class javadocs.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyShapeReader

public LegacyShapeReader(SpatialContext ctx,
                 SpatialContextFactory factory)

Deprecated.

Method Detail

readShapeOrNull

public static Shape readShapeOrNull(String str,
                    SpatialContext ctx)
                             throws InvalidShapeException

Deprecated.

Reads the shape specification as defined in the class javadocs. If the first character is a letter but it doesn't complete out "Circle" or "CIRCLE" then this method returns null, offering the caller the opportunity to potentially try additional parsing. If the first character is not a letter then it's assumed to be a point or rectangle. If that doesn't work out then an InvalidShapeException is thrown.

Throws:

InvalidShapeException

getFormatName

public String getFormatName()

Deprecated.

Specified by:

getFormatName in interface ShapeIO

Returns:

the format name

read

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

Deprecated.

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

Deprecated.

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

read

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

Deprecated.

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

InvalidShapeException