Class Polygon
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Polygonal
LinearRing
s.
The boundary rings of the polygon may have any orientation.
Polygons are closed, simple geometries by definition.
The polygon model conforms to the assertions specified in the OpenGIS Simple Features Specification for SQL.
A Polygon
is topologically valid if and only if:
- the coordinates which define it are valid coordinates
- the linear rings for the shell and holes are valid (i.e. are closed and do not self-intersect)
- holes touch the shell or another hole at at most one point (which implies that the rings of the shell and holes must not cross)
- the interior of the polygon is connected, or equivalently no sequence of touching holes makes the interior of the polygon disconnected (i.e. effectively split the polygon into two pieces).
- Version:
- 1.7
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected LinearRing[]
The interior boundaries, if any.private static final long
protected LinearRing
The exterior boundary, ornull
if thisPolygon
is empty.Fields inherited from class org.locationtech.jts.geom.Geometry
envelope, factory, SORTINDEX_GEOMETRYCOLLECTION, SORTINDEX_LINEARRING, SORTINDEX_LINESTRING, SORTINDEX_MULTILINESTRING, SORTINDEX_MULTIPOINT, SORTINDEX_MULTIPOLYGON, SORTINDEX_POINT, SORTINDEX_POLYGON, SRID
-
Constructor Summary
ConstructorsConstructorDescriptionPolygon
(LinearRing shell, LinearRing[] holes, GeometryFactory factory) Constructs aPolygon
with the given exterior boundary and interior boundaries.Polygon
(LinearRing shell, LinearRing[] holes, PrecisionModel precisionModel, int SRID) Deprecated.Use GeometryFactory insteadPolygon
(LinearRing shell, PrecisionModel precisionModel, int SRID) Deprecated.Use GeometryFactory instead -
Method Summary
Modifier and TypeMethodDescriptionvoid
apply
(CoordinateFilter filter) Performs an operation with or on thisGeometry
's coordinates.void
apply
(CoordinateSequenceFilter filter) Performs an operation on the coordinates in thisGeometry
'sCoordinateSequence
s.void
apply
(GeometryComponentFilter filter) Performs an operation with or on this Geometry and its component Geometry's.void
apply
(GeometryFilter filter) Performs an operation with or on thisGeometry
and its subelementGeometry
s (if any).clone()
Deprecated.protected int
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
having the same class.protected int
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
of the same class.protected Envelope
Returns the minimum and maximum x and y values in thisGeometry
, or a nullEnvelope
if thisGeometry
is empty.Computes the smallest convexPolygon
that contains all the points in theGeometry
.copy()
Creates and returns a full copy of thisPolygon
object.boolean
equalsExact
(Geometry other, double tolerance) Returns true if the twoGeometry
s are exactly equal, up to a specified distance tolerance.double
getArea()
Returns the area of thisPolygon
Computes the boundary of this geometryint
Returns the dimension of thisGeometry
s inherent boundary.Returns a vertex of thisGeometry
(usually, but not necessarily, the first one).Returns an array containing the values of all the vertices for this geometry.int
Returns the dimension of this geometry.Returns the name of this Geometry's actual class.getInteriorRingN
(int n) double
Returns the perimeter of thisPolygon
int
int
Returns the count of thisGeometry
s vertices.protected int
boolean
isEmpty()
Tests whether the set of points covered by thisGeometry
is empty.boolean
Tests if a valid polygon is simple.void
Converts thisGeometry
to normal form (or canonical form ).private void
normalize
(LinearRing ring, boolean clockwise) reverse()
Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.Methods inherited from class org.locationtech.jts.geom.Geometry
buffer, buffer, buffer, checkNotGeometryCollection, compare, compareTo, compareTo, contains, coveredBy, covers, crosses, difference, disjoint, distance, equal, equals, equals, equalsExact, equalsNorm, equalsTopo, geometryChanged, geometryChangedAction, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getGeometryN, getInteriorPoint, getNumGeometries, getPrecisionModel, getSRID, getUserData, hashCode, hasNonEmptyElements, hasNullElements, intersection, intersects, isEquivalentClass, isGeometryCollection, isSimple, isValid, isWithinDistance, norm, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, union, within
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
shell
The exterior boundary, ornull
if thisPolygon
is empty. -
holes
The interior boundaries, if any. This instance var is never null. If there are no holes, the array is of zero length.
-
-
Constructor Details
-
Polygon
Deprecated.Use GeometryFactory insteadConstructs aPolygon
with the given exterior boundary.- Parameters:
shell
- the outer boundary of the newPolygon
, ornull
or an emptyLinearRing
if the empty geometry is to be created.precisionModel
- the specification of the grid of allowable points for thisPolygon
SRID
- the ID of the Spatial Reference System used by thisPolygon
-
Polygon
Deprecated.Use GeometryFactory insteadConstructs aPolygon
with the given exterior boundary and interior boundaries.- Parameters:
shell
- the outer boundary of the newPolygon
, ornull
or an emptyLinearRing
if the empty geometry is to be created.holes
- the inner boundaries of the newPolygon
, ornull
or emptyLinearRing
s if the empty geometry is to be created.precisionModel
- the specification of the grid of allowable points for thisPolygon
SRID
- the ID of the Spatial Reference System used by thisPolygon
-
Polygon
Constructs aPolygon
with the given exterior boundary and interior boundaries.- Parameters:
shell
- the outer boundary of the newPolygon
, ornull
or an emptyLinearRing
if the empty geometry is to be created.holes
- the inner boundaries of the newPolygon
, ornull
or emptyLinearRing
s if the empty geometry is to be created.
-
-
Method Details
-
getCoordinate
Description copied from class:Geometry
Returns a vertex of thisGeometry
(usually, but not necessarily, the first one). The returned coordinate should not be assumed to be an actual Coordinate object used in the internal representation.- Specified by:
getCoordinate
in classGeometry
- Returns:
- a
Coordinate
which is a vertex of thisGeometry
.
-
getCoordinates
Description copied from class:Geometry
Returns an array containing the values of all the vertices for this geometry. If the geometry is a composite, the array will contain all the vertices for the components, in the order in which the components occur in the geometry.In general, the array cannot be assumed to be the actual internal storage for the vertices. Thus modifying the array may not modify the geometry itself. Use the
CoordinateSequence.setOrdinate(int, int, double)
method (possibly on the components) to modify the underlying data. If the coordinates are modified,Geometry.geometryChanged()
must be called afterwards.- Specified by:
getCoordinates
in classGeometry
- Returns:
- the vertices of this
Geometry
- See Also:
-
getNumPoints
public int getNumPoints()Description copied from class:Geometry
Returns the count of thisGeometry
s vertices. TheGeometry
s contained by compositeGeometry
s must be Geometry's; that is, they must implementgetNumPoints
- Specified by:
getNumPoints
in classGeometry
- Returns:
- the number of vertices in this
Geometry
-
getDimension
public int getDimension()Description copied from class:Geometry
Returns the dimension of this geometry. The dimension of a geometry is is the topological dimension of its embedding in the 2-D Euclidean plane. In the JTS spatial model, dimension values are in the set {0,1,2}.Note that this is a different concept to the dimension of the vertex
Coordinate
s. The geometry dimension can never be greater than the coordinate dimension. For example, a 0-dimensional geometry (e.g. a Point) may have a coordinate dimension of 3 (X,Y,Z).- Specified by:
getDimension
in classGeometry
- Returns:
- the topological dimension of this geometry.
-
getBoundaryDimension
public int getBoundaryDimension()Description copied from class:Geometry
Returns the dimension of thisGeometry
s inherent boundary.- Specified by:
getBoundaryDimension
in classGeometry
- Returns:
- the dimension of the boundary of the class implementing this
interface, whether or not this object is the empty geometry. Returns
Dimension.FALSE
if the boundary is the empty geometry.
-
isEmpty
public boolean isEmpty()Description copied from class:Geometry
Tests whether the set of points covered by thisGeometry
is empty. -
isRectangle
public boolean isRectangle()Tests if a valid polygon is simple. This method always returns true, since a valid polygon is always simple- Overrides:
isRectangle
in classGeometry
- Returns:
true
-
getExteriorRing
-
getNumInteriorRing
public int getNumInteriorRing() -
getInteriorRingN
-
getGeometryType
Description copied from class:Geometry
Returns the name of this Geometry's actual class.- Specified by:
getGeometryType
in classGeometry
- Returns:
- the name of this
Geometry
s actual class
-
getArea
public double getArea()Returns the area of thisPolygon
-
getLength
public double getLength()Returns the perimeter of thisPolygon
-
getBoundary
Computes the boundary of this geometry- Specified by:
getBoundary
in classGeometry
- Returns:
- a lineal geometry (which may be empty)
- See Also:
-
computeEnvelopeInternal
Description copied from class:Geometry
Returns the minimum and maximum x and y values in thisGeometry
, or a nullEnvelope
if thisGeometry
is empty. UnlikegetEnvelopeInternal
, this method calculates theEnvelope
each time it is called;getEnvelopeInternal
caches the result of this method.- Specified by:
computeEnvelopeInternal
in classGeometry
- Returns:
- this
Geometry
s bounding box; if theGeometry
is empty,Envelope#isNull
will returntrue
-
equalsExact
Description copied from class:Geometry
Returns true if the twoGeometry
s are exactly equal, up to a specified distance tolerance. Two Geometries are exactly equal within a distance tolerance if and only if:- they have the same structure
- they have the same values for their vertices, within the given tolerance distance, in exactly the same order.
GeometryFactory
, theSRID
, or theuserData
fields.To properly test equality between different geometries, it is usually necessary to
Geometry.normalize()
them first.- Specified by:
equalsExact
in classGeometry
- Parameters:
other
- theGeometry
with which to compare thisGeometry
tolerance
- distance at or below which twoCoordinate
s are considered equal- Returns:
true
if this and the otherGeometry
have identical structure and point values, up to the distance tolerance.- See Also:
-
apply
Description copied from class:Geometry
Performs an operation with or on thisGeometry
's coordinates. If this method modifies any coordinate values,Geometry.geometryChanged()
must be called to update the geometry state. Note that you cannot use this method to modify this Geometry if its underlying CoordinateSequence's #get method returns a copy of the Coordinate, rather than the actual Coordinate stored (if it even stores Coordinate objects at all). -
apply
Description copied from class:Geometry
Performs an operation on the coordinates in thisGeometry
'sCoordinateSequence
s. If the filter reports that a coordinate value has been changed,Geometry.geometryChanged()
will be called automatically. -
apply
Description copied from class:Geometry
Performs an operation with or on thisGeometry
and its subelementGeometry
s (if any). Only GeometryCollections and subclasses have subelement Geometry's. -
apply
Description copied from class:Geometry
Performs an operation with or on this Geometry and its component Geometry's. Only GeometryCollections and Polygons have component Geometry's; for Polygons they are the LinearRings of the shell and holes. -
clone
Deprecated.Creates and returns a full copy of thisPolygon
object. (including all coordinates contained by it). -
copy
Creates and returns a full copy of thisPolygon
object. (including all coordinates contained by it). -
convexHull
Description copied from class:Geometry
Computes the smallest convexPolygon
that contains all the points in theGeometry
. This obviously applies only toGeometry
s which contain 3 or more points; the results for degenerate cases are specified as follows:Number of Point
s in argumentGeometry
Geometry
class of result0 empty GeometryCollection
1 Point
2 LineString
3 or more Polygon
- Overrides:
convexHull
in classGeometry
- Returns:
- the minimum-area convex polygon containing this
Geometry
' s points
-
normalize
public void normalize()Description copied from class:Geometry
Converts thisGeometry
to normal form (or canonical form ). Normal form is a unique representation forGeometry
s. It can be used to test whether twoGeometry
s are equal in a way that is independent of the ordering of the coordinates within them. Normal form equality is a stronger condition than topological equality, but weaker than pointwise equality. The definitions for normal form use the standard lexicographical ordering for coordinates. "Sorted in order of coordinates" means the obvious extension of this ordering to sequences of coordinates.NOTE that this method mutates the value of this geometry in-place. If this is not safe and/or wanted, the geometry should be cloned prior to normalization.
-
compareToSameClass
Description copied from class:Geometry
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
having the same class.- Specified by:
compareToSameClass
in classGeometry
- Parameters:
o
- aGeometry
having the same class as thisGeometry
- Returns:
- a positive number, 0, or a negative number, depending on whether
this object is greater than, equal to, or less than
o
, as defined in "Normal Form For Geometry" in the JTS Technical Specifications
-
compareToSameClass
Description copied from class:Geometry
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
of the same class. using the givenCoordinateSequenceComparator
.- Specified by:
compareToSameClass
in classGeometry
- Parameters:
o
- aGeometry
having the same class as thisGeometry
comp
- aCoordinateSequenceComparator
- Returns:
- a positive number, 0, or a negative number, depending on whether
this object is greater than, equal to, or less than
o
, as defined in "Normal Form For Geometry" in the JTS Technical Specifications
-
getSortIndex
protected int getSortIndex()- Specified by:
getSortIndex
in classGeometry
-
normalize
-
reverse
Description copied from class:Geometry
Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.
-