GeometryOperations (geolatte-geom 0.15 API)

```
public interface GeometryOperations
```
A factory for GeometryOperations.

The semantics of the operations is as specified in Simple Feature Access - Part 1: common architecture

Author:

Karel Maesen, Geovise BVBA

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GeometryOperation<Geometry>`	`createBoundaryOp(Geometry geometry)` Creates an operation to calculate the boundary of the specified `Geometry`.
`GeometryOperation<Geometry>`	`createBufferOp(Geometry geometry, double distance)` Returns an operation to calculate a `Geometry` that represents all points whose distance from the specified `Geometry` is less than or equal the specified distance.
`GeometryOperation<Boolean>`	`createContainsOp(Geometry geometry, Geometry other)` Creates an operation to check if the first specified `Geometry` spatially contains the second.
`GeometryOperation<Geometry>`	`createConvexHullOp(Geometry geometry)` Returns an operation to calculate the convex hull of the specified `Geometry`.
`GeometryOperation<Boolean>`	`createCrossesOp(Geometry geometry, Geometry other)` Creates an operation to check if the specified `Geometry`s cross.
`GeometryOperation<Geometry>`	`createDifferenceOp(Geometry geometry, Geometry other)` Returns an operation to calculate the point set difference of the specified `Geometry`s.
`GeometryOperation<Double>`	`createDistanceOp(Geometry geometry, Geometry other)` Returns an operation to calculate the shortest distance between any two points in the two `Geometry`s in the coordinate reference system of this `Geometry`.
`GeometryOperation<Envelope>`	`createEnvelopeOp(Geometry geometry)` Creates an operation to calculate the `Envelope` of the specified `Geometry`.
`GeometryOperation<Geometry>`	`createIntersectionOp(Geometry geometry, Geometry other)` Returns an operation to calculate the point set intersection of the specified `Geometry`s.
`GeometryOperation<Boolean>`	`createIntersectsOp(Geometry geometry, Geometry other)` Creates an operation to check if the specified `Geometry`s intersect.
`GeometryOperation<Boolean>`	`createIsSimpleOp(Geometry geometry)` Creates an operation to test the simplicity of the specified `Geometry`.
`GeometryOperation<Geometry>`	`createLocateAlongOp(Geometry geometry, double mValue)` Creates an operation to calculate the `GeometryCollection` that matches the specified M-coordinate value.
`GeometryOperation<Geometry>`	`createLocateBetweenOp(Geometry geometry, double startMeasure, double endMeasure)` Creates an operation to calculate the `GeometryCollection` that matches the specified range of M-coordinate value inclusively.
`GeometryOperation<Boolean>`	`createOverlapsOp(Geometry geometry, Geometry other)` Creates an operation to check if the specified `Geometry`s overlap.
`GeometryOperation<Boolean>`	`createRelateOp(Geometry geometry, Geometry other, String matrix)` Creates an operation to check if the specified `Geometry`s are spatially related by testing for intersections between the interior, boundary and exterior of the two geometric objects as specified by the values in the intersection pattern matrix.
`GeometryOperation<Geometry>`	`createSymDifferenceOp(Geometry geometry, Geometry other)` Returns an operation to calculate the point set symmetric difference of the specified `Geometry`s.
`GeometryOperation<Boolean>`	`createTouchesOp(Geometry geometry, Geometry other)` Creates an operation to check if the specified `Geometry`s touch.
`GeometryOperation<ByteBuffer>`	`createToWkbOp(Geometry geometry)` Creates an operation to encode the specified `Geometry` to Well-Known Binary format (WKB).
`GeometryOperation<String>`	`createToWktOp(Geometry geometry)` Creates an operation to encode the specified `Geometry` to Well-Known Text (WKT).
`GeometryOperation<Geometry>`	`createUnionOp(Geometry geometry, Geometry other)` Returns an operation to calculate the point set union of the specified `Geometry`s.

- Method Detail
  - createIsSimpleOp
```
GeometryOperation<Boolean> createIsSimpleOp(Geometry geometry)
```
    Creates an operation to test the simplicity of the specified Geometry.
    
    Parameters:
    
    geometry - the Geometry to test for simplicity.
    
    Returns:
    
    a GeometryOperation that checks if the specified Geometry is simple.
  - createBoundaryOp
```
GeometryOperation<Geometry> createBoundaryOp(Geometry geometry)
```
    Creates an operation to calculate the boundary of the specified Geometry.
    
    Parameters:
    
    geometry - the Geometry for which to calculate the boundary.
    
    Returns:
    
    a GeometryOperation that calculates a Geometry representing the boundary of the specified Geometry.
  - createEnvelopeOp
```
GeometryOperation<Envelope> createEnvelopeOp(Geometry geometry)
```
    Creates an operation to calculate the Envelope of the specified Geometry.
    
    Parameters:
    
    geometry - the Geometry for which to calculate the envelope.
    
    Returns:
    
    a GeometryOperation that calculates the Envelope of the specified Geometry.
  - createIntersectsOp
```
GeometryOperation<Boolean> createIntersectsOp(Geometry geometry,
                                              Geometry other)
```
    Creates an operation to check if the specified Geometrys intersect.
    
    Parameters:
    
    geometry - the first Geometry operand of the intersection test
    
    other - the second Geometry operand of the intersection test
    
    Returns:
    
    a GeometryOperation that checks if the specified Geometrys spatially intersect
  - createTouchesOp
```
GeometryOperation<Boolean> createTouchesOp(Geometry geometry,
                                           Geometry other)
```
    Creates an operation to check if the specified Geometrys touch.
    
    Parameters:
    
    geometry - the first Geometry operand of the touch test
    
    other - the second Geometry operand of the touch test
    
    Returns:
    
    a GeometryOperation that checks if the specified Geometrys spatially touch
  - createCrossesOp
```
GeometryOperation<Boolean> createCrossesOp(Geometry geometry,
                                           Geometry other)
```
    Creates an operation to check if the specified Geometrys cross.
    
    Parameters:
    
    geometry - the first Geometry operand of the cross test
    
    other - the second Geometry operand of the cross test
    
    Returns:
    
    a GeometryOperation that checks if the specified Geometrys spatially cross
  - createContainsOp
```
GeometryOperation<Boolean> createContainsOp(Geometry geometry,
                                            Geometry other)
```
    Creates an operation to check if the first specified Geometry spatially contains the second.
    
    Parameters:
    
    geometry - the first Geometry operand of the containment test
    
    other - the second Geometry operand of the containment test
    
    Returns:
    
    a GeometryOperation that checks if the first specified Geometry spatially contains the second
  - createOverlapsOp
```
GeometryOperation<Boolean> createOverlapsOp(Geometry geometry,
                                            Geometry other)
```
    Creates an operation to check if the specified Geometrys overlap.
    
    Parameters:
    
    geometry - the first Geometry operand of the overlap test
    
    other - the second Geometry operand of the overlap test
    
    Returns:
    
    a GeometryOperation that checks if the specified Geometrys spatially overlap
  - createRelateOp
```
GeometryOperation<Boolean> createRelateOp(Geometry geometry,
                                          Geometry other,
                                          String matrix)
```
    Creates an operation to check if the specified Geometrys are spatially related by testing for intersections between the interior, boundary and exterior of the two geometric objects as specified by the values in the intersection pattern matrix. This returns false if all the tested intersections are empty except exterior (this) intersect exterior (another).
    
    Parameters:
    
    geometry - the first Geometry operand of the relate test
    
    other - the second Geometry operand of the relate test
    
    matrix - the intersection pattern matrix
    
    Returns:
    
    a GeometryOperation that checks if this instance intersects the specifed other Geometry
  - createLocateAlongOp
```
GeometryOperation<Geometry> createLocateAlongOp(Geometry geometry,
                                                double mValue)
```
    Creates an operation to calculate the GeometryCollection that matches the specified M-coordinate value.
    
    This method is only valid if executed on 0- or 1-dimensional objects or collections thereof.
    
    The semantics implemented here are specified by SFA 1.2.1, § 6.1.2.6.
    
    Parameters:
    
    geometry - the geometry on which to perform the calculation
    
    mValue - the specified M-coordinate value
    
    Returns:
    
    a GeometryOperation that calculates the GeometryCollection matching the specified M-coordinate value.
    
    Throws:
    
    IllegalArgumentException - if this method is executed on 2-dimensional Geometrys.
  - createLocateBetweenOp
```
GeometryOperation<Geometry> createLocateBetweenOp(Geometry geometry,
                                                  double startMeasure,
                                                  double endMeasure)
```
    Creates an operation to calculate the GeometryCollection that matches the specified range of M-coordinate value inclusively.
    
    This method is only valid if executed on 0- or 1-dimensional objects or collections thereof.
    
    The semantics implemented here are specified by SFA 1.2.1, § 6.1.2.6.
    
    Parameters:
    
    geometry - the geometry on which to perform the calculation
    
    startMeasure - the start of the specified range of M-coordinate values
    
    endMeasure - the end of the specified range of M-coordinate values
    
    Returns:
    
    a GeometryOperation that calculates the GeometryCollection matching the specified range of M-coordinate values.
    
    Throws:
    
    IllegalArgumentException - if this method is executed on 2-dimensional Geometrys.
  - createDistanceOp
```
GeometryOperation<Double> createDistanceOp(Geometry geometry,
                                           Geometry other)
```
    Returns an operation to calculate the shortest distance between any two points in the two Geometrys in the coordinate reference system of this Geometry. Only the X/Y-coordinates are used in the distance calculation; M- and Z-coordinates are ignored.
    
    Parameters:
    
    geometry - the first Geometry
    
    other - the second Geometry
    
    Returns:
    
    a GeometryOperation that calculates the shortest distance between the two specified Geometries
  - createBufferOp
```
GeometryOperation<Geometry> createBufferOp(Geometry geometry,
                                           double distance)
```
    Returns an operation to calculate a Geometry that represents all points whose distance from the specified Geometry is less than or equal the specified distance.
    
    Calculations are in the CoordinateReferenceSystem of this Geometry.
    
    Z- or M-coordinates are ignored in the buffering operation; and the result will always be a 2D geometry.
    
    Parameters:
    
    geometry - the Geometry for which to calculate the buffer
    
    distance - the buffer distance
    
    Returns:
    
    a GeometryOperation that calculates a 2D Geometry representing the buffer of the specified Geometry with the specified distance.
  - createConvexHullOp
```
GeometryOperation<Geometry> createConvexHullOp(Geometry geometry)
```
    Returns an operation to calculate the convex hull of the specified Geometry.
    
    Parameters:
    
    geometry - the Geometry for which to calculate the convex hull.
    
    Returns:
    
    a GeometryOperation that calculates the convex hull for the specified Geometry.
  - createIntersectionOp
```
GeometryOperation<Geometry> createIntersectionOp(Geometry geometry,
                                                 Geometry other)
```
    Returns an operation to calculate the point set intersection of the specified Geometrys.
    
    Parameters:
    
    geometry - the first Geometry
    
    other - the second Geometry
    
    Returns:
    
    a GeometryOperation that calculates the point set intersection between the two specified Geometries
  - createUnionOp
```
GeometryOperation<Geometry> createUnionOp(Geometry geometry,
                                          Geometry other)
```
    Returns an operation to calculate the point set union of the specified Geometrys.
    
    Parameters:
    
    geometry - the first Geometry
    
    other - the second Geometry
    
    Returns:
    
    a GeometryOperation that calculates the point set union between the two specified Geometries
  - createDifferenceOp
```
GeometryOperation<Geometry> createDifferenceOp(Geometry geometry,
                                               Geometry other)
```
    Returns an operation to calculate the point set difference of the specified Geometrys.
    
    Parameters:
    
    geometry - the first Geometry
    
    other - the second Geometry
    
    Returns:
    
    a GeometryOperation that calculates the point set difference between the two specified Geometries
  - createSymDifferenceOp
```
GeometryOperation<Geometry> createSymDifferenceOp(Geometry geometry,
                                                  Geometry other)
```
    Returns an operation to calculate the point set symmetric difference of the specified Geometrys.
    
    Parameters:
    
    geometry - the first Geometry
    
    other - the second Geometry
    
    Returns:
    
    a GeometryOperation that calculates the point set symmetric difference between the two specified Geometries
  - createToWktOp
```
GeometryOperation<String> createToWktOp(Geometry geometry)
```
    Creates an operation to encode the specified Geometry to Well-Known Text (WKT).
    Which "dialect" of WKT is used, is implementation defined.
    
    Parameters:
    
    geometry - the Geometry to encode into WKT
    
    Returns:
    
    An operation that encodes the specified Geometry to WKT
  - createToWkbOp
```
GeometryOperation<ByteBuffer> createToWkbOp(Geometry geometry)
```
    Creates an operation to encode the specified Geometry to Well-Known Binary format (WKB).
    Which "dialect" of WKB is used, is implementation defined.
    
    Parameters:
    
    geometry - the Geometry to encode to WKB
    
    Returns:
    
    An operation that encodes the specified Geometry to WKB

Interface GeometryOperations

Method Summary

Method Detail

createIsSimpleOp

createBoundaryOp

createEnvelopeOp

createIntersectsOp

createTouchesOp

createCrossesOp

createContainsOp

createOverlapsOp

createRelateOp

createLocateAlongOp

createLocateBetweenOp

createDistanceOp

createBufferOp

createConvexHullOp

createIntersectionOp

createUnionOp

createDifferenceOp

createSymDifferenceOp

createToWktOp

createToWkbOp