
JTS Topology Suite version 1.12  
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object com.vividsolutions.jts.linearref.LocationIndexedLine
public class LocationIndexedLine
Supports linear referencing
along a linear Geometry
using LinearLocation
s as the index.
Constructor Summary  

LocationIndexedLine(Geometry linearGeom)
Constructs an object which allows linear referencing along a given linear Geometry . 
Method Summary  

LinearLocation 
clampIndex(LinearLocation index)
Computes a valid index for this line by clamping the given index to the valid range of index values 
Geometry 
extractLine(LinearLocation startIndex,
LinearLocation endIndex)
Computes the LineString for the interval
on the line between the given indices. 
Coordinate 
extractPoint(LinearLocation index)
Computes the Coordinate for the point
on the line at the given index. 
Coordinate 
extractPoint(LinearLocation index,
double offsetDistance)
Computes the Coordinate for the point
on the line at the given index, offset by the given distance. 
LinearLocation 
getEndIndex()
Returns the index of the end of the line 
LinearLocation 
getStartIndex()
Returns the index of the start of the line 
LinearLocation 
indexOf(Coordinate pt)
Computes the index for a given point on the line. 
LinearLocation 
indexOfAfter(Coordinate pt,
LinearLocation minIndex)
Finds the index for a point on the line which is greater than the given index. 
LinearLocation[] 
indicesOf(Geometry subLine)
Computes the indices for a subline of the line. 
boolean 
isValidIndex(LinearLocation index)
Tests whether an index is in the valid index range for the line. 
LinearLocation 
project(Coordinate pt)
Computes the index for the closest point on the line to the given point. 
Methods inherited from class java.lang.Object 

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

public LocationIndexedLine(Geometry linearGeom)
Geometry
.
linearGeom
 the linear geometry to reference alongMethod Detail 

public Coordinate extractPoint(LinearLocation index)
Coordinate
for the point
on the line at the given index.
If the index is out of range the first or last point on the
line will be returned.
The Zordinate of the computed point will be interpolated from
the Zordinates of the line segment containing it, if they exist.
length
 the index of the desired point
public Coordinate extractPoint(LinearLocation index, double offsetDistance)
Coordinate
for the point
on the line at the given index, offset by the given distance.
If the index is out of range the first or last point on the
line will be returned.
The computed point is offset to the left of the line if the offset distance is
positive, to the right if negative.
The Zordinate of the computed point will be interpolated from
the Zordinates of the line segment containing it, if they exist.
index
 the index of the desired pointoffsetDistance
 the distance the point is offset from the segment
(positive is to the left, negative is to the right)
public Geometry extractLine(LinearLocation startIndex, LinearLocation endIndex)
LineString
for the interval
on the line between the given indices.
startIndex
 the index of the start of the intervalendIndex
 the index of the end of the interval
public LinearLocation indexOf(Coordinate pt)
The supplied point does not necessarily have to lie precisely
on the line, but if it is far from the line the accuracy and
performance of this function is not guaranteed.
Use project(com.vividsolutions.jts.geom.Coordinate)
to compute a guaranteed result for points
which may be far from the line.
pt
 a point on the line
project
public LinearLocation indexOfAfter(Coordinate pt, LinearLocation minIndex)
project(com.vividsolutions.jts.geom.Coordinate)
to compute a guaranteed result for points
which may be far from the line.
pt
 a point on the lineminIndex
 the value the returned index must be greater than
project
public LinearLocation[] indicesOf(Geometry subLine)
subLine
 a subLine of the line
public LinearLocation project(Coordinate pt)
pt
 a point on the line
public LinearLocation getStartIndex()
public LinearLocation getEndIndex()
public boolean isValidIndex(LinearLocation index)
length
 the index to test
true
if the index is in the valid rangepublic LinearLocation clampIndex(LinearLocation index)

JTS Topology Suite version 1.12  
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 