com.revolsys.gis.algorithm

Class LineStringLocation

java.lang.Object

com.revolsys.gis.algorithm.LineStringLocation

All Implemented Interfaces:

Comparable<LineStringLocation>

public class LineStringLocation
extends Object
implements Comparable<LineStringLocation>

Represents a location along a LineString.

Constructor Summary

Constructors

Constructor and Description
LineStringLocation(LineString line, int segmentIndex, double segmentFraction)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
static int	compareLocationValues(int segmentIndex0, double segmentFraction0, int segmentIndex1, double segmentFraction1)
int	compareTo(LineStringLocation other) Compares this object with the specified object for order.
Point	getCoordinate()
LineString	getLine()
double	getSegmentFraction()
int	getSegmentIndex()
boolean	isFirst()
boolean	isLast()
boolean	isVertex()
static Point	pointAlongSegmentByFraction(Point p0, Point p1, double frac) Computes the location of a point a given length along a line segment.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineStringLocation

public LineStringLocation(LineString line,
                  int segmentIndex,
                  double segmentFraction)

Method Detail

compareLocationValues

public static int compareLocationValues(int segmentIndex0,
                        double segmentFraction0,
                        int segmentIndex1,
                        double segmentFraction1)

pointAlongSegmentByFraction

public static Point pointAlongSegmentByFraction(Point p0,
                                Point p1,
                                double frac)

Computes the location of a point a given length along a line segment. If the length exceeds the length of the line segment the last point of the segment is returned. If the length is negative the first point of the segment is returned.

Parameters:

p0 - the first point of the line segment

p1 - the last point of the line segment

length - the length to the desired point

Returns:

the Coordinates of the desired point

clone

public Object clone()

Overrides:

clone in class Object

compareTo

public int compareTo(LineStringLocation other)

Compares this object with the specified object for order.

Specified by:

compareTo in interface Comparable<LineStringLocation>

Parameters:

o - the LineStringLocation with which this Coordinate is being compared

Returns:

a negative integer, zero, or a positive integer as this LineStringLocation is less than, equal to, or greater than the specified LineStringLocation

getCoordinate

public Point getCoordinate()

getLine

public LineString getLine()

getSegmentFraction

public double getSegmentFraction()

getSegmentIndex

public int getSegmentIndex()

isFirst

public boolean isFirst()

isLast

public boolean isLast()

isVertex

public boolean isVertex()