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 |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
SpatialPredicate.evaluate(Shape indexedShape,
Shape queryShape)
Returns whether the relationship between indexedShape and queryShape is
satisfied by this operation.
|
Modifier and Type | Method and Description |
---|---|
<S extends Shape> |
SpatialContext.makeCollection(List<S> coll)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Shape |
SpatialContext.makeBufferedLineString(List<Point> points,
double buf)
Deprecated.
|
Shape |
SpatialContext.makeLineString(List<Point> points)
Deprecated.
|
Shape |
SpatialContext.readShape(String value)
Deprecated.
|
Shape |
SpatialContext.readShapeFromWkt(String wkt)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
String |
SpatialContext.toString(Shape shape)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Shape |
JtsSpatialContext.makeShapeFromGeometry(Geometry geom)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Geometry |
JtsSpatialContext.getGeometryFrom(Shape shape)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Shape |
WKTReader.parse(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(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,
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 |
PolyshapeReader.read(Object value) |
Shape |
WKTReader.read(Object value) |
Shape |
GeoJSONReader.read(Object value) |
Shape |
ShapeReader.read(Object value) |
Shape |
LegacyShapeReader.read(Object value)
Deprecated.
|
Shape |
PolyshapeReader.read(Reader r) |
Shape |
WKTReader.read(Reader reader) |
Shape |
GeoJSONReader.read(Reader reader) |
Shape |
ShapeReader.read(Reader reader)
Read a
Shape from the reader. |
Shape |
LegacyShapeReader.read(Reader reader)
Deprecated.
|
Shape |
SupportedFormats.read(String value) |
Shape |
PolyshapeReader.readIfSupported(Object value) |
Shape |
WKTReader.readIfSupported(Object value) |
Shape |
GeoJSONReader.readIfSupported(Object value) |
Shape |
ShapeReader.readIfSupported(Object value) |
Shape |
LegacyShapeReader.readIfSupported(Object value)
Deprecated.
|
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(DataInput dataInput) |
protected Shape |
GeoJSONReader.readShape(org.noggit.JSONParser parser) |
protected Shape |
BinaryCodec.readShapeByTypeIfSupported(DataInput dataInput,
byte type) |
protected Shape |
GeoJSONReader.readShapeFromCoordinates(String type,
org.noggit.JSONParser parser) |
static Shape |
LegacyShapeReader.readShapeOrNull(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.
|
Modifier and Type | Method and Description |
---|---|
String |
PolyshapeWriter.toString(Shape shape) |
String |
WKTWriter.toString(Shape shape) |
String |
ShapeWriter.toString(Shape shape)
Write a shape to String
|
String |
GeoJSONWriter.toString(Shape shape) |
String |
LegacyShapeWriter.toString(Shape shape)
Deprecated.
|
protected byte |
BinaryCodec.typeForShape(Shape s) |
void |
PolyshapeWriter.write(PolyshapeWriter.Encoder enc,
Shape shape) |
void |
PolyshapeWriter.write(Writer output,
Shape shape) |
void |
WKTWriter.write(Writer output,
Shape shape) |
void |
ShapeWriter.write(Writer output,
Shape shape)
Write a shape to the output writer
|
void |
GeoJSONWriter.write(Writer output,
Shape shape) |
void |
LegacyShapeWriter.write(Writer output,
Shape shape)
Deprecated.
|
void |
BinaryCodec.writeShape(DataOutput dataOutput,
Shape s) |
static 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 String |
LegacyShapeWriter.writeShape(Shape shape,
NumberFormat nf)
Deprecated.
Overloaded to provide a number format.
|
protected boolean |
BinaryCodec.writeShapeByTypeIfSupported(DataOutput dataOutput,
Shape s)
Note: writes the type byte even if not supported
|
protected boolean |
BinaryCodec.writeShapeByTypeIfSupported(DataOutput dataOutput,
Shape s,
byte type) |
Modifier and Type | Method and 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) |
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
Shape |
JtsWKTReaderShapeParser.parseIfSupported(String wktString)
Deprecated.
|
protected Shape |
JtsWKTReaderShapeParser.parseIfSupported(String str,
WKTReader reader)
Deprecated.
Reads WKT from the
str via JTS's WKTReader . |
Shape |
JtsBinaryCodec.readJtsGeom(DataInput dataInput) |
protected Shape |
JtsBinaryCodec.readShapeByTypeIfSupported(DataInput dataInput,
byte type) |
Modifier and Type | Method and Description |
---|---|
String |
JtsWKTWriter.toString(Shape shape) |
protected byte |
JtsBinaryCodec.typeForShape(Shape s) |
void |
JtsPolyshapeWriter.write(PolyshapeWriter.Encoder enc,
Shape shape) |
void |
JtsGeoJSONWriter.write(Writer output,
Shape shape) |
void |
JtsBinaryCodec.writeJtsGeom(DataOutput dataOutput,
Shape s) |
protected boolean |
JtsBinaryCodec.writeShapeByTypeIfSupported(DataOutput dataOutput,
Shape s,
byte type) |
Modifier and Type | Class and Description |
---|---|
class |
ShapeCollection<S extends Shape>
A collection of Shape objects, analogous to an OGC GeometryCollection.
|
static interface |
ShapeFactory.MultiShapeBuilder<T extends Shape> |
Modifier and Type | Interface and 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.
|
Modifier and Type | Class and Description |
---|---|
class |
BaseShape<T extends SpatialContext> |
class |
ShapeCollection<S extends Shape>
A collection of Shape objects, analogous to an OGC GeometryCollection.
|
Modifier and Type | Method and Description |
---|---|
<T extends Shape> |
ShapeFactory.multiShape(Class<T> shapeClass)
(Builder) Constructs a Shape aggregate in which each component/member
is an instance of the specified class.
|
<S extends Shape> |
ShapeFactory.multiShape(List<S> coll)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Shape |
ShapeFactory.LineStringBuilder.build() |
Shape |
ShapeFactory.PolygonBuilder.build()
Builds the polygon and renders this builder instance invalid.
|
Shape |
ShapeFactory.MultiShapeBuilder.build() |
Shape |
ShapeFactory.MultiPointBuilder.build() |
Shape |
ShapeFactory.MultiLineStringBuilder.build() |
Shape |
ShapeFactory.MultiPolygonBuilder.build() |
Shape |
ShapeFactory.PolygonBuilder.buildOrRect() |
Shape |
Shape.getBuffered(double distance,
SpatialContext ctx)
Returns a buffered version of this shape.
|
Shape |
ShapeFactory.lineString(List<Point> points,
double buf)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
SpatialRelation |
Shape.relate(Shape other)
Describe the relationship between the two objects.
|
SpatialRelation |
ShapeCollection.relate(Shape other) |
Modifier and Type | Method and Description |
---|---|
protected Rectangle |
ShapeCollection.computeBoundingBox(Collection<? extends Shape> shapes,
SpatialContext ctx) |
protected static boolean |
ShapeCollection.computeMutualDisjoint(List<? extends Shape> shapes)
Computes whether the shapes are mutually disjoint.
|
Modifier and Type | Class and Description |
---|---|
protected class |
ShapeFactoryImpl.GeneralShapeMultiShapeBuilder<T extends Shape> |
Modifier and Type | Class and 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.
|
Modifier and Type | Field and Description |
---|---|
protected List<Shape> |
ShapeFactoryImpl.GeneralShapeMultiShapeBuilder.shapes |
Modifier and Type | Method and Description |
---|---|
<T extends Shape> |
ShapeFactoryImpl.multiShape(Class<T> shapeClass) |
<S extends Shape> |
ShapeFactoryImpl.multiShape(List<S> coll) |
Modifier and Type | Method and Description |
---|---|
Shape |
ShapeFactoryImpl.GeneralShapeMultiShapeBuilder.build() |
Shape |
BufferedLine.getBuffered(double distance,
SpatialContext ctx) |
Shape |
BufferedLineString.getBuffered(double distance,
SpatialContext ctx) |
Shape |
ShapeFactoryImpl.lineString(List<Point> points,
double buf) |
Modifier and Type | Method and Description |
---|---|
SpatialRelation |
RectangleImpl.relate(Shape other) |
SpatialRelation |
BufferedLine.relate(Shape other) |
SpatialRelation |
PointImpl.relate(Shape other) |
SpatialRelation |
CircleImpl.relate(Shape other) |
SpatialRelation |
BufferedLineString.relate(Shape other) |
Modifier and Type | Class and Description |
---|---|
class |
JtsGeometry
Wraps a JTS
Geometry (i.e. |
class |
JtsPoint
Wraps a
Point . |
Modifier and Type | Method and Description |
---|---|
<T extends Shape> |
JtsShapeFactory.multiShape(Class<T> shapeClass) |
Modifier and Type | Method and Description |
---|---|
Shape |
JtsShapeFactory.lineString(List<Point> points,
double bufferDistance) |
Shape |
JtsShapeFactory.makeShapeFromGeometry(Geometry geom)
INTERNAL Usually creates a JtsGeometry, potentially validating, repairing, and indexing ("preparing").
|
Modifier and Type | Method and Description |
---|---|
Geometry |
JtsShapeFactory.getGeometryFrom(Shape shape)
|
SpatialRelation |
JtsPoint.relate(Shape other) |
SpatialRelation |
JtsGeometry.relate(Shape other) |
Copyright © 2020 LocationTech. All rights reserved.