Package org.locationtech.jts.geom
Class GeometryCollection
java.lang.Object
org.locationtech.jts.geom.Geometry
org.locationtech.jts.geom.GeometryCollection
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
- Direct Known Subclasses:
MultiLineString
,MultiPoint
,MultiPolygon
Models a collection of
Geometry
s of
arbitrary type and dimension.- Version:
- 1.7
- See Also:
-
Field Summary
Fields inherited from class org.locationtech.jts.geom.Geometry
TYPENAME_GEOMETRYCOLLECTION, TYPENAME_LINEARRING, TYPENAME_LINESTRING, TYPENAME_MULTILINESTRING, TYPENAME_MULTIPOINT, TYPENAME_MULTIPOLYGON, TYPENAME_POINT, TYPENAME_POLYGON
-
Constructor Summary
ConstructorsConstructorDescriptionGeometryCollection
(Geometry[] geometries, GeometryFactory factory) GeometryCollection
(Geometry[] geometries, 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.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 thisGeometryCollection
Returns the boundary, or an empty geometry of appropriate dimension if thisGeometry
is empty.int
Returns the dimension of thisGeometry
s inherent boundary.Returns a vertex of this geometry (usually, but not necessarily, the first one), ornull
if the geometry is empty.Collects all coordinates of all subgeometries into an Array.int
Returns the dimension of this geometry.getGeometryN
(int n) Returns an elementGeometry
from aGeometryCollection
(orthis
, if the geometry is not a collection).Returns the name of this Geometry's actual class.double
Returns the length of thisGeometry
.int
Returns the number ofGeometry
s in aGeometryCollection
(or 1, if the geometry is not a collection).int
Returns the count of thisGeometry
s vertices.boolean
hasDimension
(int dim) Tests whether an atomic geometry or any element of a collection has the specified dimension.boolean
isEmpty()
Tests whether the set of points covered by thisGeometry
is empty.void
Converts thisGeometry
to normal form (or canonical form ).reverse()
Creates aGeometryCollection
with every component reversed.Methods inherited from class org.locationtech.jts.geom.Geometry
buffer, buffer, buffer, compareTo, compareTo, contains, convexHull, copy, coveredBy, covers, crosses, difference, disjoint, distance, equals, equals, equalsExact, equalsNorm, equalsTopo, geometryChanged, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getInteriorPoint, getPrecisionModel, getSRID, getUserData, hashCode, intersection, intersects, isRectangle, isSimple, isValid, isWithinDistance, norm, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, union, within
-
Constructor Details
-
GeometryCollection
Deprecated.Use GeometryFactory instead -
GeometryCollection
- Parameters:
geometries
- theGeometry
s for thisGeometryCollection
, ornull
or an empty array to create the empty geometry. Elements may be emptyGeometry
s, but notnull
s.
-
-
Method Details
-
getCoordinate
Description copied from class:Geometry
Returns a vertex of this geometry (usually, but not necessarily, the first one), ornull
if the geometry is empty. The returned coordinate should not be assumed to be an actualCoordinate
object used in the internal representation.- Specified by:
getCoordinate
in classGeometry
- Returns:
- a coordinate which is a vertex of this
Geometry
.
-
getCoordinates
Collects all coordinates of all subgeometries into an Array. Note that while changes to the coordinate objects themselves may modify the Geometries in place, the returned Array as such is only a temporary container which is not synchronized back.- Specified by:
getCoordinates
in classGeometry
- Returns:
- the collected coordinates
- See Also:
-
isEmpty
public boolean isEmpty()Description copied from class:Geometry
Tests whether the set of points covered by thisGeometry
is empty.Note this test is for topological emptiness, not structural emptiness. A collection containing only empty elements is reported as empty. To check structural emptiness use
Geometry.getNumGeometries()
. -
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.
- See Also:
-
hasDimension
public boolean hasDimension(int dim) Description copied from class:Geometry
Tests whether an atomic geometry or any element of a collection has the specified dimension. In particular, this can be used with mixed-dimensionGeometryCollection
s to test if they contain an element of the specified dimension.- Overrides:
hasDimension
in classGeometry
- Parameters:
dim
- the dimension to test- Returns:
- true if the geometry has or contains an element with the dimension
- See Also:
-
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.
-
getNumGeometries
public int getNumGeometries()Description copied from class:Geometry
Returns the number ofGeometry
s in aGeometryCollection
(or 1, if the geometry is not a collection).- Overrides:
getNumGeometries
in classGeometry
- Returns:
- the number of geometries contained in this geometry
-
getGeometryN
Description copied from class:Geometry
Returns an elementGeometry
from aGeometryCollection
(orthis
, if the geometry is not a collection).- Overrides:
getGeometryN
in classGeometry
- Parameters:
n
- the index of the geometry element- Returns:
- the n'th geometry contained in this geometry
-
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
-
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
-
getBoundary
Description copied from class:Geometry
Returns the boundary, or an empty geometry of appropriate dimension if thisGeometry
is empty. (In the case of zero-dimensional geometries, ' an empty GeometryCollection is returned.) For a discussion of this function, see the OpenGIS Simple Features Specification. As stated in SFS Section 2.1.13.1, "the boundary of a Geometry is a set of Geometries of the next lower dimension."- Specified by:
getBoundary
in classGeometry
- Returns:
- the closure of the combinatorial boundary of this
Geometry
-
getArea
public double getArea()Returns the area of thisGeometryCollection
-
getLength
public double getLength()Description copied from class:Geometry
Returns the length of thisGeometry
. Linear geometries return their length. Areal geometries return their perimeter. They override this function to compute the area. Others return 0.0 -
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 thisGeometryCollection
object. (including all coordinates contained by it). -
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.
-
reverse
Creates aGeometryCollection
with every component reversed. The order of the components in the collection are not reversed.- Overrides:
reverse
in classGeometry
- Returns:
- a
GeometryCollection
in the reverse order
-