com.revolsys.jts.geom.impl

Class AbstractLineString

java.lang.Object

com.revolsys.jts.geom.impl.AbstractGeometry

com.revolsys.jts.geom.impl.AbstractLineString

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractLineSegment, AxisPlaneCoordinateSequence, LineStringDouble, LineStringDoubleGf, PreparedLineString, Triangle

public abstract class AbstractLineString
extends AbstractGeometry
implements LineString

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

See Also:

Serialized Form

Field Summary

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

M, sortedGeometryTypes, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
AbstractLineString()

Method Summary

Methods

Modifier and Type	Method and Description
<V extends Geometry> V	appendVertex(Point newPoint, int... geometryId)
AbstractLineString	clone() Creates and returns a full copy of this LineString object.
int	compareToSameClass(Geometry geometry) Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.
protected BoundingBox	computeBoundingBox() Returns the minimum and maximum x and y values in this Geometry , or a null BoundingBoxDoubleGf if this Geometry is empty.
protected double[]	convertCoordinates(GeometryFactory geometryFactory)
<V extends Geometry> V	copy(GeometryFactory geometryFactory) Create a copy of the geometry io the requried geometry factory.
<V extends Geometry> V	deleteVertex(int... vertexId)
LineString	deleteVertex(int vertexIndex)
double	distance(int index, Point point)
boolean	doEquals(int axisCount, Geometry geometry)
boolean	equals(int axisCount, int vertexIndex, Point point)
boolean	equalsExact(Geometry other, double tolerance) Returns true if the two Geometrys are exactly equal, up to a specified distance tolerance.
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)
Geometry	getBoundary() Gets the boundary of this geometry.
int	getBoundaryDimension() Returns the dimension of this Geometrys inherent boundary.
abstract double[]	getCoordinates()
LineString	getCoordinatesList()
DataType	getDataType()
int	getDimension() Returns the dimension of this geometry.
Point	getEndPoint()
double	getLength() Returns the length of this LineString
double	getM(int vertexIndex)
int	getMinVertexCount()
Point	getPoint() Returns a vertex of this Geometry (usually, but not necessarily, the first one).
Point	getPoint(int vertexIndex)
Point	getPointWithin()
LineStringSegment	getSegment(int... segmentId) Get the Segment at the specified vertexId (see Segment.getSegmentId()).
int	getSegmentCount()
Point	getStartPoint()
AbstractVertex	getToVertex(int... vertexId) Get the Vertex at the specified vertexId starting at the end of the geometry (see Vertex.getVertexId()).
AbstractVertex	getVertex(int... vertexId) Get the Vertex at the specified vertexId (see Vertex.getVertexId()).
double	getX(int vertexIndex)
double	getY(int vertexIndex)
double	getZ(int vertexIndex)
boolean	hasVertex(Point point)
<V extends Geometry> V	insertVertex(Point newPoint, int... vertexId)
boolean	intersects(BoundingBox boundingBox)
boolean	isClockwise()
boolean	isClosed()
boolean	isCounterClockwise()
protected boolean	isEquivalentClass(Geometry other) Returns whether the two Geometrys are equal, from the point of view of the equalsExact method.
boolean	isRing()
LineString	merge(LineString line2) Merge two lines that share common coordinates at either the start or end.
LineString	merge(Point point, LineString line2)
LineString	move(double... deltas)
protected double[]	moveCoordinates(double... deltas)
<V extends Geometry> V	moveVertex(Point newPoint, int... vertexId)
LineString	moveVertex(Point newPoint, int vertexIndex)
LineString	normalize() Normalizes a LineString.
int	orientationIndex(int index1, int index2, int index)
Iterable<Point>	points()
LineString	prepare() Deprecated.
LineString	reverse() Creates a LineString whose coordinates are in the reverse order of this objects
Reader<Segment>	segments()
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)
<G extends Geometry> G	toClockwise()
<G extends Geometry> G	toCounterClockwise()
Reader<Vertex>	vertices() Get an Iterable that iterates over the Vertex of the geometry.

Methods inherited from class com.revolsys.jts.geom.impl.AbstractGeometry

buffer, buffer, buffer, checkNotGeometryCollection, compare, compareTo, contains, containsProperly, convert, convert, convexHull, coveredBy, covers, createVertexId, crosses, difference, disjoint, distance, envelopeCovers, envelopesIntersect, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, geometries, getArea, getAxisCount, getBoundingBox, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryComponents, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getNonZeroGeometryFactory, getSrid, getUserData, getVertexIndex, hashCode, hasInvalidXyCoordinates, hasNonEmptyElements, hasNullElements, intersection, intersects, isAnyTargetComponentInTest, isEmpty, isGeometryCollection, isRectangle, isSimple, isValid, isWithinDistance, overlaps, relate, relate, setUserData, setVertexIndex, symDifference, toString, touches, toWkt, union, union, within

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getCoordinate

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

buffer, buffer, buffer, compareTo, contains, containsProperly, convert, convert, convexHull, coveredBy, covers, crosses, difference, disjoint, distance, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, geometries, getArea, getAxisCount, getBoundingBox, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryComponents, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getSrid, getUserData, getVertexCount, hashCode, hasInvalidXyCoordinates, intersection, intersects, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, overlaps, relate, relate, setUserData, symDifference, touches, toWkt, union, union, within

Constructor Detail

AbstractLineString

public AbstractLineString()

Method Detail

appendVertex

public <V extends Geometry> V appendVertex(Point newPoint,
                                  int... geometryId)

Specified by:

appendVertex in interface Geometry

clone

public AbstractLineString clone()

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

Specified by:

clone in interface Geometry

Specified by:

clone in interface LineString

Overrides:

clone in class AbstractGeometry

Returns:

a clone of this instance

compareToSameClass

public int compareToSameClass(Geometry geometry)

Description copied from class: AbstractGeometry

Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.

Specified by:

compareToSameClass in interface Geometry

Specified by:

compareToSameClass in class AbstractGeometry

Parameters:

geometry - a Geometry having the same class as this Geometry

Returns:

a positive number, 0, or a negative number, depending on whether this object is greater than, equal to, or less than o, as defined in "Normal Form For Geometry" in the JTS Technical Specifications

computeBoundingBox

protected BoundingBox computeBoundingBox()

Description copied from class: AbstractGeometry

Returns the minimum and maximum x and y values in this Geometry , or a null BoundingBoxDoubleGf if this Geometry is empty. Unlike getEnvelopeInternal, this method calculates the BoundingBoxDoubleGf each time it is called; getEnvelopeInternal caches the result of this method.

Specified by:

computeBoundingBox in class AbstractGeometry

Returns:

this Geometrys bounding box; if the Geometry is empty, BoundingBoxDoubleGf#isNull will return true

convertCoordinates

protected double[] convertCoordinates(GeometryFactory geometryFactory)

copy

public <V extends Geometry> V copy(GeometryFactory geometryFactory)

Description copied from interface: Geometry

Create a copy of the geometry io the requried geometry factory. Projecting to the required coordinate system and applying the precision model.

Specified by:

copy in interface Geometry

Parameters:

geometryFactory - The geometry factory to convert the geometry to.

Returns:

The converted geometry

deleteVertex

public <V extends Geometry> V deleteVertex(int... vertexId)

Specified by:

deleteVertex in interface Geometry

deleteVertex

public LineString deleteVertex(int vertexIndex)

distance

public double distance(int index,
              Point point)

Specified by:

distance in interface LineString

doEquals

public boolean doEquals(int axisCount,
               Geometry geometry)

Specified by:

doEquals in class AbstractGeometry

equals

public boolean equals(int axisCount,
             int vertexIndex,
             Point point)

Specified by:

equals in interface LineString

equalsExact

public boolean equalsExact(Geometry other,
                  double tolerance)

Description copied from class: AbstractGeometry

Returns true if the two Geometrys are exactly equal, up to a specified distance tolerance. Two Geometries are exactly equal within a distance tolerance if and only if:

• they have the same structure
• they have the same values for their vertices, within the given tolerance distance, in exactly the same order.

This method does not test the values of the GeometryFactory, the SRID, or the userData fields.

To properly test equality between different geometries, it is usually necessary to AbstractGeometry.normalize() them first.

Specified by:

equalsExact in interface Geometry

Specified by:

equalsExact in class AbstractGeometry

Parameters:

other - the Geometry with which to compare this Geometry

tolerance - distance at or below which two Coordinates are considered equal

Returns:

true if this and the other Geometry have identical structure and point values, up to the distance tolerance.

See Also:

AbstractGeometry.equals(2,Geometry), AbstractGeometry.normalize(), #norm()

equalsVertex

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

Specified by:

equalsVertex in interface LineString

equalsVertex

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

Specified by:

equalsVertex in interface LineString

equalsVertex

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

Specified by:

equalsVertex in interface LineString

equalsVertex

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

Specified by:

equalsVertex in interface LineString

equalsVertex

public boolean equalsVertex(int vertexIndex,
                   Point point)

Specified by:

equalsVertex in interface LineString

getBoundary

public Geometry getBoundary()

Gets the boundary of this geometry. The boundary of a lineal geometry is always a zero-dimensional geometry (which may be empty).

Specified by:

getBoundary in interface Geometry

Specified by:

getBoundary in class AbstractGeometry

Returns:

the boundary geometry

See Also:

Geometry.getBoundary()

getBoundaryDimension

public int getBoundaryDimension()

Description copied from class: AbstractGeometry

Returns the dimension of this Geometrys inherent boundary.

Specified by:

getBoundaryDimension in interface Geometry

Specified by:

getBoundaryDimension in class AbstractGeometry

Returns:

the dimension of the boundary of the class implementing this interface, whether or not this object is the empty geometry. Returns Dimension.FALSE if the boundary is the empty geometry.

getCoordinates

public abstract double[] getCoordinates()

Specified by:

getCoordinates in interface LineString

getCoordinatesList

public LineString getCoordinatesList()

Specified by:

getCoordinatesList in interface LineString

getDataType

public DataType getDataType()

Specified by:

getDataType in interface DataTypeProxy

Overrides:

getDataType in class AbstractGeometry

getDimension

public int getDimension()

Description copied from class: AbstractGeometry

Returns the dimension of this geometry. The dimension of a geometry is is the topological dimension of its embedding in the 2-D Euclidean plane. In the JTS spatial model, dimension values are in the set {0,1,2}.

Note that this is a different concept to the dimension of the vertex Coordinatess. The geometry dimension can never be greater than the coordinate dimension. For example, a 0-dimensional geometry (e.g. a Point) may have a coordinate dimension of 3 (X,Y,Z).

Specified by:

getDimension in interface Geometry

Specified by:

getDimension in class AbstractGeometry

Returns:

the topological dimension of this geometry.

getEndPoint

public Point getEndPoint()

Specified by:

getEndPoint in interface LineString

getLength

public double getLength()

Returns the length of this LineString

Specified by:

getLength in interface Geometry

Overrides:

getLength in class AbstractGeometry

Returns:

the length of the linestring

getM

public double getM(int vertexIndex)

Specified by:

getM in interface LineString

getMinVertexCount

public int getMinVertexCount()

getPoint

public Point getPoint()

Description copied from class: AbstractGeometry

Returns a vertex of this Geometry (usually, but not necessarily, the first one). The returned coordinate should not be assumed to be an actual Point object used in the internal representation.

Specified by:

getPoint in interface Geometry

Specified by:

getPoint in class AbstractGeometry

Returns:

a Coordinates which is a vertex of this Geometry.

getPoint

public final Point getPoint(int vertexIndex)

Specified by:

getPoint in interface LineString

getPointWithin

public Point getPointWithin()

Specified by:

getPointWithin in interface Geometry

getSegment

public LineStringSegment getSegment(int... segmentId)

Description copied from interface: Geometry

Get the Segment at the specified vertexId (see Segment.getSegmentId()).

Specified by:

getSegment in interface Geometry

Returns:

The vertex or null if it does not exist.

getSegmentCount

public int getSegmentCount()

Specified by:

getSegmentCount in interface LineString

getStartPoint

public Point getStartPoint()

Specified by:

getStartPoint in interface LineString

getToVertex

public AbstractVertex getToVertex(int... vertexId)

Description copied from interface: Geometry

Get the Vertex at the specified vertexId starting at the end of the geometry (see Vertex.getVertexId()).

Specified by:

getToVertex in interface Geometry

Parameters:

vertexId - The id of the vertex.

Returns:

The vertex or null if it does not exist.

getVertex

public AbstractVertex getVertex(int... vertexId)

Description copied from interface: Geometry

Get the Vertex at the specified vertexId (see Vertex.getVertexId()).

Specified by:

getVertex in interface Geometry

Parameters:

vertexId - The id of the vertex.

Returns:

The vertex or null if it does not exist.

getX

public double getX(int vertexIndex)

Specified by:

getX in interface LineString

getY

public double getY(int vertexIndex)

Specified by:

getY in interface LineString

getZ

public double getZ(int vertexIndex)

Specified by:

getZ in interface LineString

hasVertex

public boolean hasVertex(Point point)

Specified by:

hasVertex in interface LineString

insertVertex

public <V extends Geometry> V insertVertex(Point newPoint,
                                  int... vertexId)

Specified by:

insertVertex in interface Geometry

intersects

public boolean intersects(BoundingBox boundingBox)

Specified by:

intersects in interface Geometry

isClockwise

public boolean isClockwise()

Specified by:

isClockwise in interface LineString

isClosed

public boolean isClosed()

Specified by:

isClosed in interface LineString

isCounterClockwise

public boolean isCounterClockwise()

Specified by:

isCounterClockwise in interface LineString

isEquivalentClass

protected boolean isEquivalentClass(Geometry other)

Description copied from class: AbstractGeometry

Returns whether the two Geometrys are equal, from the point of view of the equalsExact method. Called by equalsExact . In general, two Geometry classes are considered to be "equivalent" only if they are the same class. An exception is LineString , which is considered to be equivalent to its subclasses.

Overrides:

isEquivalentClass in class AbstractGeometry

Parameters:

other - the Geometry with which to compare this Geometry for equality

Returns:

true if the classes of the two Geometry s are considered to be equal by the equalsExact method.

isRing

public boolean isRing()

Specified by:

isRing in interface LineString

merge

public LineString merge(LineString line2)

Description copied from interface: LineString

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.

Specified by:

merge in interface LineString

Returns:

The new line string

merge

public LineString merge(Point point,
               LineString line2)

Specified by:

merge in interface LineString

move

public LineString move(double... deltas)

Specified by:

move in interface Geometry

Specified by:

move in interface LineString

moveCoordinates

protected double[] moveCoordinates(double... deltas)

moveVertex

public <V extends Geometry> V moveVertex(Point newPoint,
                                int... vertexId)

Specified by:

moveVertex in interface Geometry

moveVertex

public LineString moveVertex(Point newPoint,
                    int vertexIndex)

Specified by:

moveVertex in interface LineString

normalize

public 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

Specified by:

normalize in interface LineString

Specified by:

normalize in class AbstractGeometry

Returns:

a normalized copy of this geometry.

See Also:

AbstractGeometry.normalize()

orientationIndex

public int orientationIndex(int index1,
                   int index2,
                   int index)

points

public Iterable<Point> points()

Specified by:

points in interface LineString

prepare

@Deprecated
public LineString prepare()

Deprecated.

Specified by:

prepare in interface Geometry

Specified by:

prepare in interface LineString

reverse

public LineString reverse()

Creates a LineString whose coordinates are in the reverse order of this objects

Specified by:

reverse in interface Geometry

Specified by:

reverse in interface LineString

Specified by:

reverse in class AbstractGeometry

Returns:

a LineString with coordinates in the reverse order

segments

public Reader<Segment> segments()

Specified by:

segments in interface Geometry

split

public List<LineString> split(Point point)

Specified by:

split in interface LineString

subLine

public LineString subLine(int vertexCount)

Specified by:

subLine in interface LineString

subLine

public LineString subLine(int fromVertexIndex,
                 int vertexCount)

Specified by:

subLine in interface LineString

subLine

public LineString subLine(int vertexCount,
                 Point toPoint)

Specified by:

subLine in interface LineString

subLine

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

Specified by:

subLine in interface LineString

toClockwise

public <G extends Geometry> G toClockwise()

Specified by:

toClockwise in interface Geometry

Overrides:

toClockwise in class AbstractGeometry

toCounterClockwise

public <G extends Geometry> G toCounterClockwise()

Specified by:

toCounterClockwise in interface Geometry

Overrides:

toCounterClockwise in class AbstractGeometry

vertices

public Reader<Vertex> vertices()

Description copied from interface: Geometry

Get an Iterable that iterates over the Vertex of the geometry. For memory efficiency the Vertex returned is the same instance for each call to next on the iterator. If the vertex is required to track the previous vertex then the Vertex.clone() method must be called to get a copy of the vertex.

The Iterable.iterator() method always returns the same Iterator instance. Therefore that method should not be called more than once.

Specified by:

vertices in interface Geometry

Returns:

The iterator over the vertices of the geometry.