Class CoordinateXY

java.lang.Object
org.locationtech.jts.geom.Coordinate
org.locationtech.jts.geom.CoordinateXY
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Coordinate>
public class CoordinateXY extends Coordinate
Coordinate subclass supporting XY ordinates.

This data object is suitable for use with coordinate sequences with dimension = 2.

The Coordinate.z field is visible, but intended to be ignored.

Since:
1.16
See Also:

  • Field Details

  • Constructor Details

    • CoordinateXY

      public CoordinateXY()
      Default constructor

    • CoordinateXY

      public CoordinateXY(double x, double y)
      Constructs a CoordinateXY instance with the given ordinates.
      Parameters:
      x - the X ordinate
      y - the Y ordinate

    • CoordinateXY

      public CoordinateXY(Coordinate coord)
      Constructs a CoordinateXY instance with the x and y ordinates of the given Coordinate.
      Parameters:
      coord - the Coordinate providing the ordinates

    • CoordinateXY

      public CoordinateXY(CoordinateXY coord)
      Constructs a CoordinateXY instance with the x and y ordinates of the given CoordinateXY.
      Parameters:
      coord - the CoordinateXY providing the ordinates

  • Method Details

    • copy

      public CoordinateXY copy()
      Creates a copy of this CoordinateXY.
      Overrides:
      copy in class Coordinate
      Returns:
      a copy of this CoordinateXY

    • create

      public Coordinate create()
      Create a new Coordinate of the same type as this Coordinate, but with no values.
      Overrides:
      create in class Coordinate
      Returns:
      a new Coordinate

    • getZ

      public double getZ()
      The z-ordinate is not supported
      Overrides:
      getZ in class Coordinate
      Returns:
      the value of the Z ordinate, or NaN

    • setZ

      public void setZ(double z)
      The z-ordinate is not supported
      Overrides:
      setZ in class Coordinate
      Parameters:
      z - the value to set as Z

    • setCoordinate

      public void setCoordinate(Coordinate other)
      Description copied from class: Coordinate
      Sets this Coordinates (x,y,z) values to that of other.
      Overrides:
      setCoordinate in class Coordinate
      Parameters:
      other - the Coordinate to copy

    • getOrdinate

      public double getOrdinate(int ordinateIndex)
      Description copied from class: Coordinate
      Gets the ordinate value for the given index. The base implementation supports values for the index are Coordinate.X, Coordinate.Y, and Coordinate.Z.
      Overrides:
      getOrdinate in class Coordinate
      Parameters:
      ordinateIndex - the ordinate index
      Returns:
      the value of the ordinate

    • setOrdinate

      public void setOrdinate(int ordinateIndex, double value)
      Description copied from class: Coordinate
      Sets the ordinate for the given index to a given value. The base implementation supported values for the index are Coordinate.X, Coordinate.Y, and Coordinate.Z.
      Overrides:
      setOrdinate in class Coordinate
      Parameters:
      ordinateIndex - the ordinate index
      value - the value to set

    • toString

      public String toString()
      Description copied from class: Coordinate
      Returns a String of the form (x,y,z) .
      Overrides:
      toString in class Coordinate
      Returns:
      a String of the form (x,y,z)