Class PackedCoordinateSequence

java.lang.Object
org.locationtech.jts.geom.impl.PackedCoordinateSequence
All Implemented Interfaces:
Serializable, Cloneable, CoordinateSequence
Direct Known Subclasses:
PackedCoordinateSequence.Double, PackedCoordinateSequence.Float
public abstract class PackedCoordinateSequence extends Object implements CoordinateSequence, Serializable
A CoordinateSequence implementation based on a packed arrays. In this implementation, Coordinates returned by #toArray and #get are copies of the internal values. To change the actual values, use the provided setters.

For efficiency, created Coordinate arrays are cached using a soft reference. The cache is cleared each time the coordinate sequence contents are modified through a setter method.

Version:
1.7
See Also:

  • Field Details

    • dimension

      protected int dimension
      The dimensions of the coordinates held in the packed array

    • measures

      protected int measures
      The number of measures of the coordinates held in the packed array.

    • coordRef

      protected transient SoftReference<Coordinate[]> coordRef
      A soft reference to the Coordinate[] representation of this sequence. Makes repeated coordinate array accesses more efficient.

  • Constructor Details

    • PackedCoordinateSequence

      protected PackedCoordinateSequence(int dimension, int measures)
      Creates an instance of this class
      Parameters:
      dimension - the total number of ordinates that make up a Coordinate in this sequence.
      measures - the number of measure-ordinates each Coordinate in this sequence has.

  • Method Details

    • getDimension

      public int getDimension()
      Description copied from interface: CoordinateSequence
      Returns the dimension (number of ordinates in each coordinate) for this sequence.

      This total includes any measures, indicated by non-zero CoordinateSequence.getMeasures().

      Specified by:
      getDimension in interface CoordinateSequence
      Returns:
      the dimension of the sequence.
      See Also:

    • getMeasures

      public int getMeasures()
      Description copied from interface: CoordinateSequence
      Returns the number of measures included in CoordinateSequence.getDimension() for each coordinate for this sequence. For a measured coordinate sequence a non-zero value is returned.
      • For XY sequence measures is zero
      • For XYM sequence measure is one
      • For XYZ sequence measure is zero
      • For XYZM sequence measure is one
      • Values greater than one are supported
      Specified by:
      getMeasures in interface CoordinateSequence
      Returns:
      the number of measures included in dimension
      See Also:

    • getCoordinate

      public Coordinate getCoordinate(int i)
      Description copied from interface: CoordinateSequence
      Returns (possibly a copy of) the i'th coordinate in this sequence. Whether or not the Coordinate returned is the actual underlying Coordinate or merely a copy depends on the implementation.

      Note that in the future the semantics of this method may change to guarantee that the Coordinate returned is always a copy. Callers should not to assume that they can modify a CoordinateSequence by modifying the object returned by this method.

      Specified by:
      getCoordinate in interface CoordinateSequence
      Parameters:
      i - the index of the coordinate to retrieve
      Returns:
      the i'th coordinate in the sequence
      See Also:

    • getCoordinateCopy

      public Coordinate getCoordinateCopy(int i)
      Description copied from interface: CoordinateSequence
      Returns a copy of the i'th coordinate in this sequence. This method optimizes the situation where the caller is going to make a copy anyway - if the implementation has already created a new Coordinate object, no further copy is needed.
      Specified by:
      getCoordinateCopy in interface CoordinateSequence
      Parameters:
      i - the index of the coordinate to retrieve
      Returns:
      a copy of the i'th coordinate in the sequence
      See Also:

    • getCoordinate

      public void getCoordinate(int i, Coordinate coord)
      Description copied from interface: CoordinateSequence
      Copies the i'th coordinate in the sequence to the supplied Coordinate. Only the first two dimensions are copied.
      Specified by:
      getCoordinate in interface CoordinateSequence
      Parameters:
      i - the index of the coordinate to copy
      coord - a Coordinate to receive the value
      See Also:

    • toCoordinateArray

      public Coordinate[] toCoordinateArray()
      Description copied from interface: CoordinateSequence
      Returns (possibly copies of) the Coordinates in this collection. Whether or not the Coordinates returned are the actual underlying Coordinates or merely copies depends on the implementation. Note that if this implementation does not store its data as an array of Coordinates, this method will incur a performance penalty because the array needs to be built from scratch.
      Specified by:
      toCoordinateArray in interface CoordinateSequence
      Returns:
      a array of coordinates containing the point values in this sequence
      See Also:

    • getX

      public double getX(int index)
      Description copied from interface: CoordinateSequence
      Returns ordinate X (0) of the specified coordinate.
      Specified by:
      getX in interface CoordinateSequence
      Parameters:
      index - the coordinate index in the sequence
      Returns:
      the value of the X ordinate in the index'th coordinate
      See Also:

    • getY

      public double getY(int index)
      Description copied from interface: CoordinateSequence
      Returns ordinate Y (1) of the specified coordinate.
      Specified by:
      getY in interface CoordinateSequence
      Parameters:
      index - the coordinate index in the sequence
      Returns:
      the value of the Y ordinate in the index'th coordinate
      See Also:

    • getOrdinate

      public abstract double getOrdinate(int index, int ordinateIndex)
      Description copied from interface: CoordinateSequence
      Returns the ordinate of a coordinate in this sequence. Ordinate indices 0 and 1 are assumed to be X and Y.

      Ordinates indices greater than 1 have user-defined semantics (for instance, they may contain other dimensions or measure values as described by CoordinateSequence.getDimension() and CoordinateSequence.getMeasures()).

      Specified by:
      getOrdinate in interface CoordinateSequence
      Parameters:
      index - the coordinate index in the sequence
      ordinateIndex - the ordinate index in the coordinate (in range [0, dimension-1])
      Returns:
      ordinate value
      See Also:

    • setX

      public void setX(int index, double value)
      Sets the first ordinate of a coordinate in this sequence.
      Parameters:
      index - the coordinate index
      value - the new ordinate value

    • setY

      public void setY(int index, double value)
      Sets the second ordinate of a coordinate in this sequence.
      Parameters:
      index - the coordinate index
      value - the new ordinate value

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • readResolve

      protected Object readResolve() throws ObjectStreamException
      Throws:
      ObjectStreamException

    • getCoordinateInternal

      protected abstract Coordinate getCoordinateInternal(int index)
      Returns a Coordinate representation of the specified coordinate, by always building a new Coordinate object
      Parameters:
      index - the coordinate index
      Returns:
      the Coordinate at the given index

    • clone

      public abstract Object clone()
      Deprecated.
      Description copied from interface: CoordinateSequence
      Returns a deep copy of this collection. Called by Geometry#clone.
      Specified by:
      clone in interface CoordinateSequence
      Overrides:
      clone in class Object
      Returns:
      a copy of the coordinate sequence containing copies of all points
      See Also:

    • copy

      public abstract PackedCoordinateSequence copy()
      Description copied from interface: CoordinateSequence
      Returns a deep copy of this collection.
      Specified by:
      copy in interface CoordinateSequence
      Returns:
      a copy of the coordinate sequence containing copies of all points

    • setOrdinate

      public abstract void setOrdinate(int index, int ordinate, double value)
      Sets the ordinate of a coordinate in this sequence.
      Warning: for performance reasons the ordinate index is not checked - if it is over dimensions you may not get an exception but a meaningless value.
      Specified by:
      setOrdinate in interface CoordinateSequence
      Parameters:
      index - the coordinate index
      ordinate - the ordinate index in the coordinate, 0 based, smaller than the number of dimensions
      value - the new ordinate value