Skip navigation links
A B C D E G H I J K L M N O P Q R S T U V W X Y 

A

AbstractDistanceCalculator - Class in com.spatial4j.core.distance
 
AbstractDistanceCalculator() - Constructor for class com.spatial4j.core.distance.AbstractDistanceCalculator
 
addReaderIfNoggitExists(Class<? extends ShapeReader>) - Method in class com.spatial4j.core.context.SpatialContextFactory
 
allowMultiOverlap - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
allowMultiOverlap - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
append(StringBuilder, Point, NumberFormat) - Method in class com.spatial4j.core.io.WKTWriter
 
area(Rectangle) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
area(Circle) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
area(Rectangle) - Method in interface com.spatial4j.core.distance.DistanceCalculator
 
area(Circle) - Method in interface com.spatial4j.core.distance.DistanceCalculator
 
area(Rectangle) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
area(Circle) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
args - Variable in class com.spatial4j.core.context.SpatialContextFactory
autoIndex - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
autoIndex - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 

B

BaseShape<T extends SpatialContext> - Class in com.spatial4j.core.shape
 
BaseShape(T) - Constructor for class com.spatial4j.core.shape.BaseShape
 
bbox - Variable in class com.spatial4j.core.shape.ShapeCollection
 
BBoxCalculator - Class in com.spatial4j.core.shape.impl
(INTERNAL) Calculates the minimum bounding box given a bunch of rectangles (ranges).
BBoxCalculator(SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.BBoxCalculator
 
BBoxIntersects - Static variable in class com.spatial4j.core.SpatialPredicate
Bounding box of the *indexed* shape, then SpatialPredicate.Intersects.
BBoxWithin - Static variable in class com.spatial4j.core.SpatialPredicate
Bounding box of the *indexed* shape, then SpatialPredicate.IsWithin.
BinaryCodec - Class in com.spatial4j.core.io
A binary shape format.
BinaryCodec(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.BinaryCodec
 
binaryCodecClass - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
BUFFER - Static variable in class com.spatial4j.core.io.GeoJSONReader
 
BUFFER_UNITS - Static variable in class com.spatial4j.core.io.GeoJSONReader
 
BufferedLine - Class in com.spatial4j.core.shape.impl
INTERNAL: A line between two points with a buffer distance extending in every direction.
BufferedLine(Point, Point, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.BufferedLine
Creates a buffered line from pA to pB.
BufferedLineString - Class in com.spatial4j.core.shape.impl
A BufferedLineString is a collection of BufferedLine shapes, resulting in what some call a "Track" or "Polyline" (ESRI terminology).
BufferedLineString(List<Point>, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.BufferedLineString
Needs at least 1 point, usually more than that.
BufferedLineString(List<Point>, double, boolean, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.BufferedLineString
 

C

calcBoxByDistFromPt(Point, double, SpatialContext, Rectangle) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
calcBoxByDistFromPt(Point, double, SpatialContext, Rectangle) - Method in interface com.spatial4j.core.distance.DistanceCalculator
Calculates the bounding box of a circle, as specified by its center point and distance.
calcBoxByDistFromPt(Point, double, SpatialContext, Rectangle) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
calcBoxByDistFromPt_deltaLonDEG(double, double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
The delta longitude of a point-distance.
calcBoxByDistFromPt_latHorizAxisDEG(double, double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
The latitude of the horizontal axis (e.g.
calcBoxByDistFromPt_yHorizAxisDEG(Point, double, SpatialContext) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
calcBoxByDistFromPt_yHorizAxisDEG(Point, double, SpatialContext) - Method in interface com.spatial4j.core.distance.DistanceCalculator
The Y coordinate of the horizontal axis of a circle that has maximum width.
calcBoxByDistFromPt_yHorizAxisDEG(Point, double, SpatialContext) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
calcBoxByDistFromPtDEG(double, double, double, SpatialContext, Rectangle) - Static method in class com.spatial4j.core.distance.DistanceUtils
Calculates the bounding box of a circle, as specified by its center point and distance.
calcDistance(Point, double, double) - Method in class com.spatial4j.core.context.SpatialContext
Convenience that uses SpatialContext.getDistCalc()
calcDistance(Point, Point) - Method in class com.spatial4j.core.context.SpatialContext
Convenience that uses SpatialContext.getDistCalc()
calcLonDegreesAtLat(double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Calculates the degrees longitude distance at latitude lat to cover a distance dist.
CartesianDistCalc - Class in com.spatial4j.core.distance
Calculates based on Euclidean / Cartesian 2d plane.
CartesianDistCalc() - Constructor for class com.spatial4j.core.distance.CartesianDistCalc
 
CartesianDistCalc(boolean) - Constructor for class com.spatial4j.core.distance.CartesianDistCalc
 
checkCoordinates(Geometry) - Method in class com.spatial4j.core.io.jts.JtsWKTReaderShapeParser
 
checkDefaultFormats() - Method in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
checkDefaultFormats() - Method in class com.spatial4j.core.context.SpatialContextFactory
If no formats were defined in the config, this will make sure GeoJSON and WKT are registered
Circle - Interface in com.spatial4j.core.shape
A circle, also known as a point-radius since that is what it is comprised of.
CircleImpl - Class in com.spatial4j.core.shape.impl
A circle, also known as a point-radius, based on a DistanceCalculator which does all the work.
CircleImpl(Point, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.CircleImpl
 
classLoader - Variable in class com.spatial4j.core.context.SpatialContextFactory
com.spatial4j.core - package com.spatial4j.core
This is the base package for Spatial4j from which the rest of it is organized.
com.spatial4j.core.context - package com.spatial4j.core.context
SpatialContext implementations are the facade to the Spatial4j API.
com.spatial4j.core.context.jts - package com.spatial4j.core.context.jts
 
com.spatial4j.core.distance - package com.spatial4j.core.distance
Ways to calculate distance.
com.spatial4j.core.exception - package com.spatial4j.core.exception
 
com.spatial4j.core.io - package com.spatial4j.core.io
Reading & writing shapes in various forms.
com.spatial4j.core.io.jts - package com.spatial4j.core.io.jts
 
com.spatial4j.core.shape - package com.spatial4j.core.shape
Shapes are the core geometry objects that Spatial4j provides.
com.spatial4j.core.shape.impl - package com.spatial4j.core.shape.impl
 
com.spatial4j.core.shape.jts - package com.spatial4j.core.shape.jts
 
combine(SpatialRelation) - Method in enum com.spatial4j.core.shape.SpatialRelation
If you were to call aShape.relate(bShape) and aShape.relate(cShape), you could call this to merge the intersect results as if bShape & cShape were combined into ShapeCollection.
compareTo(Range.LongitudeRange) - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
computeBoundingBox(Collection<? extends Shape>, SpatialContext) - Method in class com.spatial4j.core.shape.ShapeCollection
 
computeGeoBBox(Geometry) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
Given geoms which has already been checked for being in world bounds, return the minimal longitude range of the bounding box.
computeMutualDisjoint(List<? extends Shape>) - Static method in class com.spatial4j.core.shape.ShapeCollection
Computes whether the shapes are mutually disjoint.
contains(Point) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
contains(double, double) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
contains(double) - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
contains(double) - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
Contains - Static variable in class com.spatial4j.core.SpatialPredicate
Meets the "Covers" OGC definition (boundary-neutral).
coord(List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
coordinate(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Reads a Coordinate from the current position.
coordinateSequence(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Reads a JTS Coordinate sequence from the current position.
coordinateSequenceFactory - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
coordinateSequenceList(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Reads a list of JTS Coordinate sequences from the current position.
coordseq(List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
coordseq(List<double[]>) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeReader
 
cornerByQuadrant(Rectangle, int, Point) - Static method in class com.spatial4j.core.shape.impl.InfBufLine
 
createGeometryCollection(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createLineString(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createMultiLineString(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createMultiPoint(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createMultiPolygon(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createPoint(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
createPolygon(GeometryFactory, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
crossesDateline() - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
ctx - Variable in class com.spatial4j.core.io.BinaryCodec
 
ctx - Variable in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
ctx - Variable in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
ctx - Variable in class com.spatial4j.core.io.jts.JtsPolyshapeReader
 
ctx - Variable in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
ctx - Variable in class com.spatial4j.core.io.jts.JtsWKTReader
 
ctx - Variable in class com.spatial4j.core.io.WKTReader
 
ctx - Variable in class com.spatial4j.core.shape.BaseShape
 
ctx - Variable in class com.spatial4j.core.shape.ShapeCollection
 

D

DatelineRule - Enum in com.spatial4j.core.context.jts
Indicates the algorithm used to process JTS Polygons and JTS LineStrings for detecting dateline crossings.
datelineRule - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
datelineRule - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
decode(String, SpatialContext) - Static method in class com.spatial4j.core.io.GeohashUtils
Decodes the given geohash into a latitude and longitude
decodeBoundary(String, SpatialContext) - Static method in class com.spatial4j.core.io.GeohashUtils
Returns min-max lat, min-max lon.
defaultPrecisionModel - Static variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
DEG_180_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
DEG_225_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
DEG_270_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
DEG_45_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
DEG_90_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
DEG_TO_KM - Static variable in class com.spatial4j.core.distance.DistanceUtils
Equivalent to degrees2Dist(1, EARTH_MEAN_RADIUS_KM)
degrees2Dist(double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Converts degrees (1/360th of circumference of a circle) into a distance as measured by the units of the radius.
DEGREES_TO_RADIANS - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
deltaLen(Range) - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
dimension - Variable in class com.spatial4j.core.io.WKTReader.State
Dimensionality specifier (e.g.
dist2Degrees(double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Converts a distance in the units of the radius to degrees (360 degrees are in a circle).
dist2Radians(double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Converts a distance in the units of radius (e.g.
distance(Point, Point) - Method in class com.spatial4j.core.distance.AbstractDistanceCalculator
 
distance(Point, double, double) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
distance(Point, Point) - Method in interface com.spatial4j.core.distance.DistanceCalculator
The distance between from and to.
distance(Point, double, double) - Method in interface com.spatial4j.core.distance.DistanceCalculator
The distance between from and Point(toX,toY).
distance(Point, double, double) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
DistanceCalculator - Interface in com.spatial4j.core.distance
Performs calculations relating to distance, such as the distance between a pair of points.
distanceLatLonRAD(double, double, double, double) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
distanceLatLonRAD(double, double, double, double) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc.Haversine
 
distanceLatLonRAD(double, double, double, double) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc.LawOfCosines
 
distanceLatLonRAD(double, double, double, double) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc.Vincenty
 
distanceUnbuffered(Point) - Method in class com.spatial4j.core.shape.impl.InfBufLine
INTERNAL AKA lineToPointDistance
DistanceUtils - Class in com.spatial4j.core.distance
Various distance calculations and constants.
distCalc - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
distHaversineRAD(double, double, double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
 
distLawOfCosinesRAD(double, double, double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Calculates the distance between two lat-lon's using the Law of Cosines.
distSquaredCartesian(double[], double[]) - Static method in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
distVincentyRAD(double, double, double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Calculates the great circle distance using the Vincenty Formula, simplified for a spherical model.
doesXWorldWrap() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 

E

EARTH_EQUATORIAL_RADIUS_KM - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
EARTH_EQUATORIAL_RADIUS_MI - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
EARTH_MEAN_RADIUS_KM - Static variable in class com.spatial4j.core.distance.DistanceUtils
The International Union of Geodesy and Geophysics says the Earth's mean radius in KM is: [1] http://en.wikipedia.org/wiki/Earth_radius
EARTH_MEAN_RADIUS_MI - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
enclosingBox - Variable in class com.spatial4j.core.shape.impl.CircleImpl
 
encodeLatLon(double, double) - Static method in class com.spatial4j.core.io.GeohashUtils
Encodes the given latitude and longitude into a geohash
encodeLatLon(double, double, int) - Static method in class com.spatial4j.core.io.GeohashUtils
 
Encoder(Writer) - Constructor for class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
ensureSize(List, int) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
eof() - Method in class com.spatial4j.core.io.WKTReader.State
If the string is consumed, i.e.
equals(Object) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
equals(Object) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
equals(Object) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
equals(Object) - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
equals(Object) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
equals(Circle, Object) - Static method in class com.spatial4j.core.shape.impl.CircleImpl
All Circle implementations should use this definition of Object.equals(Object).
equals(Object) - Method in class com.spatial4j.core.shape.impl.PointImpl
 
equals(Point, Object) - Static method in class com.spatial4j.core.shape.impl.PointImpl
All Point implementations should use this definition of Object.equals(Object).
equals(Object) - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
equals(Object) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
equals(Rectangle, Object) - Static method in class com.spatial4j.core.shape.impl.RectangleImpl
All Rectangle implementations should use this definition of Object.equals(Object).
equals(Object) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
equals(Object) - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
equals(Object) - Method in interface com.spatial4j.core.shape.Shape
The sub-classes of Shape generally implement the same contract for Object.equals(Object) and Object.hashCode() amongst the same sub-interface type.
equals(Object) - Method in class com.spatial4j.core.shape.ShapeCollection
 
evaluate(Shape, Shape) - Method in class com.spatial4j.core.SpatialPredicate
Returns whether the relationship between indexedShape and queryShape is satisfied by this operation.
expandBufForLongitudeSkew(Point, Point, double) - Static method in class com.spatial4j.core.shape.impl.BufferedLine
Calls DistanceUtils.calcLonDegreesAtLat(double, double) given pA or pB's latitude; whichever is farthest.
expandRange(Rectangle) - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
expandRange(double, double, double, double) - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
expandTo(Range) - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
expandTo(Range) - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
expandTo(Range.LongitudeRange) - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
expandXRange(double, double) - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 

G

GEO - Static variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
GEO - Static variable in class com.spatial4j.core.context.SpatialContext
A popular default SpatialContext implementation for geospatial.
geo - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
GeoCircle - Class in com.spatial4j.core.shape.impl
A circle as it exists on the surface of a sphere.
GeoCircle(Point, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.GeoCircle
 
GeodesicSphereDistCalc - Class in com.spatial4j.core.distance
A base class for a Distance Calculator that assumes a spherical earth model.
GeodesicSphereDistCalc() - Constructor for class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
GeodesicSphereDistCalc.Haversine - Class in com.spatial4j.core.distance
 
GeodesicSphereDistCalc.LawOfCosines - Class in com.spatial4j.core.distance
 
GeodesicSphereDistCalc.Vincenty - Class in com.spatial4j.core.distance
 
GeohashUtils - Class in com.spatial4j.core.io
Utilities for encoding and decoding geohashes.
GeoJSON - Static variable in interface com.spatial4j.core.io.ShapeIO
 
GeoJSONReader - Class in com.spatial4j.core.io
 
GeoJSONReader(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.GeoJSONReader
 
GeoJSONWriter - Class in com.spatial4j.core.io
 
GeoJSONWriter(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.GeoJSONWriter
 
geometryFactory - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
get(int) - Method in class com.spatial4j.core.shape.ShapeCollection
 
get(String) - Static method in class com.spatial4j.core.SpatialPredicate
 
getA() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getArea(SpatialContext) - Method in interface com.spatial4j.core.shape.Shape
Calculates the area of the shape, in square-degrees.
getArea(SpatialContext) - Method in class com.spatial4j.core.shape.ShapeCollection
 
getB() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getBinaryCodec() - Method in class com.spatial4j.core.context.SpatialContext
 
getBoundary() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
getBoundingBox() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getBoundingBox() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getBoundingBox() - Method in class com.spatial4j.core.shape.impl.CircleImpl
Note that the bounding box might contain a minX that is > maxX, due to WGS84 dateline.
getBoundingBox() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getBoundingBox() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getBoundingBox() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
getBoundingBox() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getBoundingBox() - Method in interface com.spatial4j.core.shape.Shape
Get the bounding box for this Shape.
getBoundingBox() - Method in class com.spatial4j.core.shape.ShapeCollection
 
getBuf() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getBuf() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getBuf() - Method in class com.spatial4j.core.shape.impl.InfBufLine
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getBuffered(double, SpatialContext) - Method in interface com.spatial4j.core.shape.Shape
Returns a buffered version of this shape.
getBuffered(double, SpatialContext) - Method in class com.spatial4j.core.shape.ShapeCollection
 
getCenter() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
getCenter() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getCenter() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
getCenter() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getCenter() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
getCenter() - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
getCenter() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getCenter() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
getCenter() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getCenter() - Method in interface com.spatial4j.core.shape.Shape
Returns the center point of this shape.
getCenter() - Method in class com.spatial4j.core.shape.ShapeCollection
 
getContext() - Method in class com.spatial4j.core.shape.BaseShape
 
getContext() - Method in interface com.spatial4j.core.shape.Shape
Get the SpatialContext that created the Shape
getContext() - Method in class com.spatial4j.core.shape.ShapeCollection
 
getCrossesDateLine() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getCrossesDateLine() - Method in interface com.spatial4j.core.shape.Rectangle
Only meaningful for geospatial contexts.
getCtx() - Method in class com.spatial4j.core.io.WKTReader.State
 
getDatelineRule() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
Returns the rule used to handle geometry objects that have dateline crossing considerations.
getDatelineRule() - Method in class com.spatial4j.core.io.jts.JtsWKTReader
 
getDistCalc() - Method in class com.spatial4j.core.context.SpatialContext
 
getDistDenomInv() - Method in class com.spatial4j.core.shape.impl.InfBufLine
1 / Math.sqrt(slope * slope + 1)
getFormatName() - Method in class com.spatial4j.core.io.GeoJSONReader
 
getFormatName() - Method in class com.spatial4j.core.io.GeoJSONWriter
 
getFormatName() - Method in class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
 
getFormatName() - Method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
 
getFormatName() - Method in class com.spatial4j.core.io.PolyshapeReader
 
getFormatName() - Method in class com.spatial4j.core.io.PolyshapeWriter
 
getFormatName() - Method in interface com.spatial4j.core.io.ShapeIO
 
getFormatName() - Method in class com.spatial4j.core.io.WKTReader
 
getFormatName() - Method in class com.spatial4j.core.io.WKTWriter
 
getFormats() - Method in class com.spatial4j.core.context.SpatialContext
 
getGeoJsonReader() - Method in class com.spatial4j.core.io.SupportedFormats
 
getGeoJsonWriter() - Method in class com.spatial4j.core.io.SupportedFormats
 
getGeom() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
getGeom() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getGeometryFactory() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
getGeometryFactory() - Method in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
getGeometryFrom(Shape) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
Gets a JTS Geometry for the given Shape.
getHeight() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getHeight() - Method in interface com.spatial4j.core.shape.Rectangle
The height.
getIntercept() - Method in class com.spatial4j.core.shape.impl.InfBufLine
 
getLinePerp() - Method in class com.spatial4j.core.shape.impl.BufferedLine
INTERNAL
getLinePrimary() - Method in class com.spatial4j.core.shape.impl.BufferedLine
INTERNAL
getMax() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
getMaxX() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
getMaxX() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getMaxX() - Method in interface com.spatial4j.core.shape.Rectangle
The right edge of the X coordinate.
getMaxY() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
getMaxY() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getMaxY() - Method in interface com.spatial4j.core.shape.Rectangle
The top edge of the Y coordinate.
getMin() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
getMinX() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
getMinX() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getMinX() - Method in interface com.spatial4j.core.shape.Rectangle
The left edge of the X coordinate.
getMinY() - Method in class com.spatial4j.core.shape.impl.BBoxCalculator
 
getMinY() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getMinY() - Method in interface com.spatial4j.core.shape.Rectangle
The bottom edge of the Y coordinate.
getName() - Method in class com.spatial4j.core.SpatialPredicate
 
getParser() - Method in class com.spatial4j.core.io.WKTReader.State
 
getPoints() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getRadius() - Method in interface com.spatial4j.core.shape.Circle
The distance from the point's center to its edge, measured in the same units as x & y (e.g.
getRadius() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
getReader(String) - Method in class com.spatial4j.core.io.SupportedFormats
 
getReaders() - Method in class com.spatial4j.core.io.SupportedFormats
 
getSegments() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
getShapes() - Method in class com.spatial4j.core.shape.ShapeCollection
 
getSlope() - Method in class com.spatial4j.core.shape.impl.InfBufLine
 
getSubGeohashes(String) - Static method in class com.spatial4j.core.io.GeohashUtils
Array of geohashes 1 level below the baseGeohash.
getValidationRule() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
Returns the rule used to handle errors when creating a JTS Geometry, particularly after it has been read from one of the ShapeReaders.
getWidth() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
getWidth() - Method in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
getWidth() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
getWidth() - Method in interface com.spatial4j.core.shape.Rectangle
The width.
getWktReader() - Method in class com.spatial4j.core.io.SupportedFormats
 
getWktShapeParser() - Method in class com.spatial4j.core.context.SpatialContext
Deprecated.
getWktWriter() - Method in class com.spatial4j.core.io.SupportedFormats
 
getWorldBounds() - Method in class com.spatial4j.core.context.SpatialContext
The extent of x & y coordinates should fit within the return'ed rectangle.
getWriter(String) - Method in class com.spatial4j.core.io.SupportedFormats
 
getWriters() - Method in class com.spatial4j.core.io.SupportedFormats
 
getX() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getX() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getX() - Method in interface com.spatial4j.core.shape.Point
The X coordinate, or Longitude in geospatial contexts.
getXAxis() - Method in class com.spatial4j.core.shape.impl.CircleImpl
The X coordinate of where the circle axis intersect.
getY() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
getY() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
getY() - Method in interface com.spatial4j.core.shape.Point
The Y coordinate, or Latitude in geospatial contexts.
getYAxis() - Method in class com.spatial4j.core.shape.impl.CircleImpl
The Y coordinate of where the circle axis intersect.
getYAxis() - Method in class com.spatial4j.core.shape.impl.GeoCircle
 

H

hasArea() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
hasArea() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
hasArea() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
hasArea() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
hasArea() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
hasArea() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
hasArea() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
hasArea() - Method in interface com.spatial4j.core.shape.Shape
Does the shape have area? This will be false for points and lines.
hasArea() - Method in class com.spatial4j.core.shape.ShapeCollection
 
hasFormatConfig - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
hashCode() - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
hashCode() - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
hashCode() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
hashCode() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
hashCode() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
hashCode(Circle) - Static method in class com.spatial4j.core.shape.impl.CircleImpl
All Circle implementations should use this definition of Object.hashCode().
hashCode() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
hashCode(Point) - Static method in class com.spatial4j.core.shape.impl.PointImpl
All Point implementations should use this definition of Object.hashCode().
hashCode() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
hashCode() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
hashCode(Rectangle) - Static method in class com.spatial4j.core.shape.impl.RectangleImpl
All Rectangle implementations should use this definition of Object.hashCode().
hashCode() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
hashCode() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
hashCode() - Method in class com.spatial4j.core.shape.ShapeCollection
 
Haversine() - Constructor for class com.spatial4j.core.distance.GeodesicSphereDistCalc.Haversine
 

I

index() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
Adds an index to this class internally to compute spatial relations faster.
InfBufLine - Class in com.spatial4j.core.shape.impl
INERNAL: A buffered line of infinite length.
init(Map<String, String>, ClassLoader) - Method in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
init(Map<String, String>, ClassLoader) - Method in class com.spatial4j.core.context.SpatialContextFactory
 
initCalculator() - Method in class com.spatial4j.core.context.SpatialContextFactory
 
initField(String) - Method in class com.spatial4j.core.context.SpatialContextFactory
Gets name from args and populates a field by the same name with the value.
initFormats() - Method in class com.spatial4j.core.context.SpatialContextFactory
Check args for 'readers' and 'writers'.
initWorldBounds() - Method in class com.spatial4j.core.context.SpatialContextFactory
 
intersectionMatrixToSpatialRelation(IntersectionMatrix) - Static method in class com.spatial4j.core.shape.jts.JtsGeometry
 
intersects() - Method in enum com.spatial4j.core.shape.SpatialRelation
Not DISJOINT, i.e.
Intersects - Static variable in class com.spatial4j.core.SpatialPredicate
Meets the "Intersects" OGC definition.
InvalidShapeException - Exception in com.spatial4j.core.exception
A shape was constructed but failed because, based on the given parts, it's invalid.
InvalidShapeException(String, Throwable) - Constructor for exception com.spatial4j.core.exception.InvalidShapeException
 
InvalidShapeException(String) - Constructor for exception com.spatial4j.core.exception.InvalidShapeException
 
inverse() - Method in enum com.spatial4j.core.shape.SpatialRelation
If aShape.relate(bShape) is r, then r.inverse() is inverse(aShape).relate(bShape) whereas inverse(shape) is theoretically the opposite area covered by a shape, i.e.
is(SpatialPredicate, SpatialPredicate...) - Static method in class com.spatial4j.core.SpatialPredicate
 
isAllowMultiOverlap() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
If geom might be a multi geometry of some kind, then might multiple component geometries overlap? Strict OGC says this is invalid but we can accept it by computing the union.
isAutoIndex() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
If JtsGeometry shapes should be automatically "prepared" (i.e.
isData() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
IsDisjointTo - Static variable in class com.spatial4j.core.SpatialPredicate
Meets the "Disjoint" OGC definition.
isDone() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
isEmpty() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
isEmpty() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
isEmpty() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
isEmpty() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
isEmpty() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
isEmpty() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
isEmpty() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
isEmpty() - Method in interface com.spatial4j.core.shape.Shape
Shapes can be "empty", which is to say it exists nowhere.
IsEqualTo - Static variable in class com.spatial4j.core.SpatialPredicate
Meets the "Equals" OGC definition.
isEvent() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
isGeo() - Method in class com.spatial4j.core.context.SpatialContext
Is the mathematical world model based on a sphere, or is it a flat plane? The word "geodetic" or "geodesic" is sometimes used to refer to the former, and the latter is sometimes referred to as "Euclidean" or "cartesian".
isNormWrapLongitude() - Method in class com.spatial4j.core.context.SpatialContext
If true then SpatialContext.normX(double) will wrap longitudes outside of the standard geodetic boundary into it.
IsWithin - Static variable in class com.spatial4j.core.SpatialPredicate
Meets the "CoveredBy" OGC definition (boundary-neutral).

J

JtsBinaryCodec - Class in com.spatial4j.core.io.jts
Writes shapes in WKB, if it isn't otherwise supported by the superclass.
JtsBinaryCodec(JtsSpatialContext, JtsSpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsBinaryCodec
 
JtsGeoJSONReader - Class in com.spatial4j.core.io.jts
 
JtsGeoJSONReader(JtsSpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
JtsGeoJSONWriter - Class in com.spatial4j.core.io.jts
 
JtsGeoJSONWriter(JtsSpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
JtsGeometry - Class in com.spatial4j.core.shape.jts
Wraps a JTS Geometry (i.e.
JtsGeometry(Geometry, JtsSpatialContext, boolean, boolean) - Constructor for class com.spatial4j.core.shape.jts.JtsGeometry
 
JtsPoint - Class in com.spatial4j.core.shape.jts
Wraps a Point.
JtsPoint(Point, JtsSpatialContext) - Constructor for class com.spatial4j.core.shape.jts.JtsPoint
A simple constructor without normalization / validation.
JtsPolyshapeReader - Class in com.spatial4j.core.io.jts
 
JtsPolyshapeReader(JtsSpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsPolyshapeReader
 
JtsPolyshapeWriter - Class in com.spatial4j.core.io.jts
 
JtsPolyshapeWriter(JtsSpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
JtsSpatialContext - Class in com.spatial4j.core.context.jts
Enhances the default SpatialContext with support for Polygons (and other geometries) using JTS.
JtsSpatialContext(JtsSpatialContextFactory) - Constructor for class com.spatial4j.core.context.jts.JtsSpatialContext
JtsSpatialContextFactory - Class in com.spatial4j.core.context.jts
JtsSpatialContextFactory() - Constructor for class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
JtsWKTReader - Class in com.spatial4j.core.io.jts
Extends WKTReader adding support for polygons, using JTS.
JtsWKTReader(JtsSpatialContext, JtsSpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsWKTReader
 
JtsWKTReaderShapeParser - Class in com.spatial4j.core.io.jts
This is an extension of JtsWKTReader that processes the entire string with JTS's WKTReader.
JtsWKTReaderShapeParser(JtsSpatialContext, JtsSpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsWKTReaderShapeParser
 
JtsWKTWriter - Class in com.spatial4j.core.io.jts
Writes the WKT using JTS directly
JtsWKTWriter(JtsSpatialContext, JtsSpatialContextFactory) - Constructor for class com.spatial4j.core.io.jts.JtsWKTWriter
 

K

KEY_ARG_END - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_ARG_START - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_BOX - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_CIRCLE - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_LINE - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_MULTIPOINT - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_POINT - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_POLYGON - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KEY_SEPERATOR - Static variable in class com.spatial4j.core.io.PolyshapeWriter
 
KM_TO_DEG - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
KM_TO_MILES - Static variable in class com.spatial4j.core.distance.DistanceUtils
 

L

LawOfCosines() - Constructor for class com.spatial4j.core.distance.GeodesicSphereDistCalc.LawOfCosines
 
LEGACY - Static variable in interface com.spatial4j.core.io.ShapeIO
 
LegacyShapeReader - Class in com.spatial4j.core.io
Deprecated.
LegacyShapeReader(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
 
LegacyShapeWriter - Class in com.spatial4j.core.io
Deprecated.
LegacyShapeWriter(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
 
LongitudeRange(double, double) - Constructor for class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
LongitudeRange(Rectangle) - Constructor for class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
lookupDegreesSizeForHashLen(int) - Static method in class com.spatial4j.core.io.GeohashUtils
 
lookupHashLenForWidthHeight(double, double) - Static method in class com.spatial4j.core.io.GeohashUtils
Return the shortest geohash length that will have a width & height >= specified arguments.

M

makeBinaryCodec(SpatialContext) - Method in class com.spatial4j.core.context.SpatialContextFactory
 
makeBufferedLineString(List<Point>, double) - Method in class com.spatial4j.core.context.SpatialContext
Constructs a buffered line string.
makeCircle(double, double, double) - Method in class com.spatial4j.core.context.SpatialContext
Construct a circle.
makeCircle(Point, double) - Method in class com.spatial4j.core.context.SpatialContext
Construct a circle.
makeCollection(List<S>) - Method in class com.spatial4j.core.context.SpatialContext
Construct a ShapeCollection, analogous to an OGC GeometryCollection.
makeCollection(List<? extends Shape>) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeReader
 
makeCollection(List<? extends Shape>) - Method in class com.spatial4j.core.io.PolyshapeReader
Subclass may try to make multiple points into a MultiPoint
makeFormats(SpatialContext) - Method in class com.spatial4j.core.context.SpatialContextFactory
 
makeLineString(List<Point>) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
makeLineString(List<Point>) - Method in class com.spatial4j.core.context.SpatialContext
Constructs a line string.
makeNumberFormat(int) - Static method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
A convenience method to create a suitable NumberFormat for writing numbers.
makePoint(double, double) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
makePoint(double, double) - Method in class com.spatial4j.core.context.SpatialContext
Construct a point.
makeRectangle(Point, Point) - Method in class com.spatial4j.core.context.SpatialContext
Construct a rectangle.
makeRectangle(double, double, double, double) - Method in class com.spatial4j.core.context.SpatialContext
Construct a rectangle.
makeRectFromRectangularPoly(Geometry) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
INTERNAL: Returns a Rectangle of the JTS Envelope (bounding box) of the given geom.
makeShape(Geometry, boolean, boolean) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
INTERNAL
makeShape(Geometry) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
INTERNAL: Creates a Shape from a JTS Geometry.
makeShapeFromCoords(String, List) - Method in class com.spatial4j.core.io.GeoJSONReader
 
makeShapeFromCoords(String, List) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
makeShapeFromGeometry(Geometry) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
INTERNAL Usually creates a JtsGeometry, potentially validating, repairing, and indexing ("preparing").
makeSpatialContext(Map<String, String>, ClassLoader) - Static method in class com.spatial4j.core.context.SpatialContextFactory
Creates a new SpatialContext based on configuration in args.
max - Variable in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
MAX_PRECISION - Static variable in class com.spatial4j.core.io.GeohashUtils
 
MILES_TO_KM - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
min - Variable in class com.spatial4j.core.shape.impl.Range
Deprecated.
 

N

newSpatialContext() - Method in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
newSpatialContext() - Method in class com.spatial4j.core.context.SpatialContextFactory
Subclasses should simply construct the instance from the initialized configuration.
newState(String) - Method in class com.spatial4j.core.io.WKTReader
(internal) Creates a new State with the given String.
nextDouble() - Method in class com.spatial4j.core.io.WKTReader.State
Reads in a double from the String.
nextExpect(char) - Method in class com.spatial4j.core.io.WKTReader.State
Verifies that the current character is of the expected value.
nextIf(char) - Method in class com.spatial4j.core.io.WKTReader.State
If the current character is expected, then offset is advanced after it and any subsequent whitespace.
nextIfEmptyAndSkipZM() - Method in class com.spatial4j.core.io.WKTReader.State
Skips over a dimensionality token (e.g.
nextIfWhitespace() - Method in class com.spatial4j.core.io.WKTReader.State
Moves offset to next non-whitespace character.
nextSubShapeString() - Method in class com.spatial4j.core.io.WKTReader.State
Returns the next chunk of text till the next ',' or ')' (non-inclusive) or EOF.
nextWord() - Method in class com.spatial4j.core.io.WKTReader.State
Reads the word starting at the current character position.
normDist(double) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
 
normDist(double) - Method in class com.spatial4j.core.io.WKTReader
Called to normalize a value that isn't X or Y.
normLatDEG(double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Puts in range -90 <= lat_deg <= 90.
normLonDEG(double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Puts in range -180 <= lon_deg <= +180.
normWrapLongitude - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
normX(double) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
normX(double) - Method in class com.spatial4j.core.context.SpatialContext
Normalize the 'x' dimension.
normY(double) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
normY(double) - Method in class com.spatial4j.core.context.SpatialContext
Normalize the 'y' dimension.
number(Object) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 

O

offset - Variable in class com.spatial4j.core.io.WKTReader.State
Offset of the next char in WKTReader.State.rawString to be read.
Overlaps - Static variable in class com.spatial4j.core.SpatialPredicate
Almost meets the "Overlaps" OGC definition, but boundary-neutral (boundary==interior).

P

parse(String) - Method in class com.spatial4j.core.io.WKTReader
Parses the wktString, returning the defined Shape.
parseBufferShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses the BUFFER operation applied to a parsed shape.
parseEnvelopeShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses an ENVELOPE (aka Rectangle) shape from the raw string.
parseGeometryCollectionShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses a GEOMETRYCOLLECTION shape from the raw string.
parseIfSupported(String) - Method in class com.spatial4j.core.io.jts.JtsWKTReaderShapeParser
 
parseIfSupported(String, WKTReader) - Method in class com.spatial4j.core.io.jts.JtsWKTReaderShapeParser
Reads WKT from the str via JTS's WKTReader.
parseIfSupported(String) - Method in class com.spatial4j.core.io.WKTReader
Parses the wktString, returning the defined Shape.
parseLatitudeLongitude(String) - Static method in class com.spatial4j.core.io.ParseUtils
Deprecated.
Extract (by calling ParseUtils.parsePoint(String[], String, int) and validate the latitude and longitude contained in the String by making sure the latitude is between 90 & -90 and longitude is between -180 and 180.
parseLatitudeLongitude(double[], String) - Static method in class com.spatial4j.core.io.ParseUtils
Deprecated.
A variation of ParseUtils.parseLatitudeLongitude(String) that re-uses an output array.
parseLineStringShape(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Bypasses JtsSpatialContext.makeLineString(java.util.List) so that we can more efficiently get the LineString without creating a List<Point>.
parseLineStringShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses a LINESTRING shape from the raw string -- an ordered sequence of points.
parseMulitPolygonShape(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Parses a MULTIPOLYGON shape from the raw string.
parseMultiLineStringShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses a MULTILINESTRING shape from the raw string -- a collection of line strings.
parseMultiPointShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses a MULTIPOINT shape from the raw string -- a collection of points.
parsePoint(String[], String, int) - Static method in class com.spatial4j.core.io.ParseUtils
Deprecated.
Given a string containing dimension values encoded in it, separated by commas, return a String array of length dimension containing the values.
parsePointDouble(double[], String, int) - Static method in class com.spatial4j.core.io.ParseUtils
Deprecated.
Given a string containing dimension values encoded in it, separated by commas, return a double array of length dimension containing the values.
parsePointShape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Parses a POINT shape from the raw string.
parsePolygonShape(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Parses a POLYGON shape from the raw string.
parseShapeByType(WKTReader.State, String) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
 
parseShapeByType(WKTReader.State, String) - Method in class com.spatial4j.core.io.WKTReader
(internal) Parses the remainder of a shape definition following the shape's name given as shapeType already consumed via WKTReader.State.nextWord().
ParseUtils - Class in com.spatial4j.core.io
Deprecated.
Not useful; see https://github.com/spatial4j/spatial4j/issues/19
peek() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
point(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Reads a raw Point (AKA Coordinate) from the current position.
point - Variable in class com.spatial4j.core.shape.impl.CircleImpl
 
Point - Interface in com.spatial4j.core.shape
A Point with X & Y coordinates.
PointImpl - Class in com.spatial4j.core.shape.impl
A basic 2D implementation of a Point.
PointImpl(double, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.PointImpl
A simple constructor without normalization / validation.
pointList(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Reads a list of Points (AKA CoordinateSequence) from the current position.
pointOnBearing(Point, double, double, SpatialContext, Point) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
pointOnBearing(Point, double, double, SpatialContext, Point) - Method in interface com.spatial4j.core.distance.DistanceCalculator
Calculates where a destination point is given an origin (from) distance, and bearing (given in degrees -- 0-360).
pointOnBearing(Point, double, double, SpatialContext, Point) - Method in class com.spatial4j.core.distance.GeodesicSphereDistCalc
 
pointOnBearingRAD(double, double, double, double, SpatialContext, Point) - Static method in class com.spatial4j.core.distance.DistanceUtils
Given a start point (startLat, startLon), distance, and a bearing on a sphere, return the destination point.
POLY - Static variable in interface com.spatial4j.core.io.ShapeIO
 
polygon(WKTReader.State) - Method in class com.spatial4j.core.io.jts.JtsWKTReader
Reads a polygon, returning a JTS polygon.
PolyshapeReader - Class in com.spatial4j.core.io
 
PolyshapeReader(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.PolyshapeReader
 
PolyshapeReader.XReader - Class in com.spatial4j.core.io
from Apache 2.0 licensed: https://github.com/googlemaps/android-maps-utils/blob/master/library/src/com/google/maps/android/PolyUtil.java
PolyshapeWriter - Class in com.spatial4j.core.io
Wrap the 'Encoded Polyline Algorithm Format' defined in: Google Maps API with flags to encode various Shapes: Point, Line, Polygon, etc For more details, see FORMATS.md This format works well for geographic shapes (-180...+180 / -90...+90), but is not appropriate for other coordinate systems
PolyshapeWriter(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.PolyshapeWriter
 
PolyshapeWriter.Encoder - Class in com.spatial4j.core.io
Encodes a sequence of LatLngs into an encoded path string.
precisionModel - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
preparedGeometry - Variable in class com.spatial4j.core.shape.jts.JtsGeometry
 

Q

quadrant(Point) - Method in class com.spatial4j.core.shape.impl.InfBufLine
INTERNAL: AKA lineToPointQuadrant

R

radians2Dist(double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Converts radians (multiples of the radius) to distance in the units of the radius (e.g.
RADIANS_TO_DEGREES - Static variable in class com.spatial4j.core.distance.DistanceUtils
 
radiusDEG - Variable in class com.spatial4j.core.shape.impl.CircleImpl
 
Range - Class in com.spatial4j.core.shape.impl
Deprecated.
Range(double, double) - Constructor for class com.spatial4j.core.shape.impl.Range
Deprecated.
 
Range.LongitudeRange - Class in com.spatial4j.core.shape.impl
Deprecated.
rawString - Variable in class com.spatial4j.core.io.WKTReader.State
read(Reader) - Method in class com.spatial4j.core.io.GeoJSONReader
 
read(Object) - Method in class com.spatial4j.core.io.GeoJSONReader
 
read(Object) - Method in class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
 
read(Reader) - Method in class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
 
read(Object) - Method in class com.spatial4j.core.io.PolyshapeReader
 
read(Reader) - Method in class com.spatial4j.core.io.PolyshapeReader
 
read(Object) - Method in interface com.spatial4j.core.io.ShapeReader
 
read(Reader) - Method in interface com.spatial4j.core.io.ShapeReader
Read a Shape from the reader.
read(String) - Method in class com.spatial4j.core.io.SupportedFormats
 
read(Reader) - Method in class com.spatial4j.core.io.WKTReader
 
read(Object) - Method in class com.spatial4j.core.io.WKTReader
 
readCircle(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readCircle(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readCollection(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readCoord(JSONParser) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
readCoordinates(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readCoordList(JSONParser) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
readCoordListXY(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readCoordXY(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readDim(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readDim(DataInput) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
readDistance(String, String, JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
Helper method to read a up until a distance value (radius, buffer) and it's corresponding unit are found.
readDouble() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readers - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
readIfSupported(Object) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readIfSupported(Object) - Method in class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
 
readIfSupported(Object) - Method in class com.spatial4j.core.io.PolyshapeReader
 
readIfSupported(Object) - Method in interface com.spatial4j.core.io.ShapeReader
 
readIfSupported(Object) - Method in class com.spatial4j.core.io.WKTReader
 
readJtsGeom(DataInput) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
readKey() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readLat() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readLineString(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readLng() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readPoint(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readPoint(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readPoint(JSONParser) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
readPoints(SpatialContext) - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readPoints() - Method in class com.spatial4j.core.io.PolyshapeReader.XReader
 
readPolygon(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
This method takes a polygon and makes a bbox from it NOTE: not currently used! polygon is currently implemented in: GeoJSONReader.makeShapeFromCoords(String, List) We could add a 'strict' or 'leinent' mode that would try the best it can
readPolygon(JSONParser) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONReader
 
readPolygon(PolyshapeReader.XReader) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeReader
 
readPolygon(PolyshapeReader.XReader) - Method in class com.spatial4j.core.io.PolyshapeReader
 
readRect(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readShape(String) - Method in class com.spatial4j.core.context.SpatialContext
Deprecated.
readShape(DataInput) - Method in class com.spatial4j.core.io.BinaryCodec
 
readShape(JSONParser) - Method in class com.spatial4j.core.io.GeoJSONReader
 
readShapeByTypeIfSupported(DataInput, byte) - Method in class com.spatial4j.core.io.BinaryCodec
 
readShapeByTypeIfSupported(DataInput, byte) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
readShapeFromWkt(String) - Method in class com.spatial4j.core.context.SpatialContext
Deprecated.
readShapeOrNull(String, SpatialContext) - Static method in class com.spatial4j.core.io.LegacyShapeReader
Deprecated.
Reads the shape specification as defined in the class javadocs.
readUntilEvent(JSONParser, int) - Method in class com.spatial4j.core.io.GeoJSONReader
 
Rectangle - Interface in com.spatial4j.core.shape
A rectangle aligned with the axis (i.e.
RectangleImpl - Class in com.spatial4j.core.shape.impl
A simple Rectangle implementation that also supports a longitudinal wrap-around.
RectangleImpl(double, double, double, double, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.RectangleImpl
A simple constructor without normalization / validation.
RectangleImpl(Point, Point, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.RectangleImpl
A convenience constructor which pulls out the coordinates.
RectangleImpl(Rectangle, SpatialContext) - Constructor for class com.spatial4j.core.shape.impl.RectangleImpl
Copy constructor.
register(String) - Method in class com.spatial4j.core.SpatialPredicate
 
relate(Shape) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
relate(Rectangle) - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
relate(Shape) - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
relate(Shape) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
relate(Point) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
relate(Rectangle) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
relate(Circle) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
relate(Shape) - Method in class com.spatial4j.core.shape.impl.PointImpl
 
relate(Shape) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
relate(Point) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
relate(Rectangle) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
relate(Shape) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(Point) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(Rectangle) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(Circle) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(JtsGeometry) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(Geometry) - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
relate(Shape) - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
relate(Shape) - Method in interface com.spatial4j.core.shape.Shape
Describe the relationship between the two objects.
relate(Shape) - Method in class com.spatial4j.core.shape.ShapeCollection
 
relateContainsShortCircuits() - Method in class com.spatial4j.core.shape.ShapeCollection
Called by relate() to determine whether to return early if it finds CONTAINS, instead of checking the remaining shapes.
relateRectanglePhase2(Rectangle, SpatialRelation) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
relateRectanglePhase2(Rectangle, SpatialRelation) - Method in class com.spatial4j.core.shape.impl.GeoCircle
Called after bounding box is intersected.
relateXRange(double, double) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
relateXRange(double, double) - Method in interface com.spatial4j.core.shape.Rectangle
A specialization of Shape.relate(Shape) for a horizontal line.
relateYRange(double, double) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
relateYRange(double, double) - Method in interface com.spatial4j.core.shape.Rectangle
A specialization of Shape.relate(Shape) for a vertical line.
reset(double, double, double) - Method in interface com.spatial4j.core.shape.Circle
Expert: Resets the state of this shape given the arguments.
reset(double, double, double) - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
reset(double, double, double) - Method in class com.spatial4j.core.shape.impl.GeoCircle
 
reset(double, double) - Method in class com.spatial4j.core.shape.impl.PointImpl
 
reset(double, double, double, double) - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
reset(double, double) - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
reset(double, double) - Method in interface com.spatial4j.core.shape.Point
Expert: Resets the state of this shape given the arguments.
reset(double, double, double, double) - Method in interface com.spatial4j.core.shape.Rectangle
Expert: Resets the state of this shape given the arguments.

S

seperator() - Method in class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
shape(WKTReader.State) - Method in class com.spatial4j.core.io.WKTReader
Reads a shape from the current position, starting with the name of the shape.
Shape - Interface in com.spatial4j.core.shape
The base interface defining a geometric shape.
ShapeCollection<S extends Shape> - Class in com.spatial4j.core.shape
A collection of Shape objects, analogous to an OGC GeometryCollection.
ShapeCollection(List<S>, SpatialContext) - Constructor for class com.spatial4j.core.shape.ShapeCollection
WARNING: shapes is copied by reference.
ShapeIO - Interface in com.spatial4j.core.io
 
ShapeReader - Interface in com.spatial4j.core.io
Implementations are expected to be thread safe
shapes - Variable in class com.spatial4j.core.shape.ShapeCollection
 
ShapeWriter - Interface in com.spatial4j.core.io
Implementations are expected to be thread safe
SIN_45_AS_RADS - Static variable in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
size() - Method in class com.spatial4j.core.shape.ShapeCollection
 
skipDouble() - Method in class com.spatial4j.core.io.WKTReader.State
Advances offset forward until it points to a character that isn't part of a number.
skipNextDoubles() - Method in class com.spatial4j.core.io.WKTReader.State
Advances past as many doubles as there are, with intervening whitespace.
SpatialContext - Class in com.spatial4j.core.context
This is a facade to most of Spatial4j, holding things like DistanceCalculator, ShapeIO, and acting as a factory for the Shapes.
SpatialContext(boolean, DistanceCalculator, Rectangle) - Constructor for class com.spatial4j.core.context.SpatialContext
Deprecated.
SpatialContext(boolean) - Constructor for class com.spatial4j.core.context.SpatialContext
Deprecated.
SpatialContext(SpatialContextFactory) - Constructor for class com.spatial4j.core.context.SpatialContext
SpatialContextFactory - Class in com.spatial4j.core.context
Factory for a SpatialContext based on configuration data.
SpatialContextFactory() - Constructor for class com.spatial4j.core.context.SpatialContextFactory
 
SpatialPredicate - Class in com.spatial4j.core
A predicate that compares a stored geometry to a supplied geometry.
SpatialPredicate(String) - Constructor for class com.spatial4j.core.SpatialPredicate
 
SpatialRelation - Enum in com.spatial4j.core.shape
The set of spatial relationships.
srid - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
startRing() - Method in class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
State(String) - Constructor for class com.spatial4j.core.io.WKTReader.State
 
SupportedFormats - Class in com.spatial4j.core.io
Information about the formats a SpatialContext can read/write
SupportedFormats(List<ShapeReader>, List<ShapeWriter>) - Constructor for class com.spatial4j.core.io.SupportedFormats
 
SYSPROP_ASSERT_VALIDATE - Static variable in class com.spatial4j.core.shape.jts.JtsGeometry
System property boolean that can disable auto validation in an assert.

T

toDegrees(double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Same as Math.toDegrees(double) but 3x faster (multiply vs.
toRadians(double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Same as Math.toRadians(double) but 3x faster (multiply vs.
toString(Shape) - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
toString() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
 
toString(Shape) - Method in class com.spatial4j.core.context.SpatialContext
Deprecated.
toString() - Method in class com.spatial4j.core.context.SpatialContext
 
toString() - Method in class com.spatial4j.core.distance.AbstractDistanceCalculator
 
toString(Shape) - Method in class com.spatial4j.core.io.GeoJSONWriter
 
toString(Shape) - Method in class com.spatial4j.core.io.jts.JtsWKTWriter
 
toString(Shape) - Method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
 
toString(Shape) - Method in class com.spatial4j.core.io.PolyshapeWriter
 
toString(Shape) - Method in interface com.spatial4j.core.io.ShapeWriter
Write a shape to String
toString(Shape) - Method in class com.spatial4j.core.io.WKTWriter
 
toString() - Method in class com.spatial4j.core.shape.impl.BufferedLine
 
toString() - Method in class com.spatial4j.core.shape.impl.BufferedLineString
 
toString() - Method in class com.spatial4j.core.shape.impl.CircleImpl
 
toString() - Method in class com.spatial4j.core.shape.impl.GeoCircle
 
toString() - Method in class com.spatial4j.core.shape.impl.InfBufLine
 
toString() - Method in class com.spatial4j.core.shape.impl.PointImpl
 
toString() - Method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
toString() - Method in class com.spatial4j.core.shape.impl.RectangleImpl
 
toString() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
 
toString() - Method in class com.spatial4j.core.shape.jts.JtsPoint
 
toString() - Method in class com.spatial4j.core.shape.ShapeCollection
 
toString() - Method in class com.spatial4j.core.SpatialPredicate
 
transpose() - Method in enum com.spatial4j.core.shape.SpatialRelation
Given the result of shapeA.relate(shapeB), transposing that result should yield the result of shapeB.relate(shapeA).
TYPE_CIRCLE - Static variable in class com.spatial4j.core.io.BinaryCodec
 
TYPE_COLL - Static variable in class com.spatial4j.core.io.BinaryCodec
 
TYPE_GEOM - Static variable in class com.spatial4j.core.io.BinaryCodec
 
TYPE_POINT - Static variable in class com.spatial4j.core.io.BinaryCodec
 
TYPE_RECT - Static variable in class com.spatial4j.core.io.BinaryCodec
 
typeForShape(Shape) - Method in class com.spatial4j.core.io.BinaryCodec
 
typeForShape(Shape) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 

U

UnsupportedSpatialPredicate - Exception in com.spatial4j.core.exception
Exception thrown when the org.apache.lucene.spatial.SpatialStrategy cannot implement the requested operation.
UnsupportedSpatialPredicate(SpatialPredicate) - Constructor for exception com.spatial4j.core.exception.UnsupportedSpatialPredicate
 
useFloat - Variable in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
useJtsLineString - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
useJtsLineString() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
useJtsLineString - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
useJtsPoint - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
useJtsPoint() - Method in class com.spatial4j.core.context.jts.JtsSpatialContext
useJtsPoint - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 

V

validate() - Method in class com.spatial4j.core.shape.jts.JtsGeometry
Validates the shape, throwing a descriptive error if it isn't valid.
validated - Variable in class com.spatial4j.core.shape.jts.JtsGeometry
 
validationRule - Variable in class com.spatial4j.core.context.jts.JtsSpatialContext
 
validationRule - Variable in class com.spatial4j.core.context.jts.JtsSpatialContextFactory
 
ValidationRule - Enum in com.spatial4j.core.context.jts
Indicates how JTS geometries (notably polygons but applies to other geometries too) are validated (if at all) and repaired (if at all).
valueOf(String) - Static method in enum com.spatial4j.core.context.jts.DatelineRule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spatial4j.core.context.jts.ValidationRule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spatial4j.core.shape.SpatialRelation
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.spatial4j.core.context.jts.DatelineRule
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spatial4j.core.context.jts.ValidationRule
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spatial4j.core.shape.SpatialRelation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.spatial4j.core.SpatialPredicate
 
vectorBoxCorner(double[], double[], double, boolean) - Static method in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
vectorDistance(double[], double[], double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
vectorDistance(double[], double[], double, double) - Static method in class com.spatial4j.core.distance.DistanceUtils
Deprecated.
verifyX(double) - Method in class com.spatial4j.core.context.SpatialContext
verifyY(double) - Method in class com.spatial4j.core.context.SpatialContext
Vincenty() - Constructor for class com.spatial4j.core.distance.GeodesicSphereDistCalc.Vincenty
 

W

within(Point, double, double, double) - Method in class com.spatial4j.core.distance.AbstractDistanceCalculator
 
within(Point, double, double, double) - Method in class com.spatial4j.core.distance.CartesianDistCalc
 
within(Point, double, double, double) - Method in interface com.spatial4j.core.distance.DistanceCalculator
Returns true if the distance between from and to is <= distance.
WKT - Static variable in interface com.spatial4j.core.io.ShapeIO
 
WKTReader - Class in com.spatial4j.core.io
An extensible parser for Well Known Text (WKT).
WKTReader(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.WKTReader
This constructor is required by com.spatial4j.core.context.SpatialContextFactory#makeWktShapeParser(com.spatial4j.core.context.SpatialContext) .
WKTReader.State - Class in com.spatial4j.core.io
The parse state.
WktShapeParser - Class in com.spatial4j.core.io
Deprecated.
WktShapeParser(SpatialContext, SpatialContextFactory) - Constructor for class com.spatial4j.core.io.WktShapeParser
Deprecated.
This constructor is required by com.spatial4j.core.context.SpatialContextFactory#makeWktShapeParser(com.spatial4j.core.context.SpatialContext).
WKTWriter - Class in com.spatial4j.core.io
 
WKTWriter() - Constructor for class com.spatial4j.core.io.WKTWriter
 
WORLD_180E180W - Static variable in class com.spatial4j.core.shape.impl.Range.LongitudeRange
Deprecated.
 
worldBounds - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
write(Writer, NumberFormat, double...) - Method in class com.spatial4j.core.io.GeoJSONWriter
 
write(Writer, Shape) - Method in class com.spatial4j.core.io.GeoJSONWriter
 
write(Writer, NumberFormat, Coordinate) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(Writer, NumberFormat, CoordinateSequence) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(Writer, NumberFormat, Coordinate[]) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(Writer, NumberFormat, Polygon) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(Writer, Geometry) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(Writer, Shape) - Method in class com.spatial4j.core.io.jts.JtsGeoJSONWriter
 
write(PolyshapeWriter.Encoder, CoordinateSequence) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
write(PolyshapeWriter.Encoder, Coordinate[]) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
write(PolyshapeWriter.Encoder, Polygon) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
write(PolyshapeWriter.Encoder, Geometry) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
write(PolyshapeWriter.Encoder, Shape) - Method in class com.spatial4j.core.io.jts.JtsPolyshapeWriter
 
write(Writer, Shape) - Method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
 
write(char) - Method in class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
write(double, double) - Method in class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
write(Writer, Shape) - Method in class com.spatial4j.core.io.PolyshapeWriter
 
write(PolyshapeWriter.Encoder, Shape) - Method in class com.spatial4j.core.io.PolyshapeWriter
 
write(Writer, Shape) - Method in interface com.spatial4j.core.io.ShapeWriter
Write a shape to the output writer
write(Writer, Shape) - Method in class com.spatial4j.core.io.WKTWriter
 
writeArg(double) - Method in class com.spatial4j.core.io.PolyshapeWriter.Encoder
 
writeCircle(DataOutput, Circle) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeCollection(DataOutput, ShapeCollection) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeDim(DataOutput, double) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeDim(DataOutput, double) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
writeJtsGeom(DataOutput, Shape) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 
writePoint(DataOutput, Point) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeRect(DataOutput, Rectangle) - Method in class com.spatial4j.core.io.BinaryCodec
 
writers - Variable in class com.spatial4j.core.context.SpatialContextFactory
 
writeShape(DataOutput, Shape) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeShape(Shape) - Static method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
Writes a shape to a String, in a format that can be read by #readShapeOrNull(String, com.spatial4j.core.context.SpatialContext).
writeShape(Shape, NumberFormat) - Static method in class com.spatial4j.core.io.LegacyShapeWriter
Deprecated.
Overloaded to provide a number format.
writeShapeByTypeIfSupported(DataOutput, Shape) - Method in class com.spatial4j.core.io.BinaryCodec
Note: writes the type byte even if not supported
writeShapeByTypeIfSupported(DataOutput, Shape, byte) - Method in class com.spatial4j.core.io.BinaryCodec
 
writeShapeByTypeIfSupported(DataOutput, Shape, byte) - Method in class com.spatial4j.core.io.jts.JtsBinaryCodec
 

X

xRange(Rectangle, SpatialContext) - Static method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
XReader(Reader) - Constructor for class com.spatial4j.core.io.PolyshapeReader.XReader
 

Y

yRange(Rectangle, SpatialContext) - Static method in class com.spatial4j.core.shape.impl.Range
Deprecated.
 
A B C D E G H I J K L M N O P Q R S T U V W X Y 
Skip navigation links

Copyright © 2017. All rights reserved.