oracle.sdoapi.geom
Interface CoordPoint

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
CoordPointImpl

public interface CoordPoint
extends java.lang.Cloneable, java.io.Serializable

CoordPoint is a helper interface that represents a coordinate point. A coordinate point is not a geometric entity, but it is a conceptual part of a non-point geometric object such as a line string.

Unlike a geometric point that contains additional information (like spatial reference system information), a coordinate point only contains ordinate values and accessing methods.


Method Summary
 java.lang.Object clone()
          Clones this coordinate point to generate another coordinate point object.
 boolean equals(CoordPoint point)
          Determines if this coordinate point equals to the input coordinate point.
 double getOrd(int i)
          Gets the i-th ordinate of this coordinate point.
 double getX()
          Gets the x ordinate of this coordinate point.
 double getY()
          Gets the y ordinate of this coordinate point.
 double getZ()
          Gets the z ordinate of this coordinate point.
 void move(CoordPoint offsetPoint)
          Moves this coordinate point according to the input offsets.
 void move(double offsetX, double offsetY)
          Moves this coordinate point according to the input offsets.
 void move(double offsetX, double offsetY, double offsetZ)
          Moves this coordinate point according to the input offsets.
 void setCoord()
          Sets this coordinate point to (Double.NaN, Double.NaN, Double.NaN).
 void setCoord(CoordPoint point)
          Sets this coordinate point to the location of another coordinate point.
 void setCoord(double x, double y)
          Sets this coordinate point to (x, y, Double.NaN).
 void setCoord(double x, double y, double z)
          Sets this coordinate point to (x, y, z).
 void setCoord(Point point)
          Sets this coordinate point to the location of a geometric point.
 void setOrd(double ord, int i)
          Sets the i-th ordinate of this coordinate point.
 void setX(double x)
          Sets the x ordinate for this coordinate point.
 void setY(double y)
          Sets the y ordinate for this coordinate point.
 void setZ(double z)
          Sets the z ordinate for this coordinate point.
 

Method Detail

getX

public double getX()
Gets the x ordinate of this coordinate point.
Returns:
the x ordinate of this coordinate point

getY

public double getY()
Gets the y ordinate of this coordinate point.
Returns:
the y ordinate of this coordinate point

getZ

public double getZ()
Gets the z ordinate of this coordinate point.
Returns:
the z ordinate of this coordinate point

getOrd

public double getOrd(int i)
Gets the i-th ordinate of this coordinate point. This is a generic method that supports higher dimensional (higher than 3-D) data.
Parameters:
i - the 0-based index of the ordinates. For example, i = 0 means the first dimension (or x by convention), etc.
Returns:
the i-th coordinate of this coordinate point, or Double.NaN if the i-th ordinate is not available

setX

public void setX(double x)
Sets the x ordinate for this coordinate point.
Parameters:
x - the new x ordinate of this coordinate point

setY

public void setY(double y)
Sets the y ordinate for this coordinate point.
Parameters:
y - the new y ordinate of this coordinate point

setZ

public void setZ(double z)
Sets the z ordinate for this coordinate point.
Parameters:
z - the new z ordinate of this coordinate point

setOrd

public void setOrd(double ord,
                   int i)
Sets the i-th ordinate of this coordinate point. This is a generic method that supports higher dimensional (higher than 3-D) data
Parameters:
ord - the new value of the i-th ordinate of this coordinate point
i - the 0-based index of the ordinates. For example, i = 0 means the first dimension (or x by convention), etc.

setCoord

public void setCoord()
Sets this coordinate point to (Double.NaN, Double.NaN, Double.NaN). This method marks the current coordinate point to be invalid.

setCoord

public void setCoord(double x,
                     double y)
Sets this coordinate point to (x, y, Double.NaN).
Parameters:
x - x coordinate of the coordinate point
y - y coordinate of the coordinate point

setCoord

public void setCoord(double x,
                     double y,
                     double z)
Sets this coordinate point to (x, y, z).
Parameters:
x - x coordinate of the coordinate point
y - y coordinate of the coordinate point
z - z coordinate of the coordinate point

setCoord

public void setCoord(CoordPoint point)
Sets this coordinate point to the location of another coordinate point.

setCoord

public void setCoord(Point point)
Sets this coordinate point to the location of a geometric point.

move

public void move(double offsetX,
                 double offsetY)
Moves this coordinate point according to the input offsets.
Parameters:
offsetX - offset along the x direction
offsetY - offset along the y direction

move

public void move(double offsetX,
                 double offsetY,
                 double offsetZ)
Moves this coordinate point according to the input offsets.
Parameters:
offsetX - offset along the x direction
offsetY - offset along the y direction
offsetZ - offset along the z direction

move

public void move(CoordPoint offsetPoint)
Moves this coordinate point according to the input offsets.
Parameters:
offsetPoint - the coordinate point that contains offset values

equals

public boolean equals(CoordPoint point)
Determines if this coordinate point equals to the input coordinate point.
Parameters:
point - the input coordinate point
Returns:
true if this point has the same coordinates as the input point; false otherwise

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clones this coordinate point to generate another coordinate point object.
Overrides:
clone in class java.lang.Object
Returns:
a coordinate point object with the same content as in this coordinate point