java.lang.Object
- org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl
- - org.locationtech.spatial4j.shape.jts.JtsShapeFactory

All Implemented Interfaces:

ShapeFactory
```
public class JtsShapeFactory
extends ShapeFactoryImpl
```
Enhances ShapeFactoryImpl with support for Polygons using JTS. To the extent possible, our JtsGeometry adds some amount of geodetic support over vanilla JTS which only has a Euclidean (flat plane) model.

Nested Class Summary
- Nested classes/interfaces inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl
  ShapeFactoryImpl.GeneralShapeMultiShapeBuilder<T extends Shape>
- Nested classes/interfaces inherited from interface org.locationtech.spatial4j.shape.ShapeFactory
  ShapeFactory.LineStringBuilder, ShapeFactory.MultiLineStringBuilder, ShapeFactory.MultiPointBuilder, ShapeFactory.MultiPolygonBuilder, ShapeFactory.MultiShapeBuilder<T extends Shape>, ShapeFactory.PointsBuilder<T>, ShapeFactory.PolygonBuilder

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`allowMultiOverlap`
`protected boolean`	`autoIndex`
`protected DatelineRule`	`datelineRule`
`protected static LinearRing[]`	`EMPTY_HOLES`
`protected GeometryFactory`	`geometryFactory`
`protected boolean`	`useJtsLineString`
`protected boolean`	`useJtsMulti`
`protected boolean`	`useJtsPoint`
`protected ValidationRule`	`validationRule`

Fields inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl
ctx

Constructor Summary

Constructors
Constructor Description

JtsShapeFactory(JtsSpatialContext ctx, JtsSpatialContextFactory factory)
Called by JtsSpatialContextFactory.newSpatialContext().

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DatelineRule`	`getDatelineRule()`	Returns the rule used to handle geometry objects that have dateline (aka anti-meridian) crossing considerations.
`GeometryFactory`	`getGeometryFactory()`
`Geometry`	`getGeometryFrom(Shape shape)`	Gets a JTS `Geometry` for the given `Shape`.
`ValidationRule`	`getValidationRule()`	Returns the rule used to handle errors when creating a JTS `Geometry`, particularly after it has been read from one of the `ShapeReader`s.
`boolean`	`isAllowMultiOverlap()`	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.
`boolean`	`isAutoIndex()`	If JtsGeometry shapes should be automatically "prepared" (i.e.
`ShapeFactory.LineStringBuilder`	`lineString()`	(Builder) Constructs a line string, with a possible buffer.
`Shape`	`lineString(List<Point> points, double bufferDistance)`	Constructs a line string with a possible buffer.
`Rectangle`	`makeRectFromRectangularPoly(Geometry geom)`	INTERNAL: Returns a Rectangle of the JTS `Envelope` (bounding box) of the given `geom`.
`JtsGeometry`	`makeShape(Geometry geom)`	INTERNAL: Creates a `Shape` from a JTS `Geometry`.
`JtsGeometry`	`makeShape(Geometry geom, boolean dateline180Check, boolean allowMultiOverlap)`	INTERNAL
`Shape`	`makeShapeFromGeometry(Geometry geom)`	INTERNAL Usually creates a JtsGeometry, potentially validating, repairing, and indexing ("preparing").
`ShapeFactory.MultiLineStringBuilder`	`multiLineString()`	(Builder) Constructs a MultiLineString, or possibly the result of that buffered.
`ShapeFactory.MultiPointBuilder`	`multiPoint()`	(Builder) Constructs a MultiPoint.
`ShapeFactory.MultiPolygonBuilder`	`multiPolygon()`	(Builder) Constructs a MultiPolygon.
`<T extends Shape> ShapeFactory.MultiShapeBuilder<T>`	`multiShape(Class<T> shapeClass)`	(Builder) Constructs a Shape aggregate in which each component/member is an instance of the specified class.
`double`	`normDist(double d)`	Called to normalize a value that isn't X or Y or Z.
`double`	`normX(double x)`	Normalize the 'x' dimension.
`double`	`normY(double y)`
`double`	`normZ(double z)`	(disclaimer: the Z dimension isn't fully supported)
`Point`	`pointXY(double x, double y)`	Construct a point.
`Point`	`pointXYZ(double x, double y, double z)`	Construct a point of 3 dimensions.
`ShapeFactory.PolygonBuilder`	`polygon()`	(Builder) Constructs a polygon.
`boolean`	`useJtsLineString()`	Should `lineString(java.util.List,double)` return `JtsGeometry`?
`boolean`	`useJtsMulti()`	Whether `multiPoint()`, `multiLineString()`, and `multiPolygon()` should all use JTS's subclasses of `GeometryCollection` instead of Spatial4j's basic impl.
`boolean`	`useJtsPoint()`	Should `pointXY(double, double)` return `JtsPoint`?

Methods inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl
circle, circle, getSpatialContext, isNormWrapLongitude, multiShape, rect, rect, verifyX, verifyY, verifyZ

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY_HOLES
```
protected static final LinearRing[] EMPTY_HOLES
```
  - geometryFactory
```
protected final GeometryFactory geometryFactory
```
  - allowMultiOverlap
```
protected final boolean allowMultiOverlap
```
  - useJtsPoint
```
protected final boolean useJtsPoint
```
  - useJtsLineString
```
protected final boolean useJtsLineString
```
  - useJtsMulti
```
protected final boolean useJtsMulti
```
  - datelineRule
```
protected final DatelineRule datelineRule
```
  - validationRule
```
protected final ValidationRule validationRule
```
  - autoIndex
```
protected final boolean autoIndex
```
- Constructor Detail
  - JtsShapeFactory
```
public JtsShapeFactory(JtsSpatialContext ctx,
                       JtsSpatialContextFactory factory)
```
    Called by JtsSpatialContextFactory.newSpatialContext().
- Method Detail
  - isAllowMultiOverlap
```
public boolean isAllowMultiOverlap()
```
    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. Note: Our ShapeCollection mostly doesn't care but it has a method related to this ShapeCollection.relateContainsShortCircuits().
  - getDatelineRule
```
public DatelineRule getDatelineRule()
```
    Returns the rule used to handle geometry objects that have dateline (aka anti-meridian) crossing considerations.
  - getValidationRule
```
public ValidationRule getValidationRule()
```
    Returns the rule used to handle errors when creating a JTS Geometry, particularly after it has been read from one of the ShapeReaders.
  - isAutoIndex
```
public boolean isAutoIndex()
```
    If JtsGeometry shapes should be automatically "prepared" (i.e. optimized) when read via from a ShapeReader.
    
    See Also:
    
    JtsGeometry.index()
  - normX
```
public double normX(double x)
```
    Description copied from interface: ShapeFactory
    
    Normalize the 'x' dimension. Might reduce precision or wrap it to be within the bounds. This is called by ShapeReaders before creating a shape.
    
    Specified by:
    
    normX in interface ShapeFactory
    
    Overrides:
    
    normX in class ShapeFactoryImpl
  - normY
```
public double normY(double y)
```
    Specified by:
    
    normY in interface ShapeFactory
    
    Overrides:
    
    normY in class ShapeFactoryImpl
    
    See Also:
    
    ShapeFactory.normX(double)
  - normZ
```
public double normZ(double z)
```
    Description copied from interface: ShapeFactory
    
    (disclaimer: the Z dimension isn't fully supported)
    
    Specified by:
    
    normZ in interface ShapeFactory
    
    Overrides:
    
    normZ in class ShapeFactoryImpl
    
    See Also:
    
    ShapeFactory.normX(double)
  - normDist
```
public double normDist(double d)
```
    Description copied from interface: ShapeFactory
    
    Called to normalize a value that isn't X or Y or Z. X & Y & Z are normalized via SpatialContext.normX(double) & normY & normZ. This is called by a ShapeReader before creating a shape.
    
    Specified by:
    
    normDist in interface ShapeFactory
    
    Overrides:
    
    normDist in class ShapeFactoryImpl
  - getGeometryFrom
```
public Geometry getGeometryFrom(Shape shape)
```
    Gets a JTS Geometry for the given Shape. Some shapes hold a JTS geometry whereas new ones must be created for the rest.
    
    Parameters:
    
    shape - Not null
    
    Returns:
    
    Not null
  - useJtsPoint
```
public boolean useJtsPoint()
```
    Should pointXY(double, double) return JtsPoint?
  - pointXY
```
public Point pointXY(double x,
                     double y)
```
    Description copied from interface: ShapeFactory
    
    Construct a point.
    
    Specified by:
    
    pointXY in interface ShapeFactory
    
    Overrides:
    
    pointXY in class ShapeFactoryImpl
  - pointXYZ
```
public Point pointXYZ(double x,
                      double y,
                      double z)
```
    Description copied from interface: ShapeFactory
    
    Construct a point of 3 dimensions. The implementation might ignore unsupported dimensions like 'z' or throw an error.
    
    Specified by:
    
    pointXYZ in interface ShapeFactory
    
    Overrides:
    
    pointXYZ in class ShapeFactoryImpl
  - useJtsLineString
```
public boolean useJtsLineString()
```
    Should lineString(java.util.List,double) return JtsGeometry?
  - lineString
```
public Shape lineString(List<Point> points,
                        double bufferDistance)
```
    Description copied from interface: ShapeFactory
    
    Constructs a line string with a possible buffer. It's an ordered sequence of connected vertexes, with a buffer distance along the line in all directions. There is no official shape/interface for it so we just return Shape.
    
    Specified by:
    
    lineString in interface ShapeFactory
    
    Overrides:
    
    lineString in class ShapeFactoryImpl
  - lineString
```
public ShapeFactory.LineStringBuilder lineString()
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a line string, with a possible buffer. It's an ordered sequence of connected vertexes. There is no official shape/interface for it yet so we just return Shape.
    
    Specified by:
    
    lineString in interface ShapeFactory
    
    Overrides:
    
    lineString in class ShapeFactoryImpl
  - polygon
```
public ShapeFactory.PolygonBuilder polygon()
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a polygon. There is no official shape/interface for it yet so we just return Shape.
    
    Specified by:
    
    polygon in interface ShapeFactory
    
    Overrides:
    
    polygon in class ShapeFactoryImpl
  - useJtsMulti
```
public boolean useJtsMulti()
```
    Whether multiPoint(), multiLineString(), and multiPolygon() should all use JTS's subclasses of GeometryCollection instead of Spatial4j's basic impl. The general multiShape(Class) will never use GeometryCollection because that class doesn't support relations.
  - multiPoint
```
public ShapeFactory.MultiPointBuilder multiPoint()
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a MultiPoint.
    
    Specified by:
    
    multiPoint in interface ShapeFactory
    
    Overrides:
    
    multiPoint in class ShapeFactoryImpl
  - multiLineString
```
public ShapeFactory.MultiLineStringBuilder multiLineString()
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a MultiLineString, or possibly the result of that buffered.
    
    Specified by:
    
    multiLineString in interface ShapeFactory
    
    Overrides:
    
    multiLineString in class ShapeFactoryImpl
  - multiPolygon
```
public ShapeFactory.MultiPolygonBuilder multiPolygon()
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a MultiPolygon.
    
    Specified by:
    
    multiPolygon in interface ShapeFactory
    
    Overrides:
    
    multiPolygon in class ShapeFactoryImpl
  - multiShape
```
public <T extends Shape> ShapeFactory.MultiShapeBuilder<T> multiShape(Class<T> shapeClass)
```
    Description copied from interface: ShapeFactory
    
    (Builder) Constructs a Shape aggregate in which each component/member is an instance of the specified class.
    
    Specified by:
    
    multiShape in interface ShapeFactory
    
    Overrides:
    
    multiShape in class ShapeFactoryImpl
  - makeShapeFromGeometry
```
public Shape makeShapeFromGeometry(Geometry geom)
```
    INTERNAL Usually creates a JtsGeometry, potentially validating, repairing, and indexing ("preparing"). This method is intended for use by ShapeReader instances. If given a direct instance of GeometryCollection then it's contents will be recursively converted and then the resulting list will be passed to SpatialContext.makeCollection(List) and returned. If given a Point then SpatialContext.makePoint(double, double) is called, which will return a JtsPoint if JtsSpatialContext.useJtsPoint(); otherwise a standard Spatial4j Point is returned. If given a LineString and if JtsSpatialContext.useJtsLineString() is true then then the geometry's parts are exposed to call SpatialContext.makeLineString(List).
  - makeShape
```
public JtsGeometry makeShape(Geometry geom,
                             boolean dateline180Check,
                             boolean allowMultiOverlap)
```
    INTERNAL
    
    Parameters:
    
    geom - Non-null
    
    dateline180Check - if both this is true and SpatialContext.isGeo(), then JtsGeometry will check for adjacent coordinates greater than 180 degrees longitude apart, and it will do tricks to make that line segment (and the shape as a whole) cross the dateline even though JTS doesn't have geodetic support.
    
    allowMultiOverlap - See isAllowMultiOverlap().
    
    See Also:
    
    makeShape(org.locationtech.jts.geom.Geometry)
  - makeShape
```
public JtsGeometry makeShape(Geometry geom)
```
    INTERNAL: Creates a Shape from a JTS Geometry. Generally, this shouldn't be called when one of the other factory methods are available, such as for points. The caller needs to have done some verification/normalization of the coordinates by now, if any. Also, note that direct instances of GeometryCollection isn't supported. Instead of calling this method, consider makeShapeFromGeometry(Geometry) which
  - getGeometryFactory
```
public GeometryFactory getGeometryFactory()
```
  - makeRectFromRectangularPoly
```
public Rectangle makeRectFromRectangularPoly(Geometry geom)
```
    INTERNAL: Returns a Rectangle of the JTS Envelope (bounding box) of the given geom. This asserts that Geometry.isRectangle() is true. This method reacts to the DatelineRule setting.
    
    Parameters:
    
    geom - non-null
    
    Returns:
    
    the equivalent Rectangle.

Class JtsShapeFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl

Nested classes/interfaces inherited from interface org.locationtech.spatial4j.shape.ShapeFactory

Field Summary

Fields inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl

Constructor Summary

Method Summary

Methods inherited from class org.locationtech.spatial4j.shape.impl.ShapeFactoryImpl

Methods inherited from class java.lang.Object

Field Detail

EMPTY_HOLES

geometryFactory

allowMultiOverlap

useJtsPoint

useJtsLineString

useJtsMulti

datelineRule

validationRule

autoIndex

Constructor Detail

JtsShapeFactory

Method Detail

isAllowMultiOverlap

getDatelineRule

getValidationRule

isAutoIndex

normX

normY

normZ

normDist

getGeometryFrom

useJtsPoint

pointXY

pointXYZ

useJtsLineString

lineString

lineString

polygon

useJtsMulti

multiPoint

multiLineString

multiPolygon

multiShape

makeShapeFromGeometry

makeShape

makeShape

getGeometryFactory

makeRectFromRectangularPoly