com.revolsys.jts.noding

Class OrientedCoordinateArray

java.lang.Object

com.revolsys.jts.noding.OrientedCoordinateArray

All Implemented Interfaces:

Comparable<OrientedCoordinateArray>

public class OrientedCoordinateArray
extends Object
implements Comparable<OrientedCoordinateArray>

Allows comparing Coordinates arrays in an orientation-independent way.

Version:

1.7

Author:

Martin Davis

Constructor Summary

Constructors

Constructor and Description
OrientedCoordinateArray(LineString points) Creates a new OrientedCoordinateArray for the given Coordinates array.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(OrientedCoordinateArray oca) Compares two OrientedCoordinateArrays for their relative order
boolean	getOrientation()
LineString	getPoints()
static int	increasingDirection(LineString points) Determines which orientation of the Coordinates array is (overall) increasing.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrientedCoordinateArray

public OrientedCoordinateArray(LineString points)

Creates a new OrientedCoordinateArray for the given Coordinates array.

Parameters:

points - the coordinates to orient

Method Detail

increasingDirection

public static int increasingDirection(LineString points)

Determines which orientation of the Coordinates array is (overall) increasing. In other words, determines which end of the array is "smaller" (using the standard ordering on Coordinates). Returns an integer indicating the increasing direction. If the sequence is a palindrome, it is defined to be oriented in a positive direction.

Parameters:

points - the array of Point to test

Returns:

1 if the array is smaller at the start or is a palindrome, -1 if smaller at the end

compareTo

public int compareTo(OrientedCoordinateArray oca)

Compares two OrientedCoordinateArrays for their relative order

Specified by:

compareTo in interface Comparable<OrientedCoordinateArray>

Returns:

-1 this one is smaller; 0 the two objects are equal; 1 this one is greater

getOrientation

public boolean getOrientation()

getPoints

public LineString getPoints()