com.revolsys.jts.geom.prep

Class PreparedPolygon

java.lang.Object

com.revolsys.jts.geom.impl.AbstractGeometry

com.revolsys.jts.geom.impl.AbstractPolygon

com.revolsys.jts.geom.prep.PreparedPolygon

All Implemented Interfaces:

DataTypeProxy, Geometry, Polygon, Polygonal, Serializable, Cloneable, Comparable<Object>

public class PreparedPolygon
extends AbstractPolygon

A prepared version for Polygonal geometries. This class supports both Polygons and MultiPolygons.

This class does not support MultiPolygons 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
PreparedPolygon(Polygon 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.
FastSegmentSetIntersectionFinder	getIntersectionFinder() Gets the indexed intersection finder for this geometry.
PointOnGeometryLocator	getPointLocator()
Polygon	getPolygon()
List<Point>	getRepresentativePoints() Gets the list of representative points for this geometry.
LinearRing	getRing(int ringIndex)
int	getRingCount()
List<LinearRing>	getRings()
boolean	intersects(Geometry geometry) Tests whether this geometry intersects the argument geometry.
Polygon	prepare()

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

appendVertex, clone, compareToSameClass, computeBoundingBox, convexHull, copy, deleteVertex, doEquals, equalsExact, getArea, getBoundary, getBoundaryDimension, getDataType, getDimension, getExteriorRing, getGeometryComponents, getGeometryFactory, getInteriorRing, getLength, getNumInteriorRing, getPoint, getPointWithin, getSegment, getToVertex, getVertex, getVertexCount, holes, insertVertex, intersects, isEmpty, isEquivalentClass, isRectangle, minCoordinateIndex, move, moveVertex, normalize, reverse, rings, scroll, segments, toClockwise, toCounterClockwise, vertices

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

buffer, buffer, buffer, checkNotGeometryCollection, compare, compareTo, convert, convert, coveredBy, createVertexId, crosses, difference, disjoint, distance, envelopeCovers, envelopesIntersect, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, geometries, getAxisCount, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryCount, getGeometryType, getInteriorPoint, getNonZeroGeometryFactory, getSrid, getUserData, getVertexIndex, hashCode, hasInvalidXyCoordinates, hasNonEmptyElements, hasNullElements, intersection, isAnyTargetComponentInTest, isGeometryCollection, 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.Geometry

buffer, buffer, buffer, compareTo, convert, convert, coveredBy, crosses, difference, disjoint, distance, equal, equals, equals, equals, equalsExact, equalsNorm, equalsTopo, geometries, getAxisCount, getCentroid, getClassSortIndex, getCoordinateSystem, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryCount, getGeometryType, getInteriorPoint, getSrid, getUserData, hashCode, hasInvalidXyCoordinates, intersection, isSimple, isValid, isWithinDistance, overlaps, relate, relate, setUserData, symDifference, touches, toWkt, union, union, within

Constructor Detail

PreparedPolygon

public PreparedPolygon(Polygon 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.

getIntersectionFinder

public FastSegmentSetIntersectionFinder getIntersectionFinder()

Gets the indexed intersection finder for this geometry.

Returns:

the intersection finder

getPointLocator

public PointOnGeometryLocator getPointLocator()

getPolygon

public Polygon getPolygon()

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

getRing

public LinearRing getRing(int ringIndex)

getRingCount

public int getRingCount()

getRings

public List<LinearRing> getRings()

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

Specified by:

prepare in interface Geometry

Specified by:

prepare in interface Polygon

Overrides:

prepare in class AbstractPolygon