Geometry (geolatte-geom 1.9.1 API)

java.lang.Object
- org.geolatte.geom.Geometry

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractGeometryCollection, LineString, Point, Polygon
```
public abstract class Geometry
extends Object
implements Serializable
```
The base class for Geometrys.

Author:

Karel Maesen, Geovise BVBA, 2011

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Geometry(CoordinateReferenceSystem<P> crs)` Creates an empty Geometry
`protected`	`Geometry(PositionSequence<P> positions, CoordinateReferenceSystem<P> crs)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accept(GeometryVisitor<P> visitor)` Accepts a `GeometryVisitor`.
`<Q extends Position> Geometry<Q>`	`as(Class<Q> castToType)`
`protected <Q extends Position> void`	`checkCast(Class<Q> castToType)` Checks whether a cast should succeed
`boolean`	`equals(Object o)`
`static <Q extends Position> Geometry<Q>`	`forceToCrs(Geometry<?> geometry, CoordinateReferenceSystem<Q> crs)` Creates a new `Geometry` with the positions from the specified geometry and having the specified `CoordinateReferenceSystem`.
`static <Q extends Position> Geometry<Q>`	`forceToCrs(Geometry<?> geometry, CoordinateReferenceSystem<Q> crs, double coordinateValue)` Creates a new `Geometry` with the positions from the specified geometry and having the specified `CoordinateReferenceSystem`.
`Box<P>`	`getBoundingBox()` Returns the bounding `Box` of this instance
`int`	`getCoordinateDimension()` Returns the coordinate dimension of this `Geometry`
`CoordinateReferenceSystem<P>`	`getCoordinateReferenceSystem()` Returns the coordinate reference system of this `Geometry`
`protected static <T extends Position> CoordinateReferenceSystem<T>`	`getCrs(Geometry<T>[] geometries)`
`abstract int`	`getDimension()` Returns the topological dimension of this instance.
`Envelope<P>`	`getEnvelope()` Returns the 2D `Envelope` of this instance.
`abstract GeometryType`	`getGeometryType()` Returns the type of this `Geometry`.
`int`	`getNumPositions()` Returns the number of positions in the `PositionSequence` of this `Geometry`.
`Class<P>`	`getPositionClass()`
`P`	`getPositionN(int index)` Returns the position at the specified index in the `PositionSequence` of this `Geometry`.
`PositionSequence<P>`	`getPositions()` Returns the `PositionSequence` of this instance
`int`	`getSRID()` Returns the numeric identifier of the coordinate reference system of this `Geometry`.
`int`	`hashCode()`
`boolean`	`hasM()` Does this `Geometry` has Measure (M) coordinates
`boolean`	`hasZ()` Does this `Geometry` has vertical or Z coordinates
`boolean`	`isEmpty()` Tests whether this `Geometry` corresponds to the empty set.
`protected static <T extends Position> PositionSequence<T>`	`nestPositionSequences(Geometry<T>[] geometries)`
`<Q extends Position> Geometry<Q>`	`toCrs(CoordinateReferenceSystem<Q> crs, double defaultCoordinateValue)` Returns a copy of this Geometry, but with the specified Coordinate Reference System.
`String`	`toString()` Returns the Well-Known Text (WKT) representation of this `Geometry`.
`protected Object`	`writeReplace()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - Geometry
```
protected Geometry(CoordinateReferenceSystem crs)
```
 Creates an empty Geometry
 
 Parameters:
 
 crs - the CoordinateReferenceSystem to use
 - Geometry
```
protected Geometry(PositionSequence positions,
 CoordinateReferenceSystem crs)
```
- Method Detail
 - forceToCrs
```
public static <Q extends Position> Geometry<Q> forceToCrs(Geometry<?> geometry,
 CoordinateReferenceSystem<Q> crs,
 double coordinateValue)
```
 Creates a new Geometry with the positions from the specified geometry and having the specified CoordinateReferenceSystem. When forcing from a smaller to a larger coordinate dimension, the coordinateValue specified will be used for filling the missing coordinate values.
 
 Type Parameters:
 
 Q - the Position type for the returned Geometry*
 
 Parameters:
 
 geometry - source Geometry that supplies the Positions for the returned Geometry
 
 crs - the CoordinateReferenceSystem for the returned Geometry
 
 coordinateValue - the default to fill in when for missing coordinate values (if any)
 
 Returns:
 
 a Geometry with the positions of the specified geometry and having the specified CoordinateReferenceSystem
 - forceToCrs
```
public static <Q extends Position> Geometry<Q> forceToCrs(Geometry<?> geometry,
 CoordinateReferenceSystem<Q> crs)
```
 Creates a new Geometry with the positions from the specified geometry and having the specified CoordinateReferenceSystem. When forcing from a smaller to a larger coordinate dimension, the NaN will be used for the missing coordinate values.
 
 Type Parameters:
 
 Q - the Position type for the returned Geometry*
 
 Parameters:
 
 geometry - source Geometry that supplies the Positions for the returned Geometry
 
 crs - the CoordinateReferenceSystem for the returned Geometry
 
 Returns:
 
 a Geometry with the positions of the specified geometry and having the specified CoordinateReferenceSystem
 - nestPositionSequences
```
protected static <T extends Position> PositionSequence<T> nestPositionSequences(Geometry<T>[] geometries)
```
 - getCrs
```
protected static <T extends Position> CoordinateReferenceSystem<T> getCrs(Geometry<T>[] geometries)
```
 - getCoordinateDimension
```
public int getCoordinateDimension()
```
 Returns the coordinate dimension of this Geometry
 The coordinate dimension is the number of components in the coordinates of the points in this Geometry.
 
 Returns:
 
 the coordinate dimension
 - getCoordinateReferenceSystem
```
public CoordinateReferenceSystem getCoordinateReferenceSystem()
```
 Returns the coordinate reference system of this Geometry
 
 Returns:
 
 the coordinate reference system of this Geometry
 - getSRID
```
public int getSRID()
```
 Returns the numeric identifier of the coordinate reference system of this Geometry.
 A SRID is usually interpreted as meaning the EPSG-code for the coordinate reference system. In this implementation, this is not enforced.
 
 Returns:
 
 the numeric identifier of the coordinate reference system of this Geometry.
 - isEmpty
```
public boolean isEmpty()
```
 Tests whether this Geometry corresponds to the empty set.
 
 Returns:
 
 true if this Geometry corresponds to the empty set, false otherwise.
 - getNumPositions
```
public int getNumPositions()
```
 Returns the number of positions in the PositionSequence of this Geometry.
 
 Returns:
 
 the number of positions in the PositionSequence of this Geometry.
 - getPositionClass
```
public Class getPositionClass()
```
 - getPositionN
```
public P getPositionN(int index)
```
 Returns the position at the specified index in the PositionSequence of this Geometry.
 
 Parameters:
 
 index - the position in the PositionSequence (first point is at index 0).
 
 Returns:
 
 the position at the specified index in the PositionSequence of this Geometry.
 - checkCast
```
protected <Q extends Position> void checkCast(Class<Q> castToType)
```
 Checks whether a cast should succeed
 
 Type Parameters:
 
 Q -
 
 Parameters:
 
 castToType -
 - as
```
public <Q extends Position> Geometry<Q> as(Class<Q> castToType)
```
 - getPositions
```
public PositionSequence getPositions()
```
 Returns the PositionSequence of this instance
 
 Returns:
 
 the PositionSequence of this instance
 - equals
```
public boolean equals(Object o)
```
 Overrides:
 
 equals in class Object
 - getEnvelope
```
public Envelope getEnvelope()
```
 Returns the 2D Envelope of this instance.
 
 Returns:
 
 the Envelope of this instance.
 - getBoundingBox
```
public Box getBoundingBox()
```
 Returns the bounding Box of this instance
 
 Returns:
 
 Returns a Box that encloses this geometry
 - hasM
```
public boolean hasM()
```
 Does this Geometry has Measure (M) coordinates
 
 Returns:
 
 true if this Geometry has Measure coordinate values
 - hasZ
```
public boolean hasZ()
```
 Does this Geometry has vertical or Z coordinates
 
 Returns:
 
 true if this Geometry has vertical coordinate values
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - getGeometryType
```
public abstract GeometryType getGeometryType()
```
 Returns the type of this Geometry.
 
 Returns:
 
 the GeometryType of this instance.
 - toString
```
public String toString()
```
 Returns the Well-Known Text (WKT) representation of this Geometry.
 
 Overrides:
 
 toString in class Object
 
 Returns:
 
 the Well-Known Text (WKT) representation of this Geometry.
 - getDimension
```
public abstract int getDimension()
```
 Returns the topological dimension of this instance. In non-homogenous collections, this will return the largest topological dimension of the contained Geometries.
 
 Returns:
 
 the topological dimension of this instance
 - toCrs
```
public <Q extends Position> Geometry<Q> toCrs(CoordinateReferenceSystem<Q> crs,
 double defaultCoordinateValue)
```
 Returns a copy of this Geometry, but with the specified Coordinate Reference System. This does not transform the coordinate values.
 See forceToCrs(org.geolatte.geom.Geometry<?>, org.geolatte.geom.crs.CoordinateReferenceSystem<Q>, double)
 
 Type Parameters:
 
 Q - Position type of the result
 
 Parameters:
 
 crs - the CRS for the returned Geometry
 
 defaultCoordinateValue - default value used in case the coordinate dimension is expanded
 
 Returns:
 
 a copy of this Geometry with the specified Coordinate Reference System
 - accept
```
public abstract void accept(GeometryVisitor visitor)
```
 Accepts a GeometryVisitor.
 If this Geometry instance is a GeometryCollection then it will pass the visitor to its contained Geometries.
 
 Parameters:
 
 visitor -
 - writeReplace
```
protected Object writeReplace()
 throws ObjectStreamException
```
 Throws:
 
 ObjectStreamException

Class Geometry<P extends Position>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Geometry

Geometry

Method Detail

forceToCrs

forceToCrs

nestPositionSequences

getCrs

getCoordinateDimension

getCoordinateReferenceSystem

getSRID

isEmpty

getNumPositions

getPositionClass

getPositionN

checkCast

as

getPositions

equals

getEnvelope

getBoundingBox

hasM

hasZ

hashCode

getGeometryType

toString

getDimension

toCrs

accept

writeReplace