com.revolsys.jts.geom.impl

Class AbstractMultiLineString

java.lang.Object

com.revolsys.jts.geom.impl.AbstractGeometry

com.revolsys.jts.geom.impl.AbstractGeometryCollection

com.revolsys.jts.geom.impl.AbstractMultiLineString

All Implemented Interfaces:

DataTypeProxy, Geometry, GeometryCollection, Lineal, MultiLineString, Serializable, Cloneable, Comparable<Object>

Direct Known Subclasses:

MultiLineStringImpl, PreparedMultiLineString

public abstract class AbstractMultiLineString
extends AbstractGeometryCollection
implements MultiLineString

Models a collection of (@link LineString}s.

Any collection of LineStrings is a valid MultiLineString.

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
AbstractMultiLineString()

Method Summary

Methods

Modifier and Type	Method and Description
<V extends Geometry> V	copy(GeometryFactory geometryFactory) Create a copy of the geometry io the requried geometry factory.
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.
BoundingBox	getBoundingBox() Gets an BoundingBoxDoubleGf containing the minimum and maximum x and y values in this Geometry.
DataType	getDataType()
int	getDimension() Returns the dimension of this geometry.
LineString	getLineString(int partIndex)
<V extends LineString> List<V>	getLineStrings()
Segment	getSegment(int... segmentId) Get the Segment at the specified vertexId (see Segment.getSegmentId()).
Vertex	getToVertex(int... vertexId) Get the Vertex at the specified vertexId starting at the end of the geometry (see Vertex.getVertexId()).
Object	getUserData() Gets the user data object for this geometry, if any.
Vertex	getVertex(int... vertexId) Get the Vertex at the specified vertexId (see Vertex.getVertexId()).
boolean	isClosed()
protected boolean	isEquivalentClass(Geometry other) Returns whether the two Geometrys are equal, from the point of view of the equalsExact method.
<V extends Geometry> V	moveVertex(Point newPoint, int... vertexId)
MultiLineString	normalize() Converts this Geometry to normal form (or canonical form ).
MultiLineString	reverse() Creates a MultiLineString in the reverse order to this object.
Reader<Segment>	segments()
void	setUserData(Object userData) A simple scheme for applications to add their own custom data to a Geometry.
Reader<Vertex>	vertices() Get an Iterable that iterates over the Vertex of the geometry.

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

appendVertex, clone, compareToSameClass, computeBoundingBox, deleteVertex, doEquals, geometries, getArea, getGeometries, getGeometryComponents, getLength, getPoint, getPointWithin, getVertexCount, insertVertex, intersects, isEmpty, move, toClockwise, toCounterClockwise

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, getAxisCount, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometry, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getNonZeroGeometryFactory, getSrid, getVertexIndex, hashCode, hasInvalidXyCoordinates, hasNonEmptyElements, hasNullElements, intersection, intersects, isAnyTargetComponentInTest, isGeometryCollection, isRectangle, isSimple, isValid, isWithinDistance, overlaps, relate, relate, 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.MultiLineString

prepare

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

clone

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

appendVertex, buffer, buffer, buffer, compareTo, compareToSameClass, contains, containsProperly, convert, convert, convexHull, coveredBy, covers, crosses, deleteVertex, difference, disjoint, distance, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, geometries, getArea, getAxisCount, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryComponents, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getLength, getPoint, getPointWithin, getSrid, getVertexCount, hashCode, hasInvalidXyCoordinates, insertVertex, intersection, intersects, intersects, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, move, overlaps, relate, relate, symDifference, toClockwise, toCounterClockwise, touches, toWkt, union, union, within

Constructor Detail

AbstractMultiLineString

public AbstractMultiLineString()

Method Detail

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

Overrides:

copy in class AbstractGeometryCollection

Parameters:

geometryFactory - The geometry factory to convert the geometry to.

Returns:

The converted geometry

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

Overrides:

equalsExact in class AbstractGeometryCollection

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()

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

Overrides:

getBoundary in class AbstractGeometryCollection

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

Overrides:

getBoundaryDimension in class AbstractGeometryCollection

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.

getBoundingBox

public BoundingBox getBoundingBox()

Description copied from class: AbstractGeometry

Gets an BoundingBoxDoubleGf containing the minimum and maximum x and y values in this Geometry. If the geometry is empty, an empty BoundingBoxDoubleGf is returned.

The returned object is a copy of the one maintained internally, to avoid aliasing issues. For best performance, clients which access this boundingBox frequently should cache the return value.

Specified by:

getBoundingBox in interface Geometry

Overrides:

getBoundingBox in class AbstractGeometry

Returns:

the boundingBox of this Geometry.

getDataType

public DataType getDataType()

Specified by:

getDataType in interface DataTypeProxy

Overrides:

getDataType in class AbstractGeometryCollection

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

Overrides:

getDimension in class AbstractGeometryCollection

Returns:

the topological dimension of this geometry.

getLineString

public LineString getLineString(int partIndex)

Specified by:

getLineString in interface MultiLineString

getLineStrings

public <V extends LineString> List<V> getLineStrings()

Specified by:

getLineStrings in interface MultiLineString

getSegment

public Segment getSegment(int... segmentId)

Description copied from interface: Geometry

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

Specified by:

getSegment in interface Geometry

Overrides:

getSegment in class AbstractGeometryCollection

Returns:

The vertex or null if it does not exist.

getToVertex

public Vertex 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

Overrides:

getToVertex in class AbstractGeometryCollection

Parameters:

vertexId - The id of the vertex.

Returns:

The vertex or null if it does not exist.

getUserData

public Object getUserData()

Gets the user data object for this geometry, if any.

Specified by:

getUserData in interface Geometry

Overrides:

getUserData in class AbstractGeometry

Returns:

the user data object, or null if none set

getVertex

public Vertex getVertex(int... vertexId)

Description copied from interface: Geometry

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

Specified by:

getVertex in interface Geometry

Overrides:

getVertex in class AbstractGeometryCollection

Parameters:

vertexId - The id of the vertex.

Returns:

The vertex or null if it does not exist.

isClosed

public boolean isClosed()

Specified by:

isClosed in interface MultiLineString

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 AbstractGeometryCollection

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.

moveVertex

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

Specified by:

moveVertex in interface Geometry

Overrides:

moveVertex in class AbstractGeometryCollection

normalize

public MultiLineString normalize()

Description copied from class: AbstractGeometry

Converts this Geometry to normal form (or canonical form ). Normal form is a unique representation for Geometry s. It can be used to test whether two Geometrys are equal in a way that is independent of the ordering of the coordinates within them. Normal form equality is a stronger condition than topological equality, but weaker than pointwise equality. The definitions for normal form use the standard lexicographical ordering for coordinates. "Sorted in order of coordinates" means the obvious extension of this ordering to sequences of coordinates.

Specified by:

normalize in interface Geometry

Specified by:

normalize in interface GeometryCollection

Specified by:

normalize in interface MultiLineString

Overrides:

normalize in class AbstractGeometryCollection

Returns:

a normalized copy of this geometry.

See Also:

AbstractGeometry.normalize()

reverse

public MultiLineString reverse()

Creates a MultiLineString in the reverse order to this object. Both the order of the component LineStrings and the order of their coordinate sequences are reversed.

Specified by:

reverse in interface Geometry

Specified by:

reverse in interface MultiLineString

Overrides:

reverse in class AbstractGeometryCollection

Returns:

a MultiLineString in the reverse order

segments

public Reader<Segment> segments()

Specified by:

segments in interface Geometry

Overrides:

segments in class AbstractGeometryCollection

setUserData

public void setUserData(Object userData)

A simple scheme for applications to add their own custom data to a Geometry. An example use might be to add an object representing a Point Reference System.

Note that user data objects are not present in geometries created by construction methods.

Specified by:

setUserData in interface Geometry

Overrides:

setUserData in class AbstractGeometry

Parameters:

userData - an object, the semantics for which are defined by the application using this Geometry

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

Overrides:

vertices in class AbstractGeometryCollection

Returns:

The iterator over the vertices of the geometry.