LineString (RS Core TRUNK-SNAPSHOT API)

All Superinterfaces:

Cloneable, Comparable<Object>, DataTypeProxy, Geometry, Lineal, Serializable

All Known Subinterfaces:

LinearRing, LineSegment, Segment

All Known Implementing Classes:

AbstractLineSegment, AbstractLineString, AbstractSegment, AxisPlaneCoordinateSequence, GeometryCollectionSegment, LinearRingDoubleGf, LineSegmentDouble, LineSegmentDoubleGF, LineStringDouble, LineStringDoubleGf, LineStringSegment, MultiLineStringSegment, MultiPolygonSegment, PolygonSegment, PreparedLineString, RingCoordinatesList, Triangle
```
public interface LineString
extends Lineal
```
Models an OGC-style LineString. A LineString consists of a sequence of two or more vertices, along with all points along the linearly-interpolated curves (line segments) between each pair of consecutive vertices. Consecutive vertices may be equal. The line segments in the line may intersect each other (in other words, the linestring may "curl back" in itself and self-intersect. Linestrings with exactly two identical points are invalid.
A linestring must have either 0 or 2 or more points. If these conditions are not met, the constructors throw an IllegalArgumentException

Version:

1.7

Field Summary
- Fields inherited from interface com.revolsys.jts.geom.Geometry
  M, sortedGeometryTypes, X, Y, Z

Method Summary

Methods
Modifier and Type	Method and Description
`LineString`	`clone()` Creates and returns a full copy of this `LineString` object.
`double`	`distance(int index, Point point)`
`boolean`	`equals(int axisIndex, int vertexIndex, Point point)`
`boolean`	`equalsVertex(int vertexIndex, double... coordinates)`
`boolean`	`equalsVertex(int axisCount, int vertexIndex1, int vertexIndex2)`
`boolean`	`equalsVertex(int axisCount, int vertexIndex, LineString line2, int vertexIndex2)`
`boolean`	`equalsVertex(int axisCount, int vertexIndex, Point point)`
`boolean`	`equalsVertex(int vertexIndex, Point point)`
`double`	`getCoordinate(int vertexIndex, int axisIndex)`
`double[]`	`getCoordinates()`
`LineString`	`getCoordinatesList()`
`Point`	`getEndPoint()`
`double`	`getM(int vertexIndex)`
`Point`	`getPoint(int vertexIndex)`
`int`	`getSegmentCount()`
`Point`	`getStartPoint()`
`double`	`getX(int vertexIndex)`
`double`	`getY(int vertexIndex)`
`double`	`getZ(int vertexIndex)`
`boolean`	`hasVertex(Point point)`
`boolean`	`isClockwise()`
`boolean`	`isClosed()`
`boolean`	`isCounterClockwise()`
`boolean`	`isRing()`
`LineString`	`merge(LineString line)` Merge two lines that share common coordinates at either the start or end.
`LineString`	`merge(Point point, LineString line)`
`LineString`	`move(double... deltas)`
`LineString`	`moveVertex(Point newPoint, int vertexIndex)`
`LineString`	`normalize()` Normalizes a LineString.
`Iterable<Point>`	`points()`
`LineString`	`prepare()`
`LineString`	`reverse()` Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.
`List<LineString>`	`split(Point point)`
`LineString`	`subLine(int vertexCount)`
`LineString`	`subLine(int fromVertexIndex, int vertexCount)`
`LineString`	`subLine(int vertexCount, Point toPoint)`
`LineString`	`subLine(Point fromPoint, int fromVertexIndex, int vertexCount, Point toPoint)`

Methods inherited from interface com.revolsys.jts.geom.Geometry
appendVertex, buffer, buffer, buffer, compareTo, compareToSameClass, contains, containsProperly, convert, convert, convexHull, copy, coveredBy, covers, crosses, deleteVertex, difference, disjoint, distance, equal, equals, equals, equals, equalsExact, equalsExact, equalsNorm, equalsTopo, geometries, getArea, getAxisCount, getBoundary, getBoundaryDimension, getBoundingBox, getCentroid, getClassSortIndex, getCoordinateSystem, getDimension, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryComponents, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getLength, getPoint, getPointWithin, getSegment, getSrid, getToVertex, getUserData, getVertex, getVertexCount, hashCode, hasInvalidXyCoordinates, insertVertex, intersection, intersects, intersects, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, moveVertex, overlaps, relate, relate, segments, setUserData, symDifference, toClockwise, toCounterClockwise, touches, toWkt, union, union, vertices, within

Methods inherited from interface com.revolsys.data.types.DataTypeProxy
getDataType

Method Detail

clone
```
LineString clone()
```
Creates and returns a full copy of this LineString object. (including all coordinates contained by it).

Specified by:

clone in interface Geometry

Returns:
a clone of this instance

distance

double distance(int index,
              Point point)

equals

boolean equals(int axisIndex,
             int vertexIndex,
             Point point)

equalsVertex

boolean equalsVertex(int vertexIndex,
                   double... coordinates)

equalsVertex

boolean equalsVertex(int axisCount,
                   int vertexIndex1,
                   int vertexIndex2)

equalsVertex

boolean equalsVertex(int axisCount,
                   int vertexIndex,
                   LineString line2,
                   int vertexIndex2)

equalsVertex

boolean equalsVertex(int axisCount,
                   int vertexIndex,
                   Point point)

equalsVertex

boolean equalsVertex(int vertexIndex,
                   Point point)

getCoordinate

double getCoordinate(int vertexIndex,
                   int axisIndex)

getCoordinates
```
double[] getCoordinates()
```

getCoordinatesList
```
LineString getCoordinatesList()
```

getEndPoint
```
Point getEndPoint()
```

getM
```
double getM(int vertexIndex)
```

getPoint
```
Point getPoint(int vertexIndex)
```

getSegmentCount
```
int getSegmentCount()
```

getStartPoint
```
Point getStartPoint()
```

getX
```
double getX(int vertexIndex)
```

getY
```
double getY(int vertexIndex)
```

getZ
```
double getZ(int vertexIndex)
```

hasVertex
```
boolean hasVertex(Point point)
```

isClockwise
```
boolean isClockwise()
```

isClosed
```
boolean isClosed()
```

isCounterClockwise
```
boolean isCounterClockwise()
```

isRing
```
boolean isRing()
```

merge
```
LineString merge(LineString line)
```
Merge two lines that share common coordinates at either the start or end. If the lines touch only at their start coordinates, the line2 will be reversed and joined before the start of line1. If the two lines touch only at their end coordinates, the line2 will be reversed and joined after the end of line1.

Parameters:
line1 - The first line.
line2 - The second line.

Returns:
The new line string

merge

LineString merge(Point point,
               LineString line)

move
```
LineString move(double... deltas)
```
Specified by:

move in interface Geometry

moveVertex

LineString moveVertex(Point newPoint,
                    int vertexIndex)

normalize
```
LineString normalize()
```
Normalizes a LineString. A normalized linestring has the first point which is not equal to it's reflected point less than the reflected point.

Specified by:

normalize in interface Geometry

Returns:
a normalized copy of this geometry.
See Also:
Geometry.normalize()

points
```
Iterable<Point> points()
```

prepare
```
LineString prepare()
```
Specified by:

prepare in interface Geometry

reverse
```
LineString reverse()
```
Description copied from interface: Geometry

Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.

Specified by:

reverse in interface Geometry

Returns:
a reversed geometry

split
```
List<LineString> split(Point point)
```

subLine
```
LineString subLine(int vertexCount)
```

subLine

LineString subLine(int fromVertexIndex,
                 int vertexCount)

subLine

LineString subLine(int vertexCount,
                 Point toPoint)

subLine

LineString subLine(Point fromPoint,
                 int fromVertexIndex,
                 int vertexCount,
                 Point toPoint)

Interface LineString

Field Summary

Fields inherited from interface com.revolsys.jts.geom.Geometry

Method Summary

Methods inherited from interface com.revolsys.jts.geom.Geometry

Methods inherited from interface com.revolsys.data.types.DataTypeProxy

Method Detail

clone

distance

equals

equalsVertex

equalsVertex

equalsVertex

equalsVertex

equalsVertex

getCoordinate

getCoordinates

getCoordinatesList

getEndPoint

getM

getPoint

getSegmentCount

getStartPoint

getX

getY

getZ

hasVertex

isClockwise

isClosed

isCounterClockwise

isRing

merge

merge

move

moveVertex

normalize

points

prepare

reverse

split

subLine

subLine

subLine

subLine