Interface CoordinateSequence

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int M
      Standard ordinate index value for, where M is 3.
      static int X
      Standard ordinate index value for, where X is 0
      static int Y
      Standard ordinate index value for, where Y is 1
      static int Z
      Standard z-ordinate index
    • Method Detail

      • getDimension

        int getDimension()
        Returns the dimension (number of ordinates in each coordinate) for this sequence.

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

        Returns:
        the dimension of the sequence.
      • getMeasures

        default int getMeasures()
        Returns the number of measures included in 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
        Returns:
        the number of measures included in dimension
      • hasM

        default boolean hasM()
        Tests whether the coordinates in the sequence have measures associated with them. Returns true if getMeasures() > 0. See getMeasures() to determine the number of measures present.
        Returns:
        true if getM(int) is supported.
        See Also:
        getMeasures(), getM(int)
      • getCoordinate

        Coordinate getCoordinate​(int i)
        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.

        Parameters:
        i - the index of the coordinate to retrieve
        Returns:
        the i'th coordinate in the sequence
      • getCoordinateCopy

        Coordinate getCoordinateCopy​(int i)
        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.
        Parameters:
        i - the index of the coordinate to retrieve
        Returns:
        a copy of the i'th coordinate in the sequence
      • getCoordinate

        void getCoordinate​(int index,
                           Coordinate coord)
        Copies the i'th coordinate in the sequence to the supplied Coordinate. Only the first two dimensions are copied.
        Parameters:
        index - the index of the coordinate to copy
        coord - a Coordinate to receive the value
      • getX

        double getX​(int index)
        Returns ordinate X (0) of the specified coordinate.
        Parameters:
        index - the coordinate index in the sequence
        Returns:
        the value of the X ordinate in the index'th coordinate
      • getY

        double getY​(int index)
        Returns ordinate Y (1) of the specified coordinate.
        Parameters:
        index - the coordinate index in the sequence
        Returns:
        the value of the Y ordinate in the index'th coordinate
      • getZ

        default double getZ​(int index)
        Returns ordinate Z of the specified coordinate if available.
        Parameters:
        index - the coordinate index in the sequence
        Returns:
        the value of the Z ordinate in the index'th coordinate, or Double.NaN if not defined.
      • getM

        default double getM​(int index)
        Returns ordinate M of the specified coordinate if available.
        Parameters:
        index - the coordinate index in the sequence
        Returns:
        the value of the M ordinate in the index'th coordinate, or Double.NaN if not defined.
      • getOrdinate

        double getOrdinate​(int index,
                           int ordinateIndex)
        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 getDimension() and getMeasures()).

        Parameters:
        index - the coordinate index in the sequence
        ordinateIndex - the ordinate index in the coordinate (in range [0, dimension-1])
        Returns:
        ordinate value
      • size

        int size()
        Returns the number of coordinates in this sequence.
        Returns:
        the size of the sequence
      • setOrdinate

        void setOrdinate​(int index,
                         int ordinateIndex,
                         double value)
        Sets the value for a given ordinate of a coordinate in this sequence.
        Parameters:
        index - the coordinate index in the sequence
        ordinateIndex - the ordinate index in the coordinate (in range [0, dimension-1])
        value - the new ordinate value
      • toCoordinateArray

        Coordinate[] toCoordinateArray()
        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.
        Returns:
        a array of coordinates containing the point values in this sequence
      • expandEnvelope

        Envelope expandEnvelope​(Envelope env)
        Expands the given Envelope to include the coordinates in the sequence. Allows implementing classes to optimize access to coordinate values.
        Parameters:
        env - the envelope to expand
        Returns:
        a ref to the expanded envelope
      • clone

        java.lang.Object clone()
        Deprecated.
        Recommend copy()
        Returns a deep copy of this collection. Called by Geometry#clone.
        Returns:
        a copy of the coordinate sequence containing copies of all points
      • copy

        CoordinateSequence copy()
        Returns a deep copy of this collection.
        Returns:
        a copy of the coordinate sequence containing copies of all points