public class LineString extends Geometry implements Lineal
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
| Modifier and Type | Field and Description |
|---|---|
static int |
MINIMUM_VALID_SIZE
The minimum number of vertices allowed in a valid non-empty linestring.
|
TYPENAME_GEOMETRYCOLLECTION, TYPENAME_LINEARRING, TYPENAME_LINESTRING, TYPENAME_MULTILINESTRING, TYPENAME_MULTIPOINT, TYPENAME_MULTIPOLYGON, TYPENAME_POINT, TYPENAME_POLYGON| Constructor and Description |
|---|
LineString(Coordinate[] points,
PrecisionModel precisionModel,
int SRID)
Deprecated.
Use GeometryFactory instead
|
LineString(CoordinateSequence points,
GeometryFactory factory)
Constructs a
LineString with the given points. |
| Modifier and Type | Method and Description |
|---|---|
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
CoordinateSequences. |
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 Geometrys (if any). |
Object |
clone()
Deprecated.
|
boolean |
equalsExact(Geometry other,
double tolerance)
Returns true if the two
Geometrys are exactly equal,
up to a specified distance tolerance. |
Geometry |
getBoundary()
Gets the boundary of this geometry.
|
int |
getBoundaryDimension()
Returns the dimension of this
Geometrys inherent boundary. |
Coordinate |
getCoordinate()
Returns a vertex of this geometry
(usually, but not necessarily, the first one),
or
null if the geometry is empty. |
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() |
String |
getGeometryType()
Returns the name of this Geometry's actual class.
|
double |
getLength()
Returns the length of this
LineString |
int |
getNumPoints()
Returns the count of this
Geometrys 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()
Tests whether the set of points covered by this
Geometry is
empty. |
boolean |
isRing() |
void |
normalize()
Normalizes a LineString.
|
LineString |
reverse()
Creates a
LineString whose coordinates are in the reverse
order of this objects |
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, hasDimension, hashCode, intersection, intersects, isRectangle, isSimple, isValid, isWithinDistance, norm, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, union, withinpublic static final int MINIMUM_VALID_SIZE
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.IllegalArgumentException - if too few points are providedpublic 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 GeometryGeometryGeometry.geometryChanged(),
CoordinateSequence.setOrdinate(int, int, double)public CoordinateSequence getCoordinateSequence()
public Coordinate getCoordinateN(int n)
public Coordinate getCoordinate()
Geometrynull if the geometry is empty.
The returned coordinate should not be assumed
to be an actual Coordinate object used in
the internal representation.getCoordinate in class GeometryGeometry.public int getDimension()
Geometry
Note that this is a different concept to the dimension of
the vertex Coordinates.
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).
getDimension in class GeometryGeometry.hasDimension(int)public int getBoundaryDimension()
GeometryGeometrys inherent boundary.getBoundaryDimension in class GeometryDimension.FALSE if the boundary is the empty geometry.public boolean isEmpty()
GeometryGeometry 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().
public int getNumPoints()
GeometryGeometrys vertices. The Geometry
s contained by composite Geometrys must be
Geometry's; that is, they must implement getNumPointsgetNumPoints in class GeometryGeometrypublic Point getPointN(int n)
public Point getStartPoint()
public Point getEndPoint()
public boolean isClosed()
public boolean isRing()
public String getGeometryType()
GeometrygetGeometryType in class GeometryGeometrys actual classpublic double getLength()
LineStringpublic Geometry getBoundary()
getBoundary in class GeometryGeometry.getBoundary()public LineString reverse()
LineString whose coordinates are in the reverse
order of this objectsreverse in class GeometryLineString with coordinates in the reverse orderpublic boolean isCoordinate(Coordinate pt)
LineString.pt - the Coordinate to checktrue if pt is one of this LineString
's verticespublic boolean equalsExact(Geometry other, double tolerance)
GeometryGeometrys are exactly equal,
up to a specified distance tolerance.
Two Geometries are exactly equal within a distance tolerance
if and only if:
GeometryFactory, the SRID,
or the userData fields.
To properly test equality between different geometries,
it is usually necessary to Geometry.normalize() them first.
equalsExact in class Geometryother - the Geometry with which to compare this Geometrytolerance - distance at or below which two Coordinates
are considered equaltrue 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)
GeometryGeometry'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).public void apply(CoordinateSequenceFilter filter)
GeometryGeometry's
CoordinateSequences.
If the filter reports that a coordinate value has been changed,
Geometry.geometryChanged() will be called automatically.public void apply(GeometryFilter filter)
GeometryGeometry and its
subelement Geometrys (if any).
Only GeometryCollections and subclasses
have subelement Geometry's.public void apply(GeometryComponentFilter filter)
Geometrypublic Object clone()
LineString object.
(including all coordinates contained by it).Copyright © 2024. All rights reserved.