
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.geom.Geometry com.vividsolutions.jts.geom.LineString
public class LineString
Models an OGCstyle LineString
.
A LineString consists of a sequence of two or more vertices,
along with all points along the linearlyinterpolated 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 selfintersect.
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
Field Summary  

protected CoordinateSequence 
points
The points of this LineString . 
Fields inherited from class com.vividsolutions.jts.geom.Geometry 

envelope, factory, SRID 
Constructor Summary  

LineString(Coordinate[] points,
PrecisionModel precisionModel,
int SRID)
Deprecated. Use GeometryFactory instead 

LineString(CoordinateSequence points,
GeometryFactory factory)
Constructs a LineString with the given points. 
Method Summary  

void 
apply(CoordinateFilter filter)
Performs an operation with or on this Geometry 's
coordinates. 
void 
apply(CoordinateSequenceFilter filter)
Performs an operation on the coordinates in this Geometry 's
CoordinateSequence s. 
void 
apply(GeometryComponentFilter filter)
Performs an operation with or on this Geometry and its component Geometry's. 
void 
apply(GeometryFilter filter)
Performs an operation with or on this Geometry and its
subelement Geometry s (if any). 
java.lang.Object 
clone()
Creates and returns a full copy of this LineString object. 
protected int 
compareToSameClass(java.lang.Object o)
Returns whether this Geometry is greater than, equal to,
or less than another Geometry having the same class. 
protected int 
compareToSameClass(java.lang.Object o,
CoordinateSequenceComparator comp)
Returns whether this Geometry is greater than, equal to,
or less than another Geometry of the same class. 
protected Envelope 
computeEnvelopeInternal()
Returns the minimum and maximum x and y values in this Geometry
, or a null Envelope if this Geometry is empty. 
boolean 
equalsExact(Geometry other,
double tolerance)
Returns true if the two Geometry s are exactly equal,
up to a specified distance tolerance. 
Geometry 
getBoundary()
Gets the boundary of this geometry. 
int 
getBoundaryDimension()
Returns the dimension of this Geometry s inherent boundary. 
Coordinate 
getCoordinate()
Returns a vertex of this Geometry
(usually, but not necessarily, the first one). 
Coordinate 
getCoordinateN(int n)

Coordinate[] 
getCoordinates()
Returns an array containing the values of all the vertices for this geometry. 
CoordinateSequence 
getCoordinateSequence()

int 
getDimension()
Returns the dimension of this geometry. 
Point 
getEndPoint()

java.lang.String 
getGeometryType()
Returns the name of this object's com.vivid.jts.geom
interface. 
double 
getLength()
Returns the length of this LineString 
int 
getNumPoints()
Returns the count of this Geometry s vertices. 
Point 
getPointN(int n)

Point 
getStartPoint()

boolean 
isClosed()

boolean 
isCoordinate(Coordinate pt)
Returns true if the given point is a vertex of this LineString . 
boolean 
isEmpty()
Returns whether or not the set of points in this Geometry is
empty. 
protected boolean 
isEquivalentClass(Geometry other)
Returns whether the two Geometry s are equal, from the point
of view of the equalsExact method. 
boolean 
isRing()

void 
normalize()
Normalizes a LineString. 
Geometry 
reverse()
Creates a LineString whose coordinates are in the reverse
order of this objects 
Methods inherited from class com.vividsolutions.jts.geom.Geometry 

buffer, buffer, buffer, checkNotGeometryCollection, compare, compareTo, compareTo, contains, convexHull, coveredBy, covers, crosses, difference, disjoint, distance, equal, equals, equals, equalsExact, equalsNorm, equalsTopo, geometryChanged, geometryChangedAction, getArea, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getGeometryN, getInteriorPoint, getNumGeometries, getPrecisionModel, getSRID, getUserData, hashCode, hasNonEmptyElements, hasNullElements, intersection, intersects, isGeometryCollection, isRectangle, isSimple, isValid, isWithinDistance, norm, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, union, within 
Methods inherited from class java.lang.Object 

finalize, getClass, notify, notifyAll, wait, wait, wait 
Field Detail 

protected CoordinateSequence points
LineString
.
Constructor Detail 

public LineString(Coordinate[] points, PrecisionModel precisionModel, int SRID)
public LineString(CoordinateSequence points, GeometryFactory factory)
LineString
with the given points.
points
 the points of the linestring, or null
to create the empty geometry. Consecutive points may not be equal.
java.lang.IllegalArgumentException
 if too few points are providedMethod Detail 

public Coordinate[] getCoordinates()
Geometry
In general, the array cannot be assumed to be the actual internal
storage for the vertices. Thus modifying the array
may not modify the geometry itself.
Use the CoordinateSequence.setOrdinate(int, int, double)
method
(possibly on the components) to modify the underlying data.
If the coordinates are modified,
Geometry.geometryChanged()
must be called afterwards.
getCoordinates
in class Geometry
Geometry
Geometry.geometryChanged()
,
CoordinateSequence.setOrdinate(int, int, double)
public CoordinateSequence getCoordinateSequence()
public Coordinate getCoordinateN(int n)
public Coordinate getCoordinate()
Geometry
Geometry
(usually, but not necessarily, the first one).
The returned coordinate should not be assumed
to be an actual Coordinate object used in
the internal representation.
getCoordinate
in class Geometry
Coordinate
which is a vertex of this Geometry
.public int getDimension()
Geometry
Note that this is a different concept to the dimension of
the vertex Coordinate
s.
The geometry dimension can never be greater than the coordinate dimension.
For example, a 0dimensional geometry (e.g. a Point)
may have a coordinate dimension of 3 (X,Y,Z).
getDimension
in class Geometry
public int getBoundaryDimension()
Geometry
Geometry
s inherent boundary.
getBoundaryDimension
in class Geometry
Dimension.FALSE
if the boundary is the empty geometry.public boolean isEmpty()
Geometry
Geometry
is
empty.
isEmpty
in class Geometry
true
if this Geometry
equals the empty
geometrypublic int getNumPoints()
Geometry
Geometry
s vertices. The Geometry
s contained by composite Geometry
s must be
Geometry's; that is, they must implement getNumPoints
getNumPoints
in class Geometry
Geometry
public Point getPointN(int n)
public Point getStartPoint()
public Point getEndPoint()
public boolean isClosed()
public boolean isRing()
public java.lang.String getGeometryType()
Geometry
com.vivid.jts.geom
interface.
getGeometryType
in class Geometry
Geometry
s most specific com.vividsolutions.jts.geom
interfacepublic double getLength()
LineString
getLength
in class Geometry
public Geometry getBoundary()
getBoundary
in class Geometry
Geometry.getBoundary()
public Geometry reverse()
LineString
whose coordinates are in the reverse
order of this objects
reverse
in class Geometry
LineString
with coordinates in the reverse orderpublic boolean isCoordinate(Coordinate pt)
LineString
.
pt
 the Coordinate
to check
true
if pt
is one of this LineString
's verticesprotected Envelope computeEnvelopeInternal()
Geometry
Geometry
, or a null Envelope
if this Geometry
is empty.
Unlike getEnvelopeInternal
, this method calculates the Envelope
each time it is called; getEnvelopeInternal
caches the result
of this method.
computeEnvelopeInternal
in class Geometry
Geometry
s bounding box; if the Geometry
is empty, Envelope#isNull
will return true
public boolean equalsExact(Geometry other, double tolerance)
Geometry
Geometry
s are exactly equal,
up to a specified distance tolerance.
Two Geometries are exactly equal within a distance tolerance
if and only if:
To properly test equality between different geometries,
it is usually necessary to Geometry.normalize()
them first.
equalsExact
in class Geometry
other
 the Geometry
with which to compare this Geometry
tolerance
 distance at or below which two Coordinate
s
are considered equal
true
if this and the other Geometry
have identical structure and point values, up to the distance tolerance.Geometry.equalsExact(Geometry)
,
Geometry.normalize()
,
Geometry.norm()
public void apply(CoordinateFilter filter)
Geometry
Geometry
's
coordinates.
If this method modifies any coordinate values,
Geometry.geometryChanged()
must be called to update the geometry state.
Note that you cannot use this method to
modify this Geometry if its underlying CoordinateSequence's #get method
returns a copy of the Coordinate, rather than the actual Coordinate stored
(if it even stores Coordinate objects at all).
apply
in class Geometry
filter
 the filter to apply to this Geometry
's
coordinatespublic void apply(CoordinateSequenceFilter filter)
Geometry
Geometry
's
CoordinateSequence
s.
If the filter reports that a coordinate value has been changed,
Geometry.geometryChanged()
will be called automatically.
apply
in class Geometry
filter
 the filter to applypublic void apply(GeometryFilter filter)
Geometry
Geometry
and its
subelement Geometry
s (if any).
Only GeometryCollections and subclasses
have subelement Geometry's.
apply
in class Geometry
filter
 the filter to apply to this Geometry
(and
its children, if it is a GeometryCollection
).public void apply(GeometryComponentFilter filter)
Geometry
apply
in class Geometry
filter
 the filter to apply to this Geometry
.public java.lang.Object clone()
LineString
object.
(including all coordinates contained by it).
clone
in class Geometry
public void normalize()
normalize
in class Geometry
protected boolean isEquivalentClass(Geometry other)
Geometry
Geometry
s 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.
isEquivalentClass
in class Geometry
other
 the Geometry
with which to compare this Geometry
for equality
true
if the classes of the two Geometry
s are considered to be equal by the equalsExact
method.protected int compareToSameClass(java.lang.Object o)
Geometry
Geometry
is greater than, equal to,
or less than another Geometry
having the same class.
compareToSameClass
in class Geometry
o
 a Geometry
having the same class as this Geometry
o
, as
defined in "Normal Form For Geometry" in the JTS Technical
Specificationsprotected int compareToSameClass(java.lang.Object o, CoordinateSequenceComparator comp)
Geometry
Geometry
is greater than, equal to,
or less than another Geometry
of the same class.
using the given CoordinateSequenceComparator
.
compareToSameClass
in class Geometry
o
 a Geometry
having the same class as this Geometry
comp
 a CoordinateSequenceComparator
o
, as
defined in "Normal Form For Geometry" in the JTS Technical
Specifications

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