Class LineString
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Lineal
- Direct Known Subclasses:
LinearRing
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CoordinateSequence
The points of thisLineString
.private static final long
Fields inherited from class org.locationtech.jts.geom.Geometry
envelope, factory, SORTINDEX_GEOMETRYCOLLECTION, SORTINDEX_LINEARRING, SORTINDEX_LINESTRING, SORTINDEX_MULTILINESTRING, SORTINDEX_MULTIPOINT, SORTINDEX_MULTIPOLYGON, SORTINDEX_POINT, SORTINDEX_POLYGON, SRID
-
Constructor Summary
ConstructorsConstructorDescriptionLineString
(Coordinate[] points, PrecisionModel precisionModel, int SRID) Deprecated.Use GeometryFactory insteadLineString
(CoordinateSequence points, GeometryFactory factory) Constructs aLineString
with the given points. -
Method Summary
Modifier and TypeMethodDescriptionvoid
apply
(CoordinateFilter filter) Performs an operation with or on thisGeometry
's coordinates.void
apply
(CoordinateSequenceFilter filter) Performs an operation on the coordinates in thisGeometry
'sCoordinateSequence
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 thisGeometry
and its subelementGeometry
s (if any).clone()
Deprecated.protected int
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
having the same class.protected int
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
of the same class.protected Envelope
Returns the minimum and maximum x and y values in thisGeometry
, or a nullEnvelope
if thisGeometry
is empty.copy()
Creates and returns a full copy of thisLineString
object.boolean
equalsExact
(Geometry other, double tolerance) Returns true if the twoGeometry
s are exactly equal, up to a specified distance tolerance.Gets the boundary of this geometry.int
Returns the dimension of thisGeometry
s inherent boundary.Returns a vertex of thisGeometry
(usually, but not necessarily, the first one).getCoordinateN
(int n) Returns an array containing the values of all the vertices for this geometry.int
Returns the dimension of this geometry.Returns the name of this Geometry's actual class.double
Returns the length of thisLineString
int
Returns the count of thisGeometry
s vertices.getPointN
(int n) protected int
private void
init
(CoordinateSequence points) boolean
isClosed()
boolean
Returns true if the given point is a vertex of thisLineString
.boolean
isEmpty()
Tests whether the set of points covered by thisGeometry
is empty.protected boolean
isEquivalentClass
(Geometry other) Returns whether the twoGeometry
s are equal, from the point of view of theequalsExact
method.boolean
isRing()
void
Normalizes a LineString.reverse()
Creates aLineString
whose coordinates are in the reverse order of this objectsMethods inherited from class org.locationtech.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
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
points
The points of thisLineString
.
-
-
Constructor Details
-
LineString
Deprecated.Use GeometryFactory instead -
LineString
Constructs aLineString
with the given points.- Parameters:
points
- the points of the linestring, ornull
to create the empty geometry.- Throws:
IllegalArgumentException
- if too few points are provided
-
-
Method Details
-
init
-
getCoordinates
Description copied from class:Geometry
Returns an array containing the values of all the vertices for this geometry. If the geometry is a composite, the array will contain all the vertices for the components, in the order in which the components occur in the 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.- Specified by:
getCoordinates
in classGeometry
- Returns:
- the vertices of this
Geometry
- See Also:
-
getCoordinateSequence
-
getCoordinateN
-
getCoordinate
Description copied from class:Geometry
Returns a vertex of thisGeometry
(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.- Specified by:
getCoordinate
in classGeometry
- Returns:
- a
Coordinate
which is a vertex of thisGeometry
.
-
getDimension
public int getDimension()Description copied from class:Geometry
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
Coordinate
s. 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 classGeometry
- Returns:
- the topological dimension of this geometry.
-
getBoundaryDimension
public int getBoundaryDimension()Description copied from class:Geometry
Returns the dimension of thisGeometry
s inherent boundary.- Specified by:
getBoundaryDimension
in classGeometry
- 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.
-
isEmpty
public boolean isEmpty()Description copied from class:Geometry
Tests whether the set of points covered by thisGeometry
is empty. -
getNumPoints
public int getNumPoints()Description copied from class:Geometry
Returns the count of thisGeometry
s vertices. TheGeometry
s contained by compositeGeometry
s must be Geometry's; that is, they must implementgetNumPoints
- Specified by:
getNumPoints
in classGeometry
- Returns:
- the number of vertices in this
Geometry
-
getPointN
-
getStartPoint
-
getEndPoint
-
isClosed
public boolean isClosed() -
isRing
public boolean isRing() -
getGeometryType
Description copied from class:Geometry
Returns the name of this Geometry's actual class.- Specified by:
getGeometryType
in classGeometry
- Returns:
- the name of this
Geometry
s actual class
-
getLength
public double getLength()Returns the length of thisLineString
-
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 classGeometry
- Returns:
- the boundary geometry
- See Also:
-
reverse
Creates aLineString
whose coordinates are in the reverse order of this objects- Specified by:
reverse
in classGeometry
- Returns:
- a
LineString
with coordinates in the reverse order
-
isCoordinate
Returns true if the given point is a vertex of thisLineString
.- Parameters:
pt
- theCoordinate
to check- Returns:
true
ifpt
is one of thisLineString
's vertices
-
computeEnvelopeInternal
Description copied from class:Geometry
Returns the minimum and maximum x and y values in thisGeometry
, or a nullEnvelope
if thisGeometry
is empty. UnlikegetEnvelopeInternal
, this method calculates theEnvelope
each time it is called;getEnvelopeInternal
caches the result of this method.- Specified by:
computeEnvelopeInternal
in classGeometry
- Returns:
- this
Geometry
s bounding box; if theGeometry
is empty,Envelope#isNull
will returntrue
-
equalsExact
Description copied from class:Geometry
Returns true if the twoGeometry
s 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.
GeometryFactory
, theSRID
, or theuserData
fields.To properly test equality between different geometries, it is usually necessary to
Geometry.normalize()
them first.- Specified by:
equalsExact
in classGeometry
- Parameters:
other
- theGeometry
with which to compare thisGeometry
tolerance
- distance at or below which twoCoordinate
s are considered equal- Returns:
true
if this and the otherGeometry
have identical structure and point values, up to the distance tolerance.- See Also:
-
apply
Description copied from class:Geometry
Performs an operation with or on thisGeometry
'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
Description copied from class:Geometry
Performs an operation on the coordinates in thisGeometry
'sCoordinateSequence
s. If the filter reports that a coordinate value has been changed,Geometry.geometryChanged()
will be called automatically. -
apply
Description copied from class:Geometry
Performs an operation with or on thisGeometry
and its subelementGeometry
s (if any). Only GeometryCollections and subclasses have subelement Geometry's. -
apply
Description copied from class:Geometry
Performs an operation with or on this Geometry and its component Geometry's. Only GeometryCollections and Polygons have component Geometry's; for Polygons they are the LinearRings of the shell and holes. -
clone
Deprecated.Creates and returns a full copy of thisLineString
object. (including all coordinates contained by it). -
copy
Creates and returns a full copy of thisLineString
object. (including all coordinates contained by it). -
normalize
public void 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. -
isEquivalentClass
Description copied from class:Geometry
Returns whether the twoGeometry
s are equal, from the point of view of theequalsExact
method. Called byequalsExact
. In general, twoGeometry
classes are considered to be "equivalent" only if they are the same class. An exception isLineString
, which is considered to be equivalent to its subclasses.- Overrides:
isEquivalentClass
in classGeometry
- Parameters:
other
- theGeometry
with which to compare thisGeometry
for equality- Returns:
true
if the classes of the twoGeometry
s are considered to be equal by theequalsExact
method.
-
compareToSameClass
Description copied from class:Geometry
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
having the same class.- Specified by:
compareToSameClass
in classGeometry
- Parameters:
o
- aGeometry
having the same class as thisGeometry
- 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
-
compareToSameClass
Description copied from class:Geometry
Returns whether thisGeometry
is greater than, equal to, or less than anotherGeometry
of the same class. using the givenCoordinateSequenceComparator
.- Specified by:
compareToSameClass
in classGeometry
- Parameters:
o
- aGeometry
having the same class as thisGeometry
comp
- aCoordinateSequenceComparator
- 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
-
getSortIndex
protected int getSortIndex()- Specified by:
getSortIndex
in classGeometry
-