LocationIndexedLine (RS Core TRUNK-SNAPSHOT API)

java.lang.Object
- com.revolsys.jts.linearref.LocationIndexedLine

```
public class LocationIndexedLine
extends Object
```
Supports linear referencing along a linear Geometry using LinearLocations as the index.

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`LocationIndexedLine(Geometry linearGeom)` Constructs an object which allows linear referencing along a given linear `Geometry`.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`Point`	`extractPoint(LinearLocation index)` Computes the `Coordinates` for the point on the line at the given index.
`Point`	`extractPoint(LinearLocation index, double offsetDistance)` Computes the `Coordinates` 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(Point pt)` Computes the index for a given point on the line.
`LinearLocation`	`indexOfAfter(Point 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(Point 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
  - LocationIndexedLine
```
public LocationIndexedLine(Geometry linearGeom)
```
    Constructs an object which allows linear referencing along a given linear Geometry.
    
    Parameters:
    linearGeom - the linear geometry to reference along
- Method Detail
  - clampIndex
```
public LinearLocation clampIndex(LinearLocation index)
```
    Computes a valid index for this line by clamping the given index to the valid range of index values
    
    Returns:
    a valid index value
  - extractLine
```
public Geometry extractLine(LinearLocation startIndex,
                   LinearLocation endIndex)
```
    Computes the LineString for the interval on the line between the given indices.
    
    Parameters:
    startIndex - the index of the start of the interval
    endIndex - the index of the end of the interval
    
    Returns:
    the linear interval between the indices
  - extractPoint
```
public Point extractPoint(LinearLocation index)
```
    Computes the Coordinates 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 Z-ordinate of the computed point will be interpolated from the Z-ordinates of the line segment containing it, if they exist.
    
    Parameters:
    index - the index of the desired point
    
    Returns:
    the Point at the given index
  - extractPoint
```
public Point extractPoint(LinearLocation index,
                 double offsetDistance)
```
    Computes the Coordinates 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 Z-ordinate of the computed point will be interpolated from the Z-ordinates of the line segment containing it, if they exist.
    
    Parameters:
    index - the index of the desired point
    offsetDistance - the distance the point is offset from the segment (positive is to the left, negative is to the right)
    
    Returns:
    the Point at the given index
  - getEndIndex
```
public LinearLocation getEndIndex()
```
    Returns the index of the end of the line
    
    Returns:
    the location index
  - getStartIndex
```
public LinearLocation getStartIndex()
```
    Returns the index of the start of the line
    
    Returns:
    the location index
  - indexOf
```
public LinearLocation indexOf(Point pt)
```
    Computes the index for a given point on the line.
    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.revolsys.jts.geom.Point) to compute a guaranteed result for points which may be far from the line.
    
    Parameters:
    pt - a point on the line
    
    Returns:
    the index of the point
    See Also:
    project(Point)
  - indexOfAfter
```
public LinearLocation indexOfAfter(Point pt,
                          LinearLocation minIndex)
```
    Finds the index for a point on the line which is greater than the given index. If no such index exists, returns minIndex. This method can be used to determine all indexes for a point which occurs more than once on a non-simple line. It can also be used to disambiguate cases where the given point lies slightly off the line and is equidistant from two different points on the line. 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.revolsys.jts.geom.Point) to compute a guaranteed result for points which may be far from the line.
    
    Parameters:
    pt - a point on the line
    minIndex - the value the returned index must be greater than
    
    Returns:
    the index of the point greater than the given minimum index
    See Also:
    project(Point)
  - indicesOf
```
public LinearLocation[] indicesOf(Geometry subLine)
```
    Computes the indices for a subline of the line. (The subline must conform to the line; that is, all vertices in the subline (except possibly the first and last) must be vertices of the line and occcur in the same order).
    
    Parameters:
    subLine - a subLine of the line
    
    Returns:
    a pair of indices for the start and end of the subline.
  - isValidIndex
```
public boolean isValidIndex(LinearLocation index)
```
    Tests whether an index is in the valid index range for the line.
    
    Parameters:
    index - the index to test
    
    Returns:
    true if the index is in the valid range
  - project
```
public LinearLocation project(Point pt)
```
    Computes the index for the closest point on the line to the given point. If more than one point has the closest distance the first one along the line is returned. (The point does not necessarily have to lie precisely on the line.)
    
    Parameters:
    pt - a point on the line
    
    Returns:
    the index of the point

Class LocationIndexedLine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocationIndexedLine

Method Detail

clampIndex

extractLine

extractPoint

extractPoint

getEndIndex

getStartIndex

indexOf

indexOfAfter

indicesOf

isValidIndex

project