com.revolsys.jts.geom

Class CoordinateArrays

java.lang.Object

com.revolsys.jts.geom.CoordinateArrays

public class CoordinateArrays
extends Object

Useful utility functions for handling Point arrays

Version:

1.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinateArrays.ForwardComparator A Comparator for Coordinates arrays in the forward direction of their coordinates, using lexicographic ordering.

Constructor Summary

Constructors

Constructor and Description
CoordinateArrays()

Method Summary

Methods

Modifier and Type	Method and Description
static Point[]	atLeastNCoordinatesOrNothing(int n, Point[] c) Returns either the given coordinate array if its length is greater than the given amount, or an empty coordinate array.
static int	compare(Point[] pts1, Point[] pts2) Compares two Coordinates arrays in the forward direction of their coordinates, using lexicographic ordering.
static Point[]	copyDeep(Point[] coordinates) Creates a deep copy of the argument Coordinates array.
static void	copyDeep(Point[] src, int srcStart, Point[] dest, int destStart, int length) Creates a deep copy of a given section of a source Coordinates array into a destination Point array.
static boolean	equals(Point[] coord1, Point[] coord2) Returns true if the two arrays are identical, both null, or pointwise equal (as compared using Coordinate#equals)
static boolean	equals(Point[] coord1, Point[] coord2, Comparator coordinateComparator) Returns true if the two arrays are identical, both null, or pointwise equal, using a user-defined Comparator for Coordinates s
static Point[]	extract(Point[] pts, int start, int end) Extracts a subsequence of the input Coordinates array from indices start to end (inclusive).
static boolean	hasRepeatedPoints(Point[] coord) Returns whether #equals returns true for any two consecutive Coordinates in the given array.
static int	indexOf(Point coordinate, Point[] coordinates) Returns the index of coordinate in coordinates.
static boolean	isRing(Point[] pts) Tests whether an array of Coordinatess forms a ring, by checking length and closure.
static Point	ptNotInList(Point[] testPts, Point[] pts) Finds a point in a list of points which is not contained in another list of points
static Point[]	removeNull(Point[] coord) Collapses a coordinate array to remove all null elements.
static Point[]	removeRepeatedPoints(Point[] coord) If the coordinate array argument has repeated points, constructs a new array containing no repeated points.
static void	reverse(Point[] coord) Reverses the coordinates in an array in-place.
static Point[]	toCoordinateArray(Collection coordList) Converts the given Collection of Point into a Point array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinateArrays

public CoordinateArrays()

Method Detail

atLeastNCoordinatesOrNothing

public static Point[] atLeastNCoordinatesOrNothing(int n,
                                   Point[] c)

Returns either the given coordinate array if its length is greater than the given amount, or an empty coordinate array.

compare

public static int compare(Point[] pts1,
          Point[] pts2)

Compares two Coordinates arrays in the forward direction of their coordinates, using lexicographic ordering.

Parameters:

pts1 -

pts2 -

Returns:

an integer indicating the order

copyDeep

public static Point[] copyDeep(Point[] coordinates)

Creates a deep copy of the argument Coordinates array.

Parameters:

coordinates - an array of Coordinates

Returns:

a deep copy of the input

copyDeep

public static void copyDeep(Point[] src,
            int srcStart,
            Point[] dest,
            int destStart,
            int length)

Creates a deep copy of a given section of a source Coordinates array into a destination Point array. The destination array must be an appropriate size to receive the copied coordinates.

Parameters:

src - an array of Coordinates

srcStart - the index to start copying from

dest - the

destStart - the destination index to start copying to

length - the number of items to copy

equals

public static boolean equals(Point[] coord1,
             Point[] coord2)

Returns true if the two arrays are identical, both null, or pointwise equal (as compared using Coordinate#equals)

See Also:

Geometry.equals(Object)

equals

public static boolean equals(Point[] coord1,
             Point[] coord2,
             Comparator coordinateComparator)

Returns true if the two arrays are identical, both null, or pointwise equal, using a user-defined Comparator for Coordinates s

Parameters:

coord1 - an array of Coordinates

coord2 - an array of Coordinates

coordinateComparator - a Comparator for Coordinates

extract

public static Point[] extract(Point[] pts,
              int start,
              int end)

Extracts a subsequence of the input Coordinates array from indices start to end (inclusive). The input indices are clamped to the array size; If the end index is less than the start index, the extracted array will be empty.

Parameters:

pts - the input array

start - the index of the start of the subsequence to extract

end - the index of the end of the subsequence to extract

Returns:

a subsequence of the input array

hasRepeatedPoints

public static boolean hasRepeatedPoints(Point[] coord)

Returns whether #equals returns true for any two consecutive Coordinates in the given array.

indexOf

public static int indexOf(Point coordinate,
          Point[] coordinates)

Returns the index of coordinate in coordinates. The first position is 0; the second, 1; etc.

Parameters:

coordinate - the Coordinate to search for

coordinates - the array to search

Returns:

the position of coordinate, or -1 if it is not found

isRing

public static boolean isRing(Point[] pts)

Tests whether an array of Coordinatess forms a ring, by checking length and closure. Self-intersection is not checked.

Parameters:

pts - an array of Coordinates

Returns:

true if the coordinate form a ring.

ptNotInList

public static Point ptNotInList(Point[] testPts,
                Point[] pts)

Finds a point in a list of points which is not contained in another list of points

Parameters:

testPts - the Coordinatess to test

pts - an array of Coordinatess to test the input points against

Returns:

a Coordinates from testPts which is not in pts, ' or null

removeNull

public static Point[] removeNull(Point[] coord)

Collapses a coordinate array to remove all null elements.

Parameters:

coord - the coordinate array to collapse

Returns:

an array containing only non-null elements

removeRepeatedPoints

public static Point[] removeRepeatedPoints(Point[] coord)

If the coordinate array argument has repeated points, constructs a new array containing no repeated points. Otherwise, returns the argument.

See Also:

hasRepeatedPoints(Point[])

reverse

public static void reverse(Point[] coord)

Reverses the coordinates in an array in-place.

toCoordinateArray

public static Point[] toCoordinateArray(Collection coordList)

Converts the given Collection of Point into a Point array.