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

Packages that use Shape

Package	Description
org.apache.lucene.spatial
org.apache.lucene.spatial.prefix
org.apache.lucene.spatial.prefix.tree
org.apache.lucene.spatial.query
org.apache.lucene.spatial.util
org.elasticsearch.common.geo
org.elasticsearch.common.geo.builders
org.elasticsearch.index.mapper
org.locationtech.spatial4j.context
org.locationtech.spatial4j.context.jts
org.locationtech.spatial4j.io
org.locationtech.spatial4j.io.jts
org.locationtech.spatial4j.shape
org.locationtech.spatial4j.shape.impl
org.locationtech.spatial4j.shape.jts

Uses of Shape in org.apache.lucene.spatial

Methods in org.apache.lucene.spatial with parameters of type Shape

Modifier and Type	Method	Description
abstract Field[]	SpatialStrategy.createIndexableFields(Shape shape)	Returns the IndexableField(s) from the shape that are to be added to the Document.
DoubleValuesSource	SpatialStrategy.makeRecipDistanceValueSource(Shape queryShape)	Returns a ValueSource with values ranging from 1 to 0, depending inversely on the distance from SpatialStrategy.makeDistanceValueSource(org.locationtech.spatial4j.shape.Point,double).

Uses of Shape in org.apache.lucene.spatial.prefix

Fields in org.apache.lucene.spatial.prefix declared as Shape

Modifier and Type	Field	Description
protected Shape	AbstractPrefixTreeQuery.queryShape

Methods in org.apache.lucene.spatial.prefix that return Shape

Modifier and Type	Method	Description
protected Shape	WithinPrefixTreeQuery.bufferShape(Shape shape, double distErr)	Returns a new shape that is larger than shape by at distErr.

Methods in org.apache.lucene.spatial.prefix with parameters of type Shape

Modifier and Type	Method	Description
protected Shape	WithinPrefixTreeQuery.bufferShape(Shape shape, double distErr)	Returns a new shape that is larger than shape by at distErr.
static HeatmapFacetCounter.Heatmap	HeatmapFacetCounter.calcFacets(PrefixTreeStrategy strategy, IndexReaderContext context, Bits topAcceptDocs, Shape inputShape, int facetLevel, int maxCells)	Calculates spatial 2D facets (aggregated counts) in a grid, sometimes called a heatmap.
HeatmapFacetCounter.Heatmap	PrefixTreeStrategy.calcFacets(IndexReaderContext context, Bits topAcceptDocs, Shape inputShape, int facetLevel, int maxCells)	Computes spatial facets in two dimensions as a grid of numbers.
static void	PrefixTreeFacetCounter.compute(PrefixTreeStrategy strategy, IndexReaderContext context, Bits topAcceptDocs, Shape queryShape, int facetLevel, PrefixTreeFacetCounter.FacetVisitor facetVisitor)	Computes facets using a callback/visitor style design, allowing flexibility for the caller to determine what to do with each underlying count.
static void	PrefixTreeFacetCounter.compute(PrefixTreeStrategy strategy, LeafReaderContext context, Bits acceptDocs, Shape queryShape, int facetLevel, PrefixTreeFacetCounter.FacetVisitor facetVisitor)	Lower-level per-leaf segment method.
protected Iterator<Cell>	PrefixTreeStrategy.createCellIteratorToIndex(Shape shape, int detailLevel, Iterator<Cell> reuse)
protected Iterator<Cell>	RecursivePrefixTreeStrategy.createCellIteratorToIndex(Shape shape, int detailLevel, Iterator<Cell> reuse)
Field[]	PrefixTreeStrategy.createIndexableFields(Shape shape)
Field[]	PrefixTreeStrategy.createIndexableFields(Shape shape, double distErr)	Turns SpatialPrefixTree.getTreeCellIterator(Shape, int) into a TokenStream.
Field[]	PrefixTreeStrategy.createIndexableFields(Shape shape, int detailLevel)
protected boolean	RecursivePrefixTreeStrategy.isGridAlignedShape(Shape shape)	A quick check of the shape to see if it is perfectly aligned to a grid.
protected boolean	PrefixTreeStrategy.isPointShape(Shape shape)	Returns true if the shape is a Point.
protected Query	RecursivePrefixTreeStrategy.makeGridShapeIntersectsQuery(Shape gridShape)	RecursivePrefixTreeStrategy.makeQuery(SpatialArgs) specialized for the query being a grid square.
void	PrefixTreeStrategy.ShapeTokenStream.setShape(Shape shape)

Constructors in org.apache.lucene.spatial.prefix with parameters of type Shape

Constructor	Description
AbstractPrefixTreeQuery(Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel)
AbstractVisitingPrefixTreeQuery(Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel)
ContainsPrefixTreeQuery(Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel, boolean multiOverlappingIndexedShapes)
IntersectsPrefixTreeQuery(Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel)
WithinPrefixTreeQuery(Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel, double queryBuffer)	See AbstractVisitingPrefixTreeQuery(org.locationtech.spatial4j.shape.Shape, String, org.apache.lucene.spatial.prefix.tree.SpatialPrefixTree, int, int).

Uses of Shape in org.apache.lucene.spatial.prefix.tree

Fields in org.apache.lucene.spatial.prefix.tree declared as Shape

Modifier and Type	Field	Description
protected Shape	LegacyCell.shape

Methods in org.apache.lucene.spatial.prefix.tree that return Shape

Modifier and Type	Method	Description
Shape	S2ShapeFactory.getS2CellShape(S2CellId cellId)	Factory method for S2 cell shapes.
Shape	Cell.getShape()	Gets the shape for this cell; typically a Rectangle.
Shape	QuadPrefixTree.QuadCell.getShape()

Methods in org.apache.lucene.spatial.prefix.tree with parameters of type Shape

Modifier and Type	Method	Description
protected void	PackedQuadPrefixTree.buildNotRobustly(double x, double y, int level, List<Cell> matches, long term, Shape shape, int maxLevel)
protected void	PackedQuadPrefixTree.checkBattenbergNotRobustly(byte quad, double cx, double cy, int level, List<Cell> matches, long term, Shape shape, int maxLevel)
protected void	QuadPrefixTree.checkBattenbergNotRobustly(char c, double cx, double cy, int level, List<Cell> matches, BytesRef str, Shape shape, int maxLevel)
CellIterator	Cell.getNextLevelCells(Shape shapeFilter)	Gets the cells at the next grid cell level underneath this one, optionally filtered by shapeFilter.
CellIterator	LegacyCell.getNextLevelCells(Shape shapeFilter)
CellIterator	PackedQuadPrefixTree.getTreeCellIterator(Shape shape, int detailLevel)
CellIterator	S2PrefixTree.getTreeCellIterator(Shape shape, int detailLevel)
CellIterator	SpatialPrefixTree.getTreeCellIterator(Shape shape, int detailLevel)	Gets the intersecting cells for the specified shape, without exceeding detail level.

Uses of Shape in org.apache.lucene.spatial.query

Methods in org.apache.lucene.spatial.query that return Shape

Modifier and Type	Method	Description
Shape	SpatialArgs.getShape()
protected Shape	SpatialArgsParser.parseShape(String str, SpatialContext ctx)

Methods in org.apache.lucene.spatial.query with parameters of type Shape

Modifier and Type	Method	Description
static double	SpatialArgs.calcDistanceFromErrPct(Shape shape, double distErrPct, SpatialContext ctx)	Computes the distance given a shape and the distErrPct.
abstract boolean	SpatialOperation.evaluate(Shape indexedShape, Shape queryShape)	Returns whether the relationship between indexedShape and queryShape is satisfied by this operation.
protected SpatialArgs	SpatialArgsParser.newSpatialArgs(SpatialOperation op, Shape shape)
void	SpatialArgs.setShape(Shape shape)

Constructors in org.apache.lucene.spatial.query with parameters of type Shape

Constructor	Description
SpatialArgs(SpatialOperation operation, Shape shape)

Uses of Shape in org.apache.lucene.spatial.util

Classes in org.apache.lucene.spatial.util with type parameters of type Shape

Modifier and Type	Class	Description
class	ShapeFieldCache<T extends Shape>	Bounded Cache of Shapes associated with docIds.
class	ShapeFieldCacheProvider<T extends Shape>	Provides access to a ShapeFieldCache for a given LeafReader.

Uses of Shape in org.elasticsearch.common.geo

Classes in org.elasticsearch.common.geo with type parameters of type Shape

Modifier and Type	Class	Description
class	XShapeCollection<S extends Shape>	Extends spatial4j ShapeCollection for points_only shape indexing support

Classes in org.elasticsearch.common.geo that implement Shape

Modifier and Type	Class	Description
class	XShapeCollection<S extends Shape>	Extends spatial4j ShapeCollection for points_only shape indexing support

Uses of Shape in org.elasticsearch.common.geo.builders

Classes in org.elasticsearch.common.geo.builders with type parameters of type Shape

Modifier and Type	Class	Description
class	ShapeBuilder<T extends Shape,G extends Geometry,E extends ShapeBuilder<T,G,E>>	Basic class for building GeoJSON shapes like Polygons, Linestrings, etc

Methods in org.elasticsearch.common.geo.builders that return Shape

Modifier and Type	Method	Description
Shape	GeometryCollectionBuilder.buildS4J()
Shape	MultiPolygonBuilder.buildS4J()

Uses of Shape in org.elasticsearch.index.mapper

Methods in org.elasticsearch.index.mapper that return Shape

Modifier and Type	Method	Description
Shape	LegacyGeoShapeIndexer.prepareForIndexing(ShapeBuilder<?,?,?> shapeBuilder)

Methods in org.elasticsearch.index.mapper that return types with arguments of type Shape

Modifier and Type	Method	Description
Class<Shape>	LegacyGeoShapeIndexer.processedClass()

Methods in org.elasticsearch.index.mapper with parameters of type Shape

Modifier and Type	Method	Description
List<IndexableField>	LegacyGeoShapeIndexer.indexShape(ParseContext context, Shape shape)

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(List<S> coll)	Deprecated.

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

Modifier and Type	Method	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.

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

Modifier and Type	Method	Description
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(Geometry geom)	Deprecated.

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

Modifier and Type	Method	Description
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(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	GeoJSONReader.read(Reader reader)
Shape	GeoJSONReader.read(Object value)
Shape	LegacyShapeReader.read(Reader reader)	Deprecated.
Shape	LegacyShapeReader.read(Object value)	Deprecated.
Shape	PolyshapeReader.read(Reader r)
Shape	PolyshapeReader.read(Object value)
Shape	ShapeReader.read(Reader reader)	Read a Shape from the reader.
Shape	ShapeReader.read(Object value)
Shape	SupportedFormats.read(String value)
Shape	WKTReader.read(Reader reader)
Shape	WKTReader.read(Object value)
Shape	GeoJSONReader.readIfSupported(Object value)
Shape	LegacyShapeReader.readIfSupported(Object value)	Deprecated.
Shape	PolyshapeReader.readIfSupported(Object value)
Shape	ShapeReader.readIfSupported(Object value)
Shape	WKTReader.readIfSupported(Object value)
protected Shape	GeoJSONReader.readLineString(JSONParser parser)
protected Shape	GeoJSONReader.readMultiLineString(JSONParser parser)
protected Shape	GeoJSONReader.readMultiPoint(JSONParser parser)
protected Shape	GeoJSONReader.readMultiPolygon(JSONParser parser)
protected Shape	GeoJSONReader.readPoint(JSONParser parser)
protected Shape	PolyshapeReader.readPolygon(PolyshapeReader.XReader reader)
Shape	BinaryCodec.readShape(DataInput dataInput)
protected Shape	GeoJSONReader.readShape(JSONParser parser)
protected Shape	BinaryCodec.readShapeByTypeIfSupported(DataInput dataInput, byte type)
protected Shape	GeoJSONReader.readShapeFromCoordinates(String type, 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.

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

Modifier and Type	Method	Description
String	GeoJSONWriter.toString(Shape shape)
String	LegacyShapeWriter.toString(Shape shape)	Deprecated.
String	PolyshapeWriter.toString(Shape shape)
String	ShapeWriter.toString(Shape shape)	Write a shape to String
String	WKTWriter.toString(Shape shape)
protected byte	BinaryCodec.typeForShape(Shape s)
void	GeoJSONWriter.write(Writer output, Shape shape)
void	LegacyShapeWriter.write(Writer output, Shape shape)	Deprecated.
void	PolyshapeWriter.write(Writer output, Shape shape)
void	PolyshapeWriter.write(PolyshapeWriter.Encoder enc, Shape shape)
void	ShapeWriter.write(Writer output, Shape shape)	Write a shape to the output writer
void	WKTWriter.write(Writer output, Shape shape)
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)

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	JtsBinaryCodec.readJtsGeom(DataInput dataInput)
protected Shape	JtsBinaryCodec.readShapeByTypeIfSupported(DataInput dataInput, byte type)

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

Modifier and Type	Method	Description
String	JtsWKTWriter.toString(Shape shape)
protected byte	JtsBinaryCodec.typeForShape(Shape s)
void	JtsGeoJSONWriter.write(Writer output, Shape shape)
void	JtsPolyshapeWriter.write(PolyshapeWriter.Encoder enc, Shape shape)
void	JtsBinaryCodec.writeJtsGeom(DataOutput dataOutput, Shape s)
protected boolean	JtsBinaryCodec.writeShapeByTypeIfSupported(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(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(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(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(Collection<? extends Shape> shapes, SpatialContext ctx)
protected static boolean	ShapeCollection.computeMutualDisjoint(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 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(Class<T> shapeClass)
<S extends Shape> ShapeCollection<S>	ShapeFactoryImpl.multiShape(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(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 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(Class<T> shapeClass)

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

Modifier and Type	Method	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").

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

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