com.revolsys.jts.geom.prep

Class PreparedMultiPolygon

java.lang.Object

com.revolsys.jts.geom.impl.AbstractGeometry

com.revolsys.jts.geom.impl.AbstractGeometryCollection

com.revolsys.jts.geom.impl.AbstractMultiPolygon

com.revolsys.jts.geom.prep.PreparedMultiPolygon

All Implemented Interfaces:

DataTypeProxy, Geometry, GeometryCollection, MultiPolygon, Polygonal, Serializable, Cloneable, Comparable<Object>

public class PreparedMultiPolygon
extends AbstractMultiPolygon

A prepared version for MultiPolygonal geometries. This class supports both MultiPolygons and MultiMultiPolygons.

This class does not support MultiMultiPolygons which are non-valid (e.g. with overlapping elements).

Instances of this class are thread-safe and immutable.

Author:

mbdavis

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
PreparedMultiPolygon(MultiPolygon polygon)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Geometry g) Tests whether this geometry contains the argument geometry.
boolean	containsProperly(Geometry geometry)
boolean	covers(Geometry geometry) Tests whether this geometry covers the argument geometry.
BoundingBox	getBoundingBox() Gets an BoundingBoxDoubleGf containing the minimum and maximum x and y values in this Geometry.
<V extends Geometry> List<V>	getGeometries()
<V extends Geometry> V	getGeometry(int partIndex) Returns an element Geometry from a GeometryCollection (or this, if the geometry is not a collection).
int	getGeometryCount() Returns the number of Geometrys in a GeometryCollection (or 1, if the geometry is not a collection).
GeometryFactory	getGeometryFactory() Gets the geometryFactory which contains the context in which this geometry was created.
FastSegmentSetIntersectionFinder	getIntersectionFinder() Gets the indexed intersection finder for this geometry.
MultiPolygon	getMultiPolygon()
PointOnGeometryLocator	getPointLocator()
List<Point>	getRepresentativePoints() Gets the list of representative points for this geometry.
boolean	intersects(Geometry geometry) Tests whether this geometry intersects the argument geometry.
MultiPolygon	prepare()

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

copy, equalsExact, getBoundary, getBoundaryDimension, getDataType, getDimension, getPolygon, getPolygons, getSegment, getToVertex, getVertex, isEquivalentClass, moveVertex, normalize, reverse, segments, vertices

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, convert, convert, convexHull, coveredBy, createVertexId, crosses, difference, disjoint, distance, envelopeCovers, envelopesIntersect, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, getAxisCount, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometryType, getInteriorPoint, getNonZeroGeometryFactory, getSrid, getUserData, getVertexIndex, hashCode, hasInvalidXyCoordinates, hasNonEmptyElements, hasNullElements, intersection, isAnyTargetComponentInTest, isGeometryCollection, isRectangle, isSimple, isValid, isWithinDistance, overlaps, relate, relate, setUserData, 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.GeometryCollection

clone

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

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

Constructor Detail

PreparedMultiPolygon

public PreparedMultiPolygon(MultiPolygon polygon)

Method Detail

contains

public boolean contains(Geometry g)

Description copied from class: AbstractGeometry

Tests whether this geometry contains the argument geometry.

The contains predicate has the following equivalent definitions:

• Every point of the other geometry is a point of this geometry, and the interiors of the two geometries have at least one point in common.
• The DE-9IM Intersection Matrix for the two geometries matches the pattern [T*****FF*]
• g.within(this) = true
  (contains is the converse of AbstractGeometry.within(com.revolsys.jts.geom.Geometry) )

An implication of the definition is that "Geometries do not contain their boundary". In other words, if a geometry A is a subset of the points in the boundary of a geometry B, B.contains(A) = false. (As a concrete example, take A to be a LineString which lies in the boundary of a Polygon B.) For a predicate with similar behaviour but avoiding this subtle limitation, see AbstractGeometry.covers(com.revolsys.jts.geom.Geometry).

Specified by:

contains in interface Geometry

Overrides:

contains in class AbstractGeometry

Parameters:

g - the Geometry with which to compare this Geometry

Returns:

true if this Geometry contains g

See Also:

Geometry.within(com.revolsys.jts.geom.Geometry), Geometry.covers(com.revolsys.jts.geom.Geometry)

containsProperly

public boolean containsProperly(Geometry geometry)

Specified by:

containsProperly in interface Geometry

Overrides:

containsProperly in class AbstractGeometry

covers

public boolean covers(Geometry geometry)

Description copied from class: AbstractGeometry

Tests whether this geometry covers the argument geometry.

The covers predicate has the following equivalent definitions:

• Every point of the other geometry is a point of this geometry.
• The DE-9IM Intersection Matrix for the two geometries matches at least one of the following patterns:
  • [T*****FF*]
  • [*T****FF*]
  • [***T**FF*]
  • [****T*FF*]
• g.coveredBy(this) = true
  (covers is the converse of AbstractGeometry.coveredBy(com.revolsys.jts.geom.Geometry))

If either geometry is empty, the value of this predicate is false.

This predicate is similar to AbstractGeometry.contains(com.revolsys.jts.geom.Geometry), but is more inclusive (i.e. returns true for more cases). In particular, unlike contains it does not distinguish between points in the boundary and in the interior of geometries. For most situations, covers should be used in preference to contains. As an added benefit, covers is more amenable to optimization, and hence should be more performant.

Specified by:

covers in interface Geometry

Overrides:

covers in class AbstractGeometry

Parameters:

geometry - the Geometry with which to compare this Geometry

Returns:

true if this Geometry covers g

See Also:

Geometry.contains(com.revolsys.jts.geom.Geometry), Geometry.coveredBy(com.revolsys.jts.geom.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

Specified by:

getBoundingBox in interface Polygonal

Overrides:

getBoundingBox in class AbstractGeometry

Returns:

the boundingBox of this Geometry.

getGeometries

public <V extends Geometry> List<V> getGeometries()

Specified by:

getGeometries in interface Geometry

Overrides:

getGeometries in class AbstractGeometry

getGeometry

public <V extends Geometry> V getGeometry(int partIndex)

Description copied from class: AbstractGeometry

Returns an element Geometry from a GeometryCollection (or this, if the geometry is not a collection).

Specified by:

getGeometry in interface Geometry

Overrides:

getGeometry in class AbstractGeometry

Parameters:

partIndex - the index of the geometry element

Returns:

the n'th geometry contained in this geometry

getGeometryCount

public int getGeometryCount()

Description copied from class: AbstractGeometry

Returns the number of Geometrys in a GeometryCollection (or 1, if the geometry is not a collection).

Specified by:

getGeometryCount in interface Geometry

Overrides:

getGeometryCount in class AbstractGeometry

Returns:

the number of geometries contained in this geometry

getGeometryFactory

public GeometryFactory getGeometryFactory()

Description copied from interface: Geometry

Gets the geometryFactory which contains the context in which this geometry was created.

Specified by:

getGeometryFactory in interface Geometry

Overrides:

getGeometryFactory in class AbstractGeometry

Returns:

the geometryFactory for this geometry

getIntersectionFinder

public FastSegmentSetIntersectionFinder getIntersectionFinder()

Gets the indexed intersection finder for this geometry.

Returns:

the intersection finder

getMultiPolygon

public MultiPolygon getMultiPolygon()

getPointLocator

public PointOnGeometryLocator getPointLocator()

getRepresentativePoints

public List<Point> getRepresentativePoints()

Gets the list of representative points for this geometry. One vertex is included for every component of the geometry (i.e. including one for every ring of polygonal geometries). Do not modify the returned list!

Returns:

a List of Coordinate

intersects

public boolean intersects(Geometry geometry)

Description copied from class: AbstractGeometry

Tests whether this geometry intersects the argument geometry.

The intersects predicate has the following equivalent definitions:

• The two geometries have at least one point in common
• The DE-9IM Intersection Matrix for the two geometries matches at least one of the patterns
  • [T********]
  • [*T*******]
  • [***T*****]
  • [****T****]
• ! g.disjoint(this) = true
  (intersects is the inverse of disjoint)

Specified by:

intersects in interface Geometry

Overrides:

intersects in class AbstractGeometry

Parameters:

geometry - the Geometry with which to compare this Geometry

Returns:

true if the two Geometrys intersect

See Also:

Geometry.disjoint(com.revolsys.jts.geom.Geometry)

prepare

public MultiPolygon prepare()