public class Polygon extends Geometryimplements 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:
Modifier and Type | Field and Description |
---|---|
protected LinearRing |
holes
The interior boundaries, if any.
|
protected LinearRing |
shell
The exterior boundary, or
null if this
Polygon is empty.
|
Constructor and Description |
---|
Polygon(LinearRing
Constructs a
Polygon with the given exterior boundary and interior boundaries.
|
Polygon(LinearRing
Deprecated.
Use GeometryFactory instead
|
Polygon(LinearRing
Deprecated.
Use GeometryFactory instead
|
Modifier and Type | Method and Description |
---|---|
void |
apply(CoordinateFilter
Performs an operation with or on this
Geometry 's coordinates.
|
void |
apply(CoordinateSequenceFilter
Performs an operation on the coordinates in this
Geometry 's
CoordinateSequence s.
|
void |
apply(GeometryComponentFilter
Performs an operation with or on this Geometry and its component Geometry's.
|
void |
apply(GeometryFilter
Performs an operation with or on this
Geometry and its subelement
Geometry s (if any).
|
Object |
clone()
Creates and returns a full copy of this
Polygon object.
|
protected int |
compareToSameClass(Object
Returns whether this
Geometry is greater than, equal to, or less than another
Geometry having the same class.
|
protected int |
compareToSameClass(Object
Returns whether this
Geometry is greater than, equal to, or less than another
Geometry of the same class.
|
protected Envelope |
computeEnvelopeInternal()
Returns the minimum and maximum x and y values in this
Geometry , or a null
Envelope if this
Geometry is empty.
|
Geometry |
convexHull()
Computes the smallest convex
Polygon that contains all the points in the
Geometry .
|
boolean |
equalsExact(Geometry
Returns true if the two
Geometry s are exactly equal, up to a specified distance tolerance.
|
double |
getArea()
Returns the area of this
Polygon
|
Geometry |
getBoundary()
Computes the boundary of this geometry
|
int |
getBoundaryDimension()
Returns the dimension of this
Geometry s inherent boundary.
|
Coordinate |
getCoordinate()
Returns a vertex of this
Geometry (usually, but not necessarily, the first one).
|
Coordinate |
getCoordinates()
Returns an array containing the values of all the vertices for this geometry.
|
int |
getDimension()
Returns the dimension of this geometry.
|
LineString |
getExteriorRing()
|
String |
getGeometryType()
Returns the name of this Geometry's actual class.
|
LineString |
getInteriorRingN(int n)
|
double |
getLength()
Returns the perimeter of this
Polygon
|
int |
getNumInteriorRing()
|
int |
getNumPoints()
Returns the count of this
Geometry s vertices.
|
boolean |
isEmpty()
Tests whether the set of points covered by this
Geometry is empty.
|
boolean |
isRectangle()
Tests if a valid polygon is simple.
|
void |
normalize()
Converts this
Geometry to
normal form (or
canonical form ).
|
Geometry |
reverse()
Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.
|
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
protected LinearRingshell
null
if this
Polygon
is empty.
protected LinearRing[] holes
public Polygon(LinearRingshell, PrecisionModel precisionModel, int SRID)
Polygon
with the given exterior boundary.
shell
- the outer boundary of the new
Polygon
, or
null
or an empty
LinearRing
if the empty geometry is to be created.
precisionModel
- the specification of the grid of allowable points for this
Polygon
SRID
- the ID of the Spatial Reference System used by this
Polygon
public Polygon(LinearRingshell, LinearRing [] holes, PrecisionModel precisionModel, int SRID)
Polygon
with the given exterior boundary and interior boundaries.
shell
- the outer boundary of the new
Polygon
, or
null
or an empty
LinearRing
if the empty geometry is to be created.
holes
- the inner boundaries of the new
Polygon
, or
null
or empty
LinearRing
s if the empty geometry is to be created.
precisionModel
- the specification of the grid of allowable points for this
Polygon
SRID
- the ID of the Spatial Reference System used by this
Polygon
public Polygon(LinearRingshell, LinearRing [] holes, GeometryFactory factory)
Polygon
with the given exterior boundary and interior boundaries.
shell
- the outer boundary of the new
Polygon
, or
null
or an empty
LinearRing
if the empty geometry is to be created.
holes
- the inner boundaries of the new
Polygon
, or
null
or empty
LinearRing
s if the empty geometry is to be created.
public CoordinategetCoordinate()
Geometry
Geometry
(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.
getCoordinate
in class
Geometry
Coordinate
which is a vertex of this
Geometry
.
public Coordinate[] getCoordinates()
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
method (possibly on the components) to modify the underlying data. If the coordinates are modified, Geometry
must be called afterwards.
getCoordinates
in class
Geometry
Geometry
Geometry.geometryChanged()
,
CoordinateSequence.setOrdinate(int, int, double)
public int getNumPoints()
Geometry
Geometry
s vertices. The
Geometry
s contained by composite
Geometry
s must be Geometry's; that is, they must implement
getNumPoints
getNumPoints
in class
Geometry
Geometry
public int getDimension()
Geometry
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).
getDimension
in class
Geometry
public int getBoundaryDimension()
Geometry
Geometry
s inherent boundary.
getBoundaryDimension
in class
Geometry
Dimension.FALSE
if the boundary is the empty geometry.
public boolean isEmpty()
Geometry
Geometry
is empty.
public boolean isRectangle()
isRectangle
in class
Geometry
true
public LineStringgetExteriorRing()
public int getNumInteriorRing()
public LineStringgetInteriorRingN(int n)
public StringgetGeometryType()
Geometry
getGeometryType
in class
Geometry
Geometry
s actual class
public double getArea()
Polygon
public double getLength()
Polygon
public GeometrygetBoundary()
getBoundary
in class
Geometry
Geometry.getBoundary()
protected EnvelopecomputeEnvelopeInternal()
Geometry
Geometry
, or a null
Envelope
if this
Geometry
is empty. Unlike
getEnvelopeInternal
, this method calculates the
Envelope
each time it is called;
getEnvelopeInternal
caches the result of this method.
computeEnvelopeInternal
in class
Geometry
Geometry
s bounding box; if the
Geometry
is empty,
Envelope#isNull
will return
true
public boolean equalsExact(Geometryother, double tolerance)
Geometry
Geometry
s are exactly equal, up to a specified distance tolerance. Two Geometries are exactly equal within a distance tolerance if and only if:
GeometryFactory
, the
SRID
, or the
userData
fields.
To properly test equality between different geometries, it is usually necessary to Geometry
them first.
equalsExact
in class
Geometry
other
- the
Geometry
with which to compare this
Geometry
tolerance
- distance at or below which two
Coordinate
s are considered equal
true
if this and the other
Geometry
have identical structure and point values, up to the distance tolerance.
Geometry.equalsExact(Geometry)
,
Geometry.normalize()
,
Geometry.norm()
public void apply(CoordinateFilterfilter)
Geometry
Geometry
'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).
public void apply(CoordinateSequenceFilterfilter)
Geometry
Geometry
's
CoordinateSequence
s. If the filter reports that a coordinate value has been changed,
Geometry.geometryChanged()
will be called automatically.
public void apply(GeometryFilterfilter)
Geometry
Geometry
and its subelement
Geometry
s (if any). Only GeometryCollections and subclasses have subelement Geometry's.
public void apply(GeometryComponentFilterfilter)
Geometry
public Objectclone()
Polygon
object. (including all coordinates contained by it).
public GeometryconvexHull()
Geometry
Polygon
that contains all the points in the
Geometry
. This obviously applies only to
Geometry
s which contain 3 or more points; the results for degenerate cases are specified as follows:
Number of Point s in argument Geometry |
Geometry class of result |
---|---|
0 | empty GeometryCollection |
1 | Point |
2 | LineString |
3 or more | Polygon |
convexHull
in class
Geometry
Geometry
' s points
public void normalize()
Geometry
Geometry
to
normal form (or
canonical form ). Normal form is a unique representation for
Geometry
s. It can be used to test whether two
Geometry
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.
protected int compareToSameClass(Objecto)
Geometry
Geometry
is greater than, equal to, or less than another
Geometry
having the same class.
compareToSameClass
in class
Geometry
o
- a
Geometry
having the same class as this
Geometry
o
, as defined in "Normal Form For Geometry" in the JTS Technical Specifications
protected int compareToSameClass(Objecto, CoordinateSequenceComparator comp)
Geometry
Geometry
is greater than, equal to, or less than another
Geometry
of the same class. using the given
CoordinateSequenceComparator
.
compareToSameClass
in class
Geometry
o
- a
Geometry
having the same class as this
Geometry
comp
- a
CoordinateSequenceComparator
o
, as defined in "Normal Form For Geometry" in the JTS Technical Specifications