Class LineString
- java.lang.Object
-
- org.locationtech.jts.geom.Geometry
-
- org.locationtech.jts.geom.LineString
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable
,Lineal
- Direct Known Subclasses:
LinearRing
public class LineString extends Geometry implements Lineal
Models an OGC-styleLineString
. 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 Modifier and Type Field Description static int
MINIMUM_VALID_SIZE
The minimum number of vertices allowed in a valid non-empty linestring.-
Fields inherited from class org.locationtech.jts.geom.Geometry
TYPENAME_GEOMETRYCOLLECTION, TYPENAME_LINEARRING, TYPENAME_LINESTRING, TYPENAME_MULTILINESTRING, TYPENAME_MULTIPOINT, TYPENAME_MULTIPOLYGON, TYPENAME_POINT, TYPENAME_POLYGON
-
-
Constructor Summary
Constructors Constructor Description LineString(Coordinate[] points, PrecisionModel precisionModel, int SRID)
Deprecated.Use GeometryFactory insteadLineString(CoordinateSequence points, GeometryFactory factory)
Constructs aLineString
with the given points.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
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).java.lang.Object
clone()
Deprecated.boolean
equalsExact(Geometry other, double tolerance)
Returns true if the twoGeometry
s are exactly equal, up to a specified distance tolerance.Geometry
getBoundary()
Gets the boundary of this geometry.int
getBoundaryDimension()
Returns the dimension of thisGeometry
s inherent boundary.Coordinate
getCoordinate()
Returns a vertex of thisGeometry
(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 Geometry's actual class.double
getLength()
Returns the length of thisLineString
int
getNumPoints()
Returns the count of thisGeometry
s vertices.Point
getPointN(int n)
Point
getStartPoint()
boolean
isClosed()
boolean
isCoordinate(Coordinate pt)
Returns true if the given point is a vertex of thisLineString
.boolean
isEmpty()
Tests whether the set of points covered by thisGeometry
is empty.boolean
isRing()
void
normalize()
Normalizes a LineString.LineString
reverse()
Creates aLineString
whose coordinates are in the reverse order of this objects-
Methods inherited from class org.locationtech.jts.geom.Geometry
buffer, buffer, buffer, compareTo, compareTo, contains, convexHull, copy, coveredBy, covers, crosses, difference, disjoint, distance, equals, equals, equalsExact, equalsNorm, equalsTopo, geometryChanged, getArea, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getGeometryN, getInteriorPoint, getNumGeometries, getPrecisionModel, getSRID, getUserData, hashCode, intersection, intersects, isRectangle, isSimple, isValid, isWithinDistance, norm, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, union, within
-
-
-
-
Field Detail
-
MINIMUM_VALID_SIZE
public static final int MINIMUM_VALID_SIZE
The minimum number of vertices allowed in a valid non-empty linestring. Empty linestrings with 0 vertices are also valid.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LineString
public LineString(Coordinate[] points, PrecisionModel precisionModel, int SRID)
Deprecated.Use GeometryFactory instead
-
LineString
public LineString(CoordinateSequence points, GeometryFactory factory)
Constructs aLineString
with the given points.- Parameters:
points
- the points of the linestring, ornull
to create the empty geometry.- Throws:
java.lang.IllegalArgumentException
- if too few points are provided
-
-
Method Detail
-
getCoordinates
public Coordinate[] 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:
Geometry.geometryChanged()
,CoordinateSequence.setOrdinate(int, int, double)
-
getCoordinateSequence
public CoordinateSequence getCoordinateSequence()
-
getCoordinateN
public Coordinate getCoordinateN(int n)
-
getCoordinate
public Coordinate 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.Note this test is for topological emptiness, not structural emptiness. A collection containing only empty elements is reported as empty. To check structural emptiness use
Geometry.getNumGeometries()
.
-
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
public Point getPointN(int n)
-
getStartPoint
public Point getStartPoint()
-
getEndPoint
public Point getEndPoint()
-
isClosed
public boolean isClosed()
-
isRing
public boolean isRing()
-
getGeometryType
public java.lang.String 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
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 classGeometry
- Returns:
- the boundary geometry
- See Also:
Geometry.getBoundary()
-
reverse
public LineString reverse()
Creates aLineString
whose coordinates are in the reverse order of this objects- Overrides:
reverse
in classGeometry
- Returns:
- a
LineString
with coordinates in the reverse order
-
isCoordinate
public boolean isCoordinate(Coordinate pt)
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
-
equalsExact
public boolean equalsExact(Geometry other, double tolerance)
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:
Geometry.equalsExact(Geometry)
,Geometry.normalize()
,Geometry.norm()
-
apply
public void apply(CoordinateFilter filter)
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
public void apply(CoordinateSequenceFilter filter)
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
public void apply(GeometryFilter filter)
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
public void apply(GeometryComponentFilter filter)
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
public java.lang.Object clone()
Deprecated.Creates and returns a full copy of thisLineString
object. (including all coordinates contained by it).
-
-