org.geolatte.geom

Class GeometryCollection<P extends Position,G extends Geometry<P>>

java.lang.Object

org.geolatte.geom.Geometry<P>

org.geolatte.geom.GeometryCollection<P,G>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<G>, Complex<P,G>

Direct Known Subclasses:

MultiLineString, MultiPoint, MultiPolygon

public class GeometryCollection<P extends Position,G extends Geometry<P>>
extends Geometry<P>
implements Complex<P,G>

A Geometry that is an ordered collection of some number of Geometrys.

All elements in a GeometryCollection must be in the same CoordinateReferenceSystem, which is also the CoordinateReferenceSystem for the GeometryCollection.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Geometry<P>[]	geometries

Constructor Summary

Constructors

Constructor and Description
GeometryCollection(CoordinateReferenceSystem<P> crs) Constructs an empty GeometryCollection
GeometryCollection(G... geometries) Constructs a GeometryCollection from the specified Geometrys.

Method Summary

Modifier and Type	Method and Description
void	accept(GeometryVisitor<P> visitor) Accepts the GeometryVisitor, and will pass it to it's constituent Geometries.
private void	check(G[] geometries) Verifies that the Geometry array can be used to construct a Geometry collection.
G[]	components() Returns the components
java.lang.Class<? extends Geometry>	getComponentType() Returns the Class of which all constituent Geometrys are instances.
int	getDimension() Returns the topological dimension of this instance.
G	getGeometryN(int num) Returns the Geometry element at the specified (zero-based) position in this GeometryCollection.
GeometryType	getGeometryType() Returns the type of this Geometry.
int	getNumGeometries() Returns the number of elements in this GeometryCollection.
java.util.Iterator<G>	iterator() Creates an Iterator over the elements of this GeometryCollection.

Methods inherited from class org.geolatte.geom.Geometry

equals, forceToCrs, getCoordinateDimension, getCoordinateReferenceSystem, getCrs, getEnvelope, getNumPositions, getPositionClass, getPositionN, getPositions, getSRID, hashCode, isEmpty, nestPositionSequences, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

geometries

protected final Geometry<P extends Position>[] geometries

Constructor Detail

GeometryCollection

@SafeVarargs
public GeometryCollection(G... geometries)

Constructs a GeometryCollection from the specified Geometrys.

Parameters:

geometries - the Geometrys that are the elements of the constructed GeometryCollection.

GeometryCollection

public GeometryCollection(CoordinateReferenceSystem<P> crs)

Constructs an empty GeometryCollection

Method Detail

getNumGeometries

public int getNumGeometries()

Returns the number of elements in this GeometryCollection.

Specified by:

getNumGeometries in interface Complex<P extends Position,G extends Geometry<P>>

Returns:

the number of elements of this instance.

getComponentType

public java.lang.Class<? extends Geometry> getComponentType()

Description copied from interface: Complex

Returns the Class of which all constituent Geometrys are instances.

Specified by:

getComponentType in interface Complex<P extends Position,G extends Geometry<P>>

Returns:

the Class of which all constituent Geometrys are instances.

components

public G[] components()

Returns the components

Specified by:

components in interface Complex<P extends Position,G extends Geometry<P>>

Returns:

an array containing all component objects

getGeometryN

public G getGeometryN(int num)

Returns the Geometry element at the specified (zero-based) position in this GeometryCollection.

Parameters:

num - the position in the collection of the requested Geometry

Returns:

the element Geometry at the position specified by the num parameter.

getDimension

public int getDimension()

Description copied from class: Geometry

Returns the topological dimension of this instance. In non-homogenous collections, this will return the largest topological dimension of the contained Geometries.

Specified by:

getDimension in class Geometry<P extends Position>

Returns:

the topological dimension of this instance

getGeometryType

public GeometryType getGeometryType()

Description copied from class: Geometry

Returns the type of this Geometry.

Specified by:

getGeometryType in class Geometry<P extends Position>

Returns:

the GeometryType of this instance.

iterator

public java.util.Iterator<G> iterator()

Creates an Iterator over the elements of this GeometryCollection.

Specified by:

iterator in interface java.lang.Iterable<G extends Geometry<P>>

Returns:

an Iterator over the elements of this GeometryCollection.

accept

public void accept(GeometryVisitor<P> visitor)

Accepts the GeometryVisitor, and will pass it to it's constituent Geometries.

Specified by:

accept in class Geometry<P extends Position>

Parameters:

visitor -

check

private void check(G[] geometries)

Verifies that the Geometry array can be used to construct a Geometry collection.

Conditions:

Array contains no NULL values All non-empty elements have the same coordinate reference system/li>

Parameters:

geometries -

Throws:

java.lang.IllegalStateException - When geometries contains a null value or when the given geometries do not share the same CrsId