com.vividsolutions.jts.geom
Class GeometryCollection

java.lang.Object
  extended bycom.vividsolutions.jts.geom.Geometry
      extended bycom.vividsolutions.jts.geom.GeometryCollection
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, java.io.Serializable
Direct Known Subclasses:
MultiLineString, MultiPoint, MultiPolygon

public class GeometryCollection
extends Geometry

Basic implementation of GeometryCollection.

Version:
1.4.0
See Also:
Serialized Form

Field Summary
protected  Geometry[] geometries
          Internal representation of this GeometryCollection.
 
Fields inherited from class com.vividsolutions.jts.geom.Geometry
envelope, SRID
 
Constructor Summary
GeometryCollection(Geometry[] geometries, GeometryFactory factory)
           
GeometryCollection(Geometry[] geometries, PrecisionModel precisionModel, int SRID)
          Deprecated. Use GeometryFactory instead
 
Method Summary
 void apply(CoordinateFilter filter)
          Performs an operation with or on this Geometry's coordinates.
 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 this Geometry and its subelement Geometrys (if any).
 java.lang.Object clone()
           
protected  int compareToSameClass(java.lang.Object o)
          Returns whether this Geometry is greater than, equal to, or less than another Geometry having 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.
 boolean equalsExact(Geometry other, double tolerance)
          Returns true if the two Geometrys are exactly equal, up to a specified tolerance.
 double getArea()
          Returns the area of this GeometryCollection
 Geometry getBoundary()
          Returns the boundary, or the empty geometry if this Geometry is empty.
 int getBoundaryDimension()
          Returns the dimension of this Geometrys inherent boundary.
 Coordinate getCoordinate()
          Returns a vertex of this Geometry.
 Coordinate[] getCoordinates()
          Returns this Geometry s vertices.
 int getDimension()
          Returns the dimension of this Geometry.
 Geometry getGeometryN(int n)
           
 java.lang.String getGeometryType()
          Returns the name of this object's com.vivid.jts.geom interface.
 double getLength()
          Returns the length of this Geometry.
 int getNumGeometries()
           
 int getNumPoints()
          Returns the count of this Geometrys vertices.
 boolean isEmpty()
          Returns whether or not the set of points in this Geometry is empty.
 boolean isSimple()
          Returns false if the Geometry not simple.
 void normalize()
          Converts this Geometry to normal form (or canonical form ).
 
Methods inherited from class com.vividsolutions.jts.geom.Geometry
buffer, buffer, checkNotGeometryCollection, compare, compareTo, contains, convexHull, crosses, difference, disjoint, distance, equal, equals, equalsExact, fromInternalGeometry, geometryChanged, geometryChangedAction, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getInteriorPoint, getPrecisionModel, getSRID, getUserData, hasNonEmptyElements, hasNullElements, intersection, intersects, isEquivalentClass, isValid, isWithinDistance, overlaps, relate, relate, setSRID, setUserData, symDifference, toInternalGeometry, toString, toText, touches, union, within
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

geometries

protected Geometry[] geometries
Internal representation of this GeometryCollection.

Constructor Detail

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 Detail

getCoordinate

public Coordinate getCoordinate()
Description copied from class: Geometry
Returns a vertex of this Geometry.

Specified by:
getCoordinate in class Geometry
Returns:
a Coordinate which is a vertex of this Geometry. Returns null if this Geometry is empty

getCoordinates

public Coordinate[] getCoordinates()
Description copied from class: Geometry
Returns this Geometry s vertices. If you modify the coordinates in this array, be sure to call #geometryChanged afterwards. The Geometrys contained by composite Geometrys must be Geometry's; that is, they must implement getCoordinates.

Specified by:
getCoordinates in class Geometry
Returns:
the vertices of this Geometry

isEmpty

public boolean isEmpty()
Description copied from class: Geometry
Returns whether or not the set of points in this Geometry is empty.

Specified by:
isEmpty in class Geometry
Returns:
true if this Geometry equals the empty geometry

getDimension

public int getDimension()
Description copied from class: Geometry
Returns the dimension of this Geometry.

Specified by:
getDimension in class Geometry
Returns:
the dimension of the class implementing this interface, whether or not this object is the empty geometry

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()

getGeometryN

public Geometry getGeometryN(int n)

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 java.lang.String getGeometryType()
Description copied from class: Geometry
Returns the name of this object's com.vivid.jts.geom interface.

Specified by:
getGeometryType in class Geometry
Returns:
the name of this Geometrys most specific com.vividsolutions.jts.geom interface

isSimple

public boolean isSimple()
Description copied from class: Geometry
Returns false if the Geometry not simple. Subclasses provide their own definition of "simple". If this Geometry is empty, returns true.

In general, the SFS specifications of simplicity seem to follow the following rule:

For all empty Geometrys, isSimple = true.

Specified by:
isSimple in class Geometry
Returns:
true if this Geometry has any points of self-tangency, self-intersection or other anomalous points

getBoundary

public Geometry getBoundary()
Description copied from class: Geometry
Returns the boundary, or the empty geometry if this Geometry is empty. 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 tolerance. Two Geometries are exactly within a tolerance equal iff: If this and the other Geometrys are composites and any children are not Geometrys, returns false.

Specified by:
equalsExact in class Geometry
Parameters:
other - the Geometry with which to compare this Geometry
Returns:
true if this and the other Geometry are of the same class and have equal internal data.

apply

public void apply(CoordinateFilter filter)
Description copied from class: Geometry
Performs an operation with or on this Geometry's coordinates. If you are using this method to modify the geometry, be sure to call #geometryChanged() afterwards. 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 Coordinates at all).

Specified by:
apply in class Geometry
Parameters:
filter - the filter to apply to this Geometry's coordinates

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 java.lang.Object clone()
Overrides:
clone in class Geometry

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.

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(java.lang.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