PreparedGeometry (Groovy Documentation)

geoscript.geom.PreparedGeometry

class PreparedGeometry
extends java.lang.Object

A PreparedGeometry makes repeated spatial operations more efficient.

You can create a PreparedGeometry by wrapping an existing Geometry:

 def p1 = new PreparedGeometry(new Point(1,4))

Or by calling the prepare() method on a Geometry:

 def prep = Geometry.fromWKT('POLYGON ((0 0, 5 0, 5 5, 0 5, 0 0))').prepare()

Or by using the Geometry.prepare() static method:

 def prep = Geometry.prepared(Geometry.fromWKT('POLYGON ((0 0, 5 0, 5 5, 0 5, 0 0))'))

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`static PreparedGeometryFactory`	`factory` The JTS PreparedGeometryFactory
`PreparedGeometry`	`prepGeom` The wrapped JTS PreparedGeometry

Constructor Summary

Constructors
Constructor and description
`PreparedGeometry (Geometry geom)` Create a PreparedGeometry from a Geometry

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`contains(Geometry geom)` Whether this PreparedGeometry contains the given Geometry
	`boolean`	`containsProperly(Geometry geom)` Whether this PreparedGeometry contains the given Geometry.
	`boolean`	`coveredBy(Geometry geom)` Whether this PreparedGeometry is covered by the given Geometry.
	`boolean`	`covers(Geometry geom)` Whether this PreparedGeometry covers the given Geometry.
	`boolean`	`crosses(Geometry geom)` Whether this PreparedGeometry crosses the given Geometry.
	`boolean`	`disjoint(Geometry geom)` Whether this PreparedGeometry is disjoint the given Geometry.
	`Geometry`	`getGeometry()` Get the base Geometry of this PreparedGeometry
	`boolean`	`intersects(Geometry geom)` Whether this PreparedGeometry intersects the given Geometry.
	`boolean`	`overlaps(Geometry geom)` Whether this PreparedGeometry overlaps the given Geometry.
	`java.lang.String`	`toString()` The String representation
	`boolean`	`touches(Geometry geom)` Whether this PreparedGeometry touches the given Geometry.
	`boolean`	`within(Geometry geom)` Whether this PreparedGeometry is within the given Geometry.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static PreparedGeometryFactory factory
    
    The JTS PreparedGeometryFactory
  - PreparedGeometry prepGeom
    
    The wrapped JTS PreparedGeometry
- Constructor Detail
  - PreparedGeometry(Geometry geom)
    
    Create a PreparedGeometry from a Geometry
    Parameters:
    A - Geometry
- Method Detail
  - boolean contains(Geometry geom)
    
    Whether this PreparedGeometry contains the given Geometry
    Parameters:
    The - other Geometry
    Returns:
    Whether this PreparedGeometry contains the other Geometry
  - boolean containsProperly(Geometry geom)
    
    Whether this PreparedGeometry contains the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry contains the given Geometry.
  - boolean coveredBy(Geometry geom)
    
    Whether this PreparedGeometry is covered by the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry is covered by the given Geometry.
  - boolean covers(Geometry geom)
    
    Whether this PreparedGeometry covers the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry covers the given Geometry.
  - boolean crosses(Geometry geom)
    
    Whether this PreparedGeometry crosses the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry crosses the given Geometry.
  - boolean disjoint(Geometry geom)
    
    Whether this PreparedGeometry is disjoint the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry is disjoint the given Geometry.
  - Geometry getGeometry()
    
    Get the base Geometry of this PreparedGeometry
    Returns:
    The Geometry
  - boolean intersects(Geometry geom)
    
    Whether this PreparedGeometry intersects the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry intersects the given Geometry.
  - boolean overlaps(Geometry geom)
    
    Whether this PreparedGeometry overlaps the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry overlaps the given Geometry.
  - java.lang.String toString()
    
    The String representation
    Returns:
    The String representation
  - boolean touches(Geometry geom)
    
    Whether this PreparedGeometry touches the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry touches the given Geometry.
  - boolean within(Geometry geom)
    
    Whether this PreparedGeometry is within the given Geometry.
    Parameters:
    geom - The other Geometry
    Returns:
    Whether this PreparedGeometry is within the given Geometry.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class PreparedGeometry

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static PreparedGeometryFactory factory

PreparedGeometry prepGeom

Constructor Detail

PreparedGeometry(Geometry geom)

Method Detail

boolean contains(Geometry geom)

boolean containsProperly(Geometry geom)

boolean coveredBy(Geometry geom)

boolean covers(Geometry geom)

boolean crosses(Geometry geom)

boolean disjoint(Geometry geom)

Geometry getGeometry()

boolean intersects(Geometry geom)

boolean overlaps(Geometry geom)

java.lang.String toString()

boolean touches(Geometry geom)

boolean within(Geometry geom)