Package org.locationtech.spatial4j.io

Class BinaryCodec

java.lang.Object

org.locationtech.spatial4j.io.BinaryCodec

Direct Known Subclasses:

JtsBinaryCodec

public class BinaryCodec
extends Object

A binary shape format. It is not designed to be a published standard, unlike Well Known Binary (WKB). The initial release is simple but it could get more optimized to use fewer bytes or to write & read pre-computed index structures.

Immutable and thread-safe.

Field Summary

Fields

Modifier and Type	Field	Description
protected SpatialContext	ctx
protected static byte	TYPE_CIRCLE
protected static byte	TYPE_COLL
protected static byte	TYPE_GEOM
protected static byte	TYPE_POINT
protected static byte	TYPE_RECT

Constructor Summary

Constructors

Constructor	Description
BinaryCodec(SpatialContext ctx, SpatialContextFactory factory)

Method Summary

Modifier and Type	Method	Description
Circle	readCircle(DataInput dataInput)
ShapeCollection	readCollection(DataInput dataInput)
protected double	readDim(DataInput dataInput)
Point	readPoint(DataInput dataInput)
Rectangle	readRect(DataInput dataInput)
Shape	readShape(DataInput dataInput)
protected Shape	readShapeByTypeIfSupported(DataInput dataInput, byte type)
protected byte	typeForShape(Shape s)
void	writeCircle(DataOutput dataOutput, Circle c)
void	writeCollection(DataOutput dataOutput, ShapeCollection col)
protected void	writeDim(DataOutput dataOutput, double v)
void	writePoint(DataOutput dataOutput, Point pt)
void	writeRect(DataOutput dataOutput, Rectangle r)
void	writeShape(DataOutput dataOutput, Shape s)
protected boolean	writeShapeByTypeIfSupported(DataOutput dataOutput, Shape s)	Note: writes the type byte even if not supported
protected boolean	writeShapeByTypeIfSupported(DataOutput dataOutput, Shape s, byte type)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_POINT

protected static final byte TYPE_POINT

See Also:

Constant Field Values

TYPE_RECT

protected static final byte TYPE_RECT

See Also:

Constant Field Values

TYPE_CIRCLE

protected static final byte TYPE_CIRCLE

See Also:

Constant Field Values

TYPE_COLL

protected static final byte TYPE_COLL

See Also:

Constant Field Values

TYPE_GEOM

protected static final byte TYPE_GEOM

See Also:

Constant Field Values

ctx

protected final SpatialContext ctx

Constructor Detail

BinaryCodec

public BinaryCodec(SpatialContext ctx,
                   SpatialContextFactory factory)

Method Detail

readShape

public Shape readShape(DataInput dataInput)
                throws IOException

Throws:

IOException

writeShape

public void writeShape(DataOutput dataOutput,
                       Shape s)
                throws IOException

Throws:

IOException

readShapeByTypeIfSupported

protected Shape readShapeByTypeIfSupported(DataInput dataInput,
                                           byte type)
                                    throws IOException

Throws:

IOException

writeShapeByTypeIfSupported

protected boolean writeShapeByTypeIfSupported(DataOutput dataOutput,
                                              Shape s)
                                       throws IOException

Note: writes the type byte even if not supported

Throws:

IOException

writeShapeByTypeIfSupported

protected boolean writeShapeByTypeIfSupported(DataOutput dataOutput,
                                              Shape s,
                                              byte type)
                                       throws IOException

Throws:

IOException

typeForShape

protected byte typeForShape(Shape s)

readDim

protected double readDim(DataInput dataInput)
                  throws IOException

Throws:

IOException

writeDim

protected void writeDim(DataOutput dataOutput,
                        double v)
                 throws IOException

Throws:

IOException

readPoint

public Point readPoint(DataInput dataInput)
                throws IOException

Throws:

IOException

writePoint

public void writePoint(DataOutput dataOutput,
                       Point pt)
                throws IOException

Throws:

IOException

readRect

public Rectangle readRect(DataInput dataInput)
                   throws IOException

Throws:

IOException

writeRect

public void writeRect(DataOutput dataOutput,
                      Rectangle r)
               throws IOException

Throws:

IOException

readCircle

public Circle readCircle(DataInput dataInput)
                  throws IOException

Throws:

IOException

writeCircle

public void writeCircle(DataOutput dataOutput,
                        Circle c)
                 throws IOException

Throws:

IOException

readCollection

public ShapeCollection readCollection(DataInput dataInput)
                               throws IOException

Throws:

IOException

writeCollection

public void writeCollection(DataOutput dataOutput,
                            ShapeCollection col)
                     throws IOException

Throws:

IOException