Geometry (JMap 7.0 Kathmandu API Documentation)

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Subinterfaces:

AnnotationTypeGeometry, Curve, EllipseTypeGeometry, LineTypeGeometry, PointTypeGeometry, PolygonTypeGeometry, Surface

All Known Implementing Classes:

Annotation, Complex, DefaultGeometry, Ellipse, GeometryCollection, Line, LinearRing, LineString, MultiAnnotation, MultiCurve, MultiLineString, MultiPoint, MultiPolygon, MultiSurface, OrientedRectangle, OrientedRectangle.Double, OrientedRectangle.Float, Point, Point.Double, Point.Float, PointM, Polygon, Rectangle, Rectangle.Double, Rectangle.Float
```
public interface Geometry
extends java.lang.Cloneable, java.io.Serializable
```
This interface is implemented by all geometry classes in JMap.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`GEOMETRY_ANNOTATION` Constant for geometry id of type `Annotation`.
`static short`	`GEOMETRY_COMPLEX` Constant for geometry id of type `Complex`.
`static short`	`GEOMETRY_ELLIPSE` Constant for geometry id of type `Ellipse`.
`static short`	`GEOMETRY_LINE` Constant for geometry id of type `Line`.
`static short`	`GEOMETRY_LINEAR_RING` Constant for geometry id of type `LinearRing`.
`static short`	`GEOMETRY_LINESTRING` Constant for geometry id of type `LineString`.
`static short`	`GEOMETRY_MULTI_ANNOTATION` Constant for geometry id of type `MultiAnnotation`.
`static short`	`GEOMETRY_MULTI_LINESTRING` Constant for geometry id of type `MultiLineString`.
`static short`	`GEOMETRY_MULTI_POINT` Constant for geometry id of type `MultiPoint`.
`static short`	`GEOMETRY_MULTI_POLYGON` Constant for geometry id of type `MultiPolygon`.
`static short`	`GEOMETRY_POINT` Constant for geometry id of type `Point`.
`static short`	`GEOMETRY_POLYGON` Constant for geometry id of type `Polygon`.
`static short`	`GEOMETRY_RECTANGLE` Constant for geometry id of type `Rectangle`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default double`	`area()` Returns the geometry area.
`java.lang.String`	`asText()`
`Geometry`	`boundary()` Returns the boundary of this geometry as a line string.
`Geometry`	`clone()` Clones this geometry.
`void`	`createBounds()` Updates the geometry bounds from the current geometry.
`Rectangle`	`getBounds()` Returns the minimum bounding rectangle of this geometry.
`Point`	`getCenteredPoint()` This method returns a point that is typically centered on the geometry.
`short`	`getGeometryId()` Returns the geometry class id.
`int`	`getGeometryType()` Returns the geometry type for this geometry.
`default double`	`length()` Returns the geometry length.
`Point[]`	`serialize()` Returns this geometry as an array of Point.
`int`	`sizeOf()` Returns an approximation in bytes of the memory used by this geometry.
`boolean`	`spatiallyEquals(Geometry geometry)` Deprecated.
`boolean`	`spatiallyEquals(Geometry geometry, PrecisionModel precisionModel)` Tests if this geometry is equal to the argument, on a topological point of view.
`java.lang.String`	`toString()` Returns informations about the current geometry.
`Geometry`	`transform(Transformation tr)` Creates a clone of the current geometry and returns the new instance transformed with the specified geometry transformation. The returned geometry can be of any geometry types after the transformation.
`void`	`translate(double dx, double dy)` Translate this geometry with the specified values.

- Field Detail
  - GEOMETRY_POINT
```
static final short GEOMETRY_POINT
```
    Constant for geometry id of type Point.
    
    See Also:
    
    Point, Constant Field Values
  - GEOMETRY_MULTI_POINT
```
static final short GEOMETRY_MULTI_POINT
```
    Constant for geometry id of type MultiPoint.
    
    See Also:
    
    MultiPoint, Constant Field Values
  - GEOMETRY_LINESTRING
```
static final short GEOMETRY_LINESTRING
```
    Constant for geometry id of type LineString.
    
    See Also:
    
    LineString, Constant Field Values
  - GEOMETRY_MULTI_LINESTRING
```
static final short GEOMETRY_MULTI_LINESTRING
```
    Constant for geometry id of type MultiLineString.
    
    See Also:
    
    MultiLineString, Constant Field Values
  - GEOMETRY_LINE
```
static final short GEOMETRY_LINE
```
    Constant for geometry id of type Line.
    
    See Also:
    
    Line, Constant Field Values
  - GEOMETRY_POLYGON
```
static final short GEOMETRY_POLYGON
```
    Constant for geometry id of type Polygon.
    
    See Also:
    
    Polygon, Constant Field Values
  - GEOMETRY_MULTI_POLYGON
```
static final short GEOMETRY_MULTI_POLYGON
```
    Constant for geometry id of type MultiPolygon.
    
    See Also:
    
    MultiPolygon, Constant Field Values
  - GEOMETRY_LINEAR_RING
```
static final short GEOMETRY_LINEAR_RING
```
    Constant for geometry id of type LinearRing.
    
    See Also:
    
    LinearRing, Constant Field Values
  - GEOMETRY_COMPLEX
```
static final short GEOMETRY_COMPLEX
```
    Constant for geometry id of type Complex.
    
    See Also:
    
    Complex, Constant Field Values
  - GEOMETRY_RECTANGLE
```
static final short GEOMETRY_RECTANGLE
```
    Constant for geometry id of type Rectangle.
    
    See Also:
    
    Rectangle, Constant Field Values
  - GEOMETRY_ANNOTATION
```
static final short GEOMETRY_ANNOTATION
```
    Constant for geometry id of type Annotation.
    
    See Also:
    
    Annotation, Constant Field Values
  - GEOMETRY_ELLIPSE
```
static final short GEOMETRY_ELLIPSE
```
    Constant for geometry id of type Ellipse.
    
    See Also:
    
    Ellipse, Constant Field Values
  - GEOMETRY_MULTI_ANNOTATION
```
static final short GEOMETRY_MULTI_ANNOTATION
```
    Constant for geometry id of type MultiAnnotation.
    
    See Also:
    
    MultiAnnotation, Constant Field Values
- Method Detail
  - getBounds
```
Rectangle getBounds()
```
    Returns the minimum bounding rectangle of this geometry.
    
    Returns:
    
    the bounding box of this geometry.
  - serialize
```
Point[] serialize()
```
    Returns this geometry as an array of Point.
    
    Returns:
    
    this geometry as an array of Point.
  - clone
```
Geometry clone()
```
    Clones this geometry.
    
    Returns:
    
    a deep copy of the current geometry.
  - spatiallyEquals
```
@Deprecated
boolean spatiallyEquals(Geometry geometry)
```
    Deprecated.
    
    Tests if this geometry is equal to the argument, on a topological point of view
    it means that they represents the same geometry, even if it is described differently (direction of the rings, order of the rings)
    it does not remove additional points on lineString (3 points aligned), one must use smoother.removeExtraPoints() before in order to achieve that.
    
    Parameters:
    
    geometry - the geometry to be tested.
    
    Returns:
    
    whether or not both geometries are spatial equals.
  - spatiallyEquals
```
boolean spatiallyEquals(Geometry geometry,
                        PrecisionModel precisionModel)
```
    Tests if this geometry is equal to the argument, on a topological point of view.
    
    Parameters:
    
    geometry - the geometry to be tested.
    
    precisionModel - the precision model to use while comparing geometries.
    
    Returns:
    
    whether or not both geometries are spatially equals.
  - boundary
```
Geometry boundary()
```
    Returns the boundary of this geometry as a line string.
    
    Returns:
    
    a line string which defines the boundary of the current geometry.
  - toString
```
java.lang.String toString()
```
    Returns informations about the current geometry.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    informations about the current geometry.
  - translate
```
void translate(double dx,
               double dy)
```
    Translate this geometry with the specified values.
    
    Parameters:
    
    dx - translation on the X-axis.
    
    dy - translation on the Y-axis.
  - sizeOf
```
int sizeOf()
```
    Returns an approximation in bytes of the memory used by this geometry.
    
    Returns:
    
    the memory used by this geometry.
  - getGeometryId
```
short getGeometryId()
```
    Returns the geometry class id. This method is useful for geometry serialization.
    
    Returns:
    
    the geometry id.
  - getGeometryType
```
int getGeometryType()
```
    Returns the geometry type for this geometry.
    
    Returns:
    
    the geometry type.
    
    See Also:
    
    for more details.
  - transform
```
Geometry transform(Transformation tr)
```
    Creates a clone of the current geometry and returns the new instance transformed with the specified geometry transformation.
    The returned geometry can be of any geometry types after the transformation.
    
    Parameters:
    
    tr - the transformation to apply.
    
    Returns:
    
    the newly created and transformed geometry instance.
  - createBounds
```
void createBounds()
```
    Updates the geometry bounds from the current geometry.
  - getCenteredPoint
```
Point getCenteredPoint()
```
    This method returns a point that is typically centered on the geometry. If the geometry is a point, the point is returned. If it is a line, a point on the curve interpolated at 50% is returned. If the geometry is a surface, the centroid is returned if it is inside the polygon, if not, a point inside the polygon (but likely not exactly in the center) will be returned. If the geometry is a collection, the method is called on the first part of the collection.
    
    Returns:
    
    a point likely at the center of the geometry
  - asText
```
java.lang.String asText()
```
  - area
```
default double area()
```
    Returns the geometry area. If the geometry is not a surface, then 0 shall be returned.
    
    Returns:
    
    the geometry area.
  - length
```
default double length()
```
    Returns the geometry length. If the geometry is a surface, then the geometry perimeter shall be returned.
    
    Returns:
    
    the geometry length.

Interface Geometry

Field Summary

Method Summary

Field Detail

GEOMETRY_POINT

GEOMETRY_MULTI_POINT

GEOMETRY_LINESTRING

GEOMETRY_MULTI_LINESTRING

GEOMETRY_LINE

GEOMETRY_POLYGON

GEOMETRY_MULTI_POLYGON

GEOMETRY_LINEAR_RING

GEOMETRY_COMPLEX

GEOMETRY_RECTANGLE

GEOMETRY_ANNOTATION

GEOMETRY_ELLIPSE

GEOMETRY_MULTI_ANNOTATION

Method Detail

getBounds

serialize

clone

spatiallyEquals

spatiallyEquals

boundary

toString

translate

sizeOf

getGeometryId

getGeometryType

transform

createBounds

getCenteredPoint

asText

area

length