org.geotools.geometry
Class DirectPosition1D

java.lang.Object
  org.geotools.geometry.DirectPosition1D

All Implemented Interfaces:

java.lang.Cloneable, org.opengis.util.Cloneable, org.opengis.spatialschema.geometry.DirectPosition, org.opengis.spatialschema.geometry.geometry.Position, java.io.Serializable

public class DirectPosition1D

extends java.lang.Object

implements org.opengis.spatialschema.geometry.DirectPosition, java.io.Serializable, java.lang.Cloneable

Holds the coordinates for a one-dimensional position within some coordinate reference system.

Since:

2.0

Version:

$Id: DirectPosition1D.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

double

ordinate The ordinate value.

Constructor Summary

DirectPosition1D()
Constructs a position initialized to (0) with a coordinate reference system.

DirectPosition1D(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
Constructs a position with the specified coordinate reference system.

DirectPosition1D(org.opengis.spatialschema.geometry.DirectPosition point)
Constructs a position initialized to the same values than the specified point.

DirectPosition1D(double ordinate)
Constructs a 1D position from the specified ordinate.

Method Summary

java.lang.Object	clone() Returns a copy of this position.
org.opengis.referencing.crs.CoordinateReferenceSystem	getCoordinateReferenceSystem() Returns the coordinate reference system in which the coordinate is given.
double[]	getCoordinates() Returns a sequence of numbers that hold the coordinate of this position in its reference system.
int	getDimension() The length of coordinate sequence (the number of entries).
double	getOrdinate(int dimension) Returns the ordinate at the specified dimension.
org.opengis.spatialschema.geometry.DirectPosition	getPosition() Returns always this, the direct position for this position.
int	hashCode() Returns a hash value for this coordinate.
void	setCoordinateReferenceSystem(org.opengis.referencing.crs.CoordinateReferenceSystem crs) Set the coordinate reference system in which the coordinate is given.
void	setLocation(org.opengis.spatialschema.geometry.DirectPosition position) Set this coordinate to the specified direct position.
void	setOrdinate(int dimension, double value) Sets the ordinate value along the specified dimension.
java.lang.String	toString() Returns a string representation of this coordinate.

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ordinate

public double ordinate

The ordinate value.

Constructor Detail

DirectPosition1D

public DirectPosition1D()

Constructs a position initialized to (0) with a coordinate reference system.

DirectPosition1D

public DirectPosition1D(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Constructs a position with the specified coordinate reference system.

DirectPosition1D

public DirectPosition1D(double ordinate)

Constructs a 1D position from the specified ordinate.

DirectPosition1D

public DirectPosition1D(org.opengis.spatialschema.geometry.DirectPosition point)

Constructs a position initialized to the same values than the specified point.

Method Detail

getPosition

public org.opengis.spatialschema.geometry.DirectPosition getPosition()

Returns always this, the direct position for this position.

Specified by:

getPosition in interface org.opengis.spatialschema.geometry.geometry.Position

getCoordinateReferenceSystem

public final org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()

Returns the coordinate reference system in which the coordinate is given. May be if this particular is included in a larger object with such a reference to a coordinate reference system.

Specified by:

getCoordinateReferenceSystem in interface org.opengis.spatialschema.geometry.DirectPosition

Returns:

The coordinate reference system, or .

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Set the coordinate reference system in which the coordinate is given.

Parameters:

crs - The new coordinate reference system, or .

getDimension

public final int getDimension()

The length of coordinate sequence (the number of entries). This is always 1 for DirectPosition1D objects.

Specified by:

getDimension in interface org.opengis.spatialschema.geometry.DirectPosition

Returns:

The dimensionality of this position.

getCoordinates

public double[] getCoordinates()

Returns a sequence of numbers that hold the coordinate of this position in its reference system.

Specified by:

getCoordinates in interface org.opengis.spatialschema.geometry.DirectPosition

Returns:

The coordinates

getOrdinate

public final double getOrdinate(int dimension)
                         throws java.lang.IndexOutOfBoundsException

Returns the ordinate at the specified dimension.

Specified by:

getOrdinate in interface org.opengis.spatialschema.geometry.DirectPosition

Parameters:

dimension - The dimension, which must be 0.

Returns:

The ordinate.

Throws:

java.lang.IndexOutOfBoundsException - if the specified dimension is out of bounds.

To Do:

Provides a more detailled error message.

setOrdinate

public final void setOrdinate(int dimension,
                              double value)
                       throws java.lang.IndexOutOfBoundsException

Sets the ordinate value along the specified dimension.

Specified by:

setOrdinate in interface org.opengis.spatialschema.geometry.DirectPosition

Parameters:

dimension - The dimension, which must be 0.

value - the ordinate value.

Throws:

java.lang.IndexOutOfBoundsException - if the specified dimension is out of bounds.

To Do:

Provides a more detailled error message.

setLocation

public void setLocation(org.opengis.spatialschema.geometry.DirectPosition position)
                 throws org.opengis.spatialschema.geometry.MismatchedDimensionException

Set this coordinate to the specified direct position. If the specified position contains a coordinate reference system, then the CRS for this position will be set to the CRS of the specified position.

Parameters:

position - The new position for this point.

Throws:

org.opengis.spatialschema.geometry.MismatchedDimensionException - if this point doesn't have the expected dimension.

toString

public java.lang.String toString()

Returns a string representation of this coordinate. The default implementation formats this coordinate using a shared instance of CoordinateFormat. This is okay for occasional formatting (for example for debugging purpose). But if there is a lot of positions to format, users will get better performance and more control by using their own instance of CoordinateFormat.

hashCode

public int hashCode()

Returns a hash value for this coordinate. This value need not remain consistent between different implementations of the same class.

clone

public java.lang.Object clone()

Returns a copy of this position.

Specified by:

clone in interface org.opengis.spatialschema.geometry.DirectPosition