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
public class GeometryCollection extends Geometry
Models a collection of Geometrys of arbitrary type and dimension.
Version:
1.7
See Also:

  • Field Details

    • geometries

      protected Geometry[] geometries
      Internal representation of this GeometryCollection.

  • Constructor Details

    • GeometryCollection

      public GeometryCollection(Geometry[] geometries, PrecisionModel precisionModel, int SRID)
      Deprecated.
      Use GeometryFactory instead

    • GeometryCollection

      public GeometryCollection(Geometry[] geometries, GeometryFactory factory)
      Parameters:
      geometries - the Geometrys for this GeometryCollection, or null or an empty array to create the empty geometry. Elements may be empty Geometrys, but not nulls.

  • Method Details

    • getCoordinate

      public Coordinate getCoordinate()
      Description copied from class: Geometry
      Returns a vertex of this geometry (usually, but not necessarily, the first one), or null if the geometry is empty. The returned coordinate should not be assumed to be an actual Coordinate object used in the internal representation.
      Specified by:
      getCoordinate in class Geometry
      Returns:
      a coordinate which is a vertex of this Geometry.

    • getCoordinates

      public Coordinate[] 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 class Geometry
      Returns:
      the collected coordinates
      See Also:

    • isEmpty

      public boolean isEmpty()
      Description copied from class: Geometry
      Tests whether the set of points covered by this Geometry 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().

      Specified by:
      isEmpty in class Geometry
      Returns:
      true if this Geometry does not cover any points

    • 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 Coordinates. 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 class Geometry
      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-dimension GeometryCollections to test if they contain an element of the specified dimension.
      Overrides:
      hasDimension in class Geometry
      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 this Geometrys inherent boundary.
      Specified by:
      getBoundaryDimension in class Geometry
      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 of Geometrys in a GeometryCollection (or 1, if the geometry is not a collection).
      Overrides:
      getNumGeometries in class Geometry
      Returns:
      the number of geometries contained in this geometry

    • getGeometryN

      public Geometry getGeometryN(int n)
      Description copied from class: Geometry
      Returns an element Geometry from a GeometryCollection (or this, if the geometry is not a collection).
      Overrides:
      getGeometryN in class Geometry
      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 this Geometrys vertices. The Geometry s contained by composite Geometrys must be Geometry's; that is, they must implement getNumPoints
      Specified by:
      getNumPoints in class Geometry
      Returns:
      the number of vertices in this Geometry

    • getGeometryType

      public String getGeometryType()
      Description copied from class: Geometry
      Returns the name of this Geometry's actual class.
      Specified by:
      getGeometryType in class Geometry
      Returns:
      the name of this Geometrys actual class

    • getBoundary

      public Geometry getBoundary()
      Description copied from class: Geometry
      Returns the boundary, or an empty geometry of appropriate dimension if this Geometry 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 class Geometry
      Returns:
      the closure of the combinatorial boundary of this Geometry

    • getArea

      public double getArea()
      Returns the area of this GeometryCollection
      Overrides:
      getArea in class Geometry
      Returns:
      the area of the polygon

    • getLength

      public double getLength()
      Description copied from class: Geometry
      Returns the length of this Geometry. Linear geometries return their length. Areal geometries return their perimeter. They override this function to compute the area. Others return 0.0
      Overrides:
      getLength in class Geometry
      Returns:
      the length of the Geometry

    • equalsExact

      public boolean equalsExact(Geometry other, double tolerance)
      Description copied from class: Geometry
      Returns true if the two Geometrys 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.
      This method does not test the values of the GeometryFactory, the SRID, or the userData fields.

      To properly test equality between different geometries, it is usually necessary to Geometry.normalize() them first.

      Specified by:
      equalsExact in class Geometry
      Parameters:
      other - the Geometry with which to compare this Geometry
      tolerance - distance at or below which two Coordinates are considered equal
      Returns:
      true if this and the other Geometry have identical structure and point values, up to the distance tolerance.
      See Also:

    • apply

      public void apply(CoordinateFilter filter)
      Description copied from class: Geometry
      Performs an operation with or on this 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).
      Specified by:
      apply in class Geometry
      Parameters:
      filter - the filter to apply to this Geometry's coordinates

    • apply

      public void apply(CoordinateSequenceFilter filter)
      Description copied from class: Geometry
      Performs an operation on the coordinates in this Geometry's CoordinateSequences. If the filter reports that a coordinate value has been changed, Geometry.geometryChanged() will be called automatically.
      Specified by:
      apply in class Geometry
      Parameters:
      filter - the filter to apply

    • apply

      public void apply(GeometryFilter filter)
      Description copied from class: Geometry
      Performs an operation with or on this Geometry and its subelement Geometrys (if any). Only GeometryCollections and subclasses have subelement Geometry's.
      Specified by:
      apply in class Geometry
      Parameters:
      filter - the filter to apply to this Geometry (and its children, if it is a GeometryCollection).

    • apply

      public void apply(GeometryComponentFilter filter)
      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.
      Specified by:
      apply in class Geometry
      Parameters:
      filter - the filter to apply to this Geometry.

    • clone

      public Object clone()
      Deprecated.
      Creates and returns a full copy of this GeometryCollection object. (including all coordinates contained by it).
      Overrides:
      clone in class Geometry
      Returns:
      a clone of this instance

    • copyInternal

      protected GeometryCollection copyInternal()
      Description copied from class: Geometry
      An internal method to copy subclass-specific geometry data.
      Specified by:
      copyInternal in class Geometry
      Returns:
      a copy of the target geometry object.

    • normalize

      public void normalize()
      Description copied from class: Geometry
      Converts this Geometry to normal form (or canonical form ). Normal form is a unique representation for Geometry s. It can be used to test whether two Geometrys 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.

      Specified by:
      normalize in class Geometry

    • computeEnvelopeInternal

      protected Envelope computeEnvelopeInternal()
      Description copied from class: Geometry
      Returns the minimum and maximum x and y values in this 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.
      Specified by:
      computeEnvelopeInternal in class Geometry
      Returns:
      this Geometrys bounding box; if the Geometry is empty, Envelope#isNull will return true

    • compareToSameClass

      protected int compareToSameClass(Object o)
      Description copied from class: Geometry
      Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.
      Specified by:
      compareToSameClass in class Geometry
      Parameters:
      o - a Geometry having the same class as this Geometry
      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

      protected int compareToSameClass(Object o, CoordinateSequenceComparator comp)
      Description copied from class: Geometry
      Returns whether this Geometry is greater than, equal to, or less than another Geometry of the same class. using the given CoordinateSequenceComparator.
      Specified by:
      compareToSameClass in class Geometry
      Parameters:
      o - a Geometry having the same class as this Geometry
      comp - a CoordinateSequenceComparator
      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

    • getTypeCode

      protected int getTypeCode()
      Specified by:
      getTypeCode in class Geometry

    • reverse

      public GeometryCollection reverse()
      Creates a GeometryCollection with every component reversed. The order of the components in the collection are not reversed.
      Overrides:
      reverse in class Geometry
      Returns:
      a GeometryCollection in the reverse order

    • reverseInternal

      protected GeometryCollection reverseInternal()
      Specified by:
      reverseInternal in class Geometry