Uses of Interface
org.locationtech.spatial4j.shape.Shape

Packages that use Shape

Package	Description
org.locationtech.spatial4j	This is the base package for Spatial4j from which the rest of it is organized.
org.locationtech.spatial4j.context	SpatialContext implementations are the facade to the Spatial4j API.
org.locationtech.spatial4j.context.jts
org.locationtech.spatial4j.io	Reading & writing shapes in various forms.
org.locationtech.spatial4j.io.jackson	Optional support to read/write Shapes and Geometry using Jackson
org.locationtech.spatial4j.io.jts
org.locationtech.spatial4j.shape	Shapes are the core geometry objects that Spatial4j provides.
org.locationtech.spatial4j.shape.impl
org.locationtech.spatial4j.shape.jts

Uses of Shape in org.locationtech.spatial4j

Methods in org.locationtech.spatial4j with parameters of type Shape

Modifier and Type	Method	Description
abstract boolean	SpatialPredicate.evaluate(Shape indexedShape, Shape queryShape)	Returns whether the relationship between indexedShape and queryShape is satisfied by this operation.

Uses of Shape in org.locationtech.spatial4j.context

Methods in org.locationtech.spatial4j.context with type parameters of type Shape

Modifier and Type	Method	Description
<S extends Shape> ShapeCollection<S>	SpatialContext.makeCollection(java.util.List<S> coll)	Deprecated.

Methods in org.locationtech.spatial4j.context that return Shape

Modifier and Type	Method	Description
Shape	SpatialContext.makeBufferedLineString(java.util.List<Point> points, double buf)	Deprecated.
Shape	SpatialContext.makeLineString(java.util.List<Point> points)	Deprecated.
Shape	SpatialContext.readShape(java.lang.String value)	Deprecated.
Shape	SpatialContext.readShapeFromWkt(java.lang.String wkt)	Deprecated.

Methods in org.locationtech.spatial4j.context with parameters of type Shape

Modifier and Type	Method	Description
java.lang.String	SpatialContext.toString(Shape shape)	Deprecated.

Uses of Shape in org.locationtech.spatial4j.context.jts

Methods in org.locationtech.spatial4j.context.jts that return Shape

Modifier and Type	Method	Description
Shape	JtsSpatialContext.makeShapeFromGeometry(org.locationtech.jts.geom.Geometry geom)	Deprecated.

Methods in org.locationtech.spatial4j.context.jts with parameters of type Shape

Modifier and Type	Method	Description
org.locationtech.jts.geom.Geometry	JtsSpatialContext.getGeometryFrom(Shape shape)	Deprecated.

Uses of Shape in org.locationtech.spatial4j.io

Methods in org.locationtech.spatial4j.io that return Shape

Modifier and Type	Method	Description
Shape	WKTReader.parse(java.lang.String wktString)	Parses the wktString, returning the defined Shape.
protected Shape	WKTReader.parseBufferShape(WKTReader.State state)	Parses the BUFFER operation applied to a parsed shape.
protected Shape	WKTReader.parseEnvelopeShape(WKTReader.State state)	Parses an ENVELOPE (aka Rectangle) shape from the raw string.
protected Shape	WKTReader.parseGeometryCollectionShape(WKTReader.State state)	Parses a GEOMETRYCOLLECTION shape from the raw string.
Shape	WKTReader.parseIfSupported(java.lang.String wktString)	Parses the wktString, returning the defined Shape.
protected Shape	WKTReader.parseLineStringShape(WKTReader.State state)	Parses a LINESTRING shape from the raw string -- an ordered sequence of points.
protected Shape	WKTReader.parseMulitPolygonShape(WKTReader.State state)	Parses a MULTIPOLYGON shape from the raw string.
protected Shape	WKTReader.parseMultiLineStringShape(WKTReader.State state)	Parses a MULTILINESTRING shape from the raw string -- a collection of line strings.
protected Shape	WKTReader.parseMultiPointShape(WKTReader.State state)	Parses a MULTIPOINT shape from the raw string -- a collection of points.
protected Shape	WKTReader.parsePointShape(WKTReader.State state)	Parses a POINT shape from the raw string.
protected Shape	WKTReader.parsePolygonShape(WKTReader.State state)	Parses a POLYGON shape from the raw string.
protected Shape	WKTReader.parseShapeByType(WKTReader.State state, java.lang.String shapeType)	(internal) Parses the remainder of a shape definition following the shape's name given as shapeType already consumed via WKTReader.State.nextWord().
Shape	GeoJSONReader.read(java.io.Reader reader)
Shape	GeoJSONReader.read(java.lang.Object value)
Shape	LegacyShapeReader.read(java.io.Reader reader)	Deprecated.
Shape	LegacyShapeReader.read(java.lang.Object value)	Deprecated.
Shape	PolyshapeReader.read(java.io.Reader r)
Shape	PolyshapeReader.read(java.lang.Object value)
Shape	ShapeReader.read(java.io.Reader reader)	Read a Shape from the reader.
Shape	ShapeReader.read(java.lang.Object value)
Shape	SupportedFormats.read(java.lang.String value)
Shape	WKTReader.read(java.io.Reader reader)
Shape	WKTReader.read(java.lang.Object value)
Shape	GeoJSONReader.readIfSupported(java.lang.Object value)
Shape	LegacyShapeReader.readIfSupported(java.lang.Object value)	Deprecated.
Shape	PolyshapeReader.readIfSupported(java.lang.Object value)
Shape	ShapeReader.readIfSupported(java.lang.Object value)
Shape	WKTReader.readIfSupported(java.lang.Object value)
protected Shape	GeoJSONReader.readLineString(org.noggit.JSONParser parser)
protected Shape	GeoJSONReader.readMultiLineString(org.noggit.JSONParser parser)
protected Shape	GeoJSONReader.readMultiPoint(org.noggit.JSONParser parser)
protected Shape	GeoJSONReader.readMultiPolygon(org.noggit.JSONParser parser)
protected Shape	GeoJSONReader.readPoint(org.noggit.JSONParser parser)
protected Shape	PolyshapeReader.readPolygon(PolyshapeReader.XReader reader)
Shape	BinaryCodec.readShape(java.io.DataInput dataInput)
protected Shape	GeoJSONReader.readShape(org.noggit.JSONParser parser)
protected Shape	BinaryCodec.readShapeByTypeIfSupported(java.io.DataInput dataInput, byte type)
protected Shape	GeoJSONReader.readShapeFromCoordinates(java.lang.String type, org.noggit.JSONParser parser)
static Shape	LegacyShapeReader.readShapeOrNull(java.lang.String str, SpatialContext ctx)	Deprecated. Reads the shape specification as defined in the class javadocs.
protected Shape	WKTReader.shape(WKTReader.State state)	Reads a shape from the current position, starting with the name of the shape.

Methods in org.locationtech.spatial4j.io with parameters of type Shape

Modifier and Type	Method	Description
java.lang.String	GeoJSONWriter.toString(Shape shape)
java.lang.String	LegacyShapeWriter.toString(Shape shape)	Deprecated.
java.lang.String	PolyshapeWriter.toString(Shape shape)
java.lang.String	ShapeWriter.toString(Shape shape)	Write a shape to String
java.lang.String	WKTWriter.toString(Shape shape)
protected byte	BinaryCodec.typeForShape(Shape s)
void	GeoJSONWriter.write(java.io.Writer output, Shape shape)
void	LegacyShapeWriter.write(java.io.Writer output, Shape shape)	Deprecated.
void	PolyshapeWriter.write(java.io.Writer output, Shape shape)
void	PolyshapeWriter.write(PolyshapeWriter.Encoder enc, Shape shape)
void	ShapeWriter.write(java.io.Writer output, Shape shape)	Write a shape to the output writer
void	WKTWriter.write(java.io.Writer output, Shape shape)
void	BinaryCodec.writeShape(java.io.DataOutput dataOutput, Shape s)
static java.lang.String	LegacyShapeWriter.writeShape(Shape shape)	Deprecated. Writes a shape to a String, in a format that can be read by LegacyShapeReader.readShapeOrNull(String, SpatialContext)
static java.lang.String	LegacyShapeWriter.writeShape(Shape shape, java.text.NumberFormat nf)	Deprecated. Overloaded to provide a number format.
protected boolean	BinaryCodec.writeShapeByTypeIfSupported(java.io.DataOutput dataOutput, Shape s)	Note: writes the type byte even if not supported
protected boolean	BinaryCodec.writeShapeByTypeIfSupported(java.io.DataOutput dataOutput, Shape s, byte type)

Uses of Shape in org.locationtech.spatial4j.io.jackson

Methods in org.locationtech.spatial4j.io.jackson that return Shape

Modifier and Type	Method	Description
Shape	ShapeDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.databind.DeserializationContext ctxt)
Shape	ShapeDeserializer.read(com.fasterxml.jackson.core.JsonParser jp, ShapeFactory factory)
Shape	ShapeDeserializer.read(com.fasterxml.jackson.databind.node.ObjectNode node, ShapeFactory factory)

Methods in org.locationtech.spatial4j.io.jackson with parameters of type Shape

Modifier and Type	Method	Description
void	ShapeAsGeoJSONSerializer.serialize(Shape shape, com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider serializers)
void	ShapeAsWKTSerializer.serialize(Shape value, com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider serializers)
void	ShapeAsGeoJSONSerializer.write(com.fasterxml.jackson.core.JsonGenerator gen, Shape shape)

Uses of Shape in org.locationtech.spatial4j.io.jts

Methods in org.locationtech.spatial4j.io.jts that return Shape

Modifier and Type	Method	Description
Shape	JtsWKTReaderShapeParser.parseIfSupported(java.lang.String wktString)	Deprecated.
protected Shape	JtsWKTReaderShapeParser.parseIfSupported(java.lang.String str, org.locationtech.jts.io.WKTReader reader)	Deprecated. Reads WKT from the str via JTS's WKTReader.
Shape	JtsBinaryCodec.readJtsGeom(java.io.DataInput dataInput)
protected Shape	JtsBinaryCodec.readShapeByTypeIfSupported(java.io.DataInput dataInput, byte type)

Methods in org.locationtech.spatial4j.io.jts with parameters of type Shape

Modifier and Type	Method	Description
java.lang.String	JtsWKTWriter.toString(Shape shape)
protected byte	JtsBinaryCodec.typeForShape(Shape s)
void	JtsGeoJSONWriter.write(java.io.Writer output, Shape shape)
void	JtsPolyshapeWriter.write(PolyshapeWriter.Encoder enc, Shape shape)
void	JtsBinaryCodec.writeJtsGeom(java.io.DataOutput dataOutput, Shape s)
protected boolean	JtsBinaryCodec.writeShapeByTypeIfSupported(java.io.DataOutput dataOutput, Shape s, byte type)

Uses of Shape in org.locationtech.spatial4j.shape

Classes in org.locationtech.spatial4j.shape with type parameters of type Shape

Modifier and Type	Class	Description
class	ShapeCollection<S extends Shape>	A collection of Shape objects, analogous to an OGC GeometryCollection.
static interface	ShapeFactory.MultiShapeBuilder<T extends Shape>

Subinterfaces of Shape in org.locationtech.spatial4j.shape

Modifier and Type	Interface	Description
interface	Circle	A circle, also known as a point-radius since that is what it is comprised of.
interface	Point	A Point with X & Y coordinates.
interface	Rectangle	A rectangle aligned with the axis (i.e.

Classes in org.locationtech.spatial4j.shape that implement Shape

Modifier and Type	Class	Description
class	BaseShape<T extends SpatialContext>
class	ShapeCollection<S extends Shape>	A collection of Shape objects, analogous to an OGC GeometryCollection.

Methods in org.locationtech.spatial4j.shape with type parameters of type Shape

Modifier and Type	Method	Description
<T extends Shape> ShapeFactory.MultiShapeBuilder<T>	ShapeFactory.multiShape(java.lang.Class<T> shapeClass)	(Builder) Constructs a Shape aggregate in which each component/member is an instance of the specified class.
<S extends Shape> ShapeCollection<S>	ShapeFactory.multiShape(java.util.List<S> coll)	Deprecated.

Methods in org.locationtech.spatial4j.shape that return Shape

Modifier and Type	Method	Description
Shape	ShapeFactory.LineStringBuilder.build()
Shape	ShapeFactory.MultiLineStringBuilder.build()
Shape	ShapeFactory.MultiPointBuilder.build()
Shape	ShapeFactory.MultiPolygonBuilder.build()
Shape	ShapeFactory.MultiShapeBuilder.build()
Shape	ShapeFactory.PolygonBuilder.build()	Builds the polygon and renders this builder instance invalid.
Shape	ShapeFactory.PolygonBuilder.buildOrRect()
Shape	Shape.getBuffered(double distance, SpatialContext ctx)	Returns a buffered version of this shape.
Shape	ShapeFactory.lineString(java.util.List<Point> points, double buf)	Deprecated.

Methods in org.locationtech.spatial4j.shape with parameters of type Shape

Modifier and Type	Method	Description
SpatialRelation	Shape.relate(Shape other)	Describe the relationship between the two objects.
SpatialRelation	ShapeCollection.relate(Shape other)

Method parameters in org.locationtech.spatial4j.shape with type arguments of type Shape

Modifier and Type	Method	Description
protected Rectangle	ShapeCollection.computeBoundingBox(java.util.Collection<? extends Shape> shapes, SpatialContext ctx)
protected static boolean	ShapeCollection.computeMutualDisjoint(java.util.List<? extends Shape> shapes)	Computes whether the shapes are mutually disjoint.

Uses of Shape in org.locationtech.spatial4j.shape.impl

Classes in org.locationtech.spatial4j.shape.impl with type parameters of type Shape

Modifier and Type	Class	Description
protected class	ShapeFactoryImpl.GeneralShapeMultiShapeBuilder<T extends Shape>

Classes in org.locationtech.spatial4j.shape.impl that implement Shape

Modifier and Type	Class	Description
class	BufferedLine	INTERNAL: A line between two points with a buffer distance extending in every direction.
class	BufferedLineString	A BufferedLineString is a collection of BufferedLine shapes, resulting in what some call a "Track" or "Polyline" (ESRI terminology).
class	CircleImpl	A circle, also known as a point-radius, based on a DistanceCalculator which does all the work.
class	GeoCircle	A circle as it exists on the surface of a sphere.
class	PointImpl	A basic 2D implementation of a Point.
class	RectangleImpl	A simple Rectangle implementation that also supports a longitudinal wrap-around.

Fields in org.locationtech.spatial4j.shape.impl with type parameters of type Shape

Modifier and Type	Field	Description
protected java.util.List<Shape>	ShapeFactoryImpl.GeneralShapeMultiShapeBuilder.shapes

Methods in org.locationtech.spatial4j.shape.impl with type parameters of type Shape

Modifier and Type	Method	Description
<T extends Shape> ShapeFactory.MultiShapeBuilder<T>	ShapeFactoryImpl.multiShape(java.lang.Class<T> shapeClass)
<S extends Shape> ShapeCollection<S>	ShapeFactoryImpl.multiShape(java.util.List<S> coll)

Methods in org.locationtech.spatial4j.shape.impl that return Shape

Modifier and Type	Method	Description
Shape	ShapeFactoryImpl.GeneralShapeMultiShapeBuilder.build()
Shape	BufferedLine.getBuffered(double distance, SpatialContext ctx)
Shape	BufferedLineString.getBuffered(double distance, SpatialContext ctx)
Shape	ShapeFactoryImpl.lineString(java.util.List<Point> points, double buf)

Methods in org.locationtech.spatial4j.shape.impl with parameters of type Shape

Modifier and Type	Method	Description
SpatialRelation	BufferedLine.relate(Shape other)
SpatialRelation	BufferedLineString.relate(Shape other)
SpatialRelation	CircleImpl.relate(Shape other)
SpatialRelation	PointImpl.relate(Shape other)
SpatialRelation	RectangleImpl.relate(Shape other)

Uses of Shape in org.locationtech.spatial4j.shape.jts

Classes in org.locationtech.spatial4j.shape.jts with type parameters of type Shape

Modifier and Type	Class	Description
private class	JtsShapeFactory.JtsMultiShapeBuilder<T extends Shape>

Classes in org.locationtech.spatial4j.shape.jts that implement Shape

Modifier and Type	Class	Description
class	JtsGeometry	Wraps a JTS Geometry (i.e.
class	JtsPoint	Wraps a Point.

Methods in org.locationtech.spatial4j.shape.jts with type parameters of type Shape

Modifier and Type	Method	Description
<T extends Shape> ShapeFactory.MultiShapeBuilder<T>	JtsShapeFactory.multiShape(java.lang.Class<T> shapeClass)

Methods in org.locationtech.spatial4j.shape.jts that return Shape

Modifier and Type	Method	Description
Shape	JtsShapeFactory.JtsLineStringBuilder.build()
Shape	JtsShapeFactory.JtsMultiLineStringBuilder.build()
Shape	JtsShapeFactory.JtsMultiPointBuilder.build()
Shape	JtsShapeFactory.JtsMultiPolygonBuilder.build()
Shape	JtsShapeFactory.JtsMultiShapeBuilder.build()
Shape	JtsShapeFactory.JtsPolygonBuilder.build()
Shape	JtsShapeFactory.JtsPolygonBuilder.buildOrRect()
Shape	JtsShapeFactory.lineString(java.util.List<Point> points, double bufferDistance)
Shape	JtsShapeFactory.makeShapeFromGeometry(org.locationtech.jts.geom.Geometry geom)	INTERNAL Usually creates a JtsGeometry, potentially validating, repairing, and indexing ("preparing").

Methods in org.locationtech.spatial4j.shape.jts with parameters of type Shape

Modifier and Type	Method	Description
org.locationtech.jts.geom.Geometry	JtsShapeFactory.getGeometryFrom(Shape shape)	Gets a JTS Geometry for the given Shape.
SpatialRelation	JtsGeometry.relate(Shape other)
SpatialRelation	JtsPoint.relate(Shape other)