@UML(identifier="GM_Envelope", specification=ISO_19107) public interface Envelope
Envelope
can
be represented without ambiguity as two direct positions (coordinate points). To encode an
Envelope
, it is sufficient to encode these two points. This is consistent with
all of the data types in this specification, their state is represented by their publicly
accessible attributes.org.opengis.coverage.grid.GridEnvelope
Departure from OGC/ISO specification:
This interface was moved into theorg.opengis.geometry
package for convenience.
Modifier and Type  Method and Description 

CoordinateReferenceSystem 
getCoordinateReferenceSystem()
Returns the envelope coordinate reference system, or
null if unknown. 
int 
getDimension()
The length of coordinate sequence (the number of entries) in this envelope.

DirectPosition 
getLowerCorner()
A coordinate position consisting of all the minimal ordinates for each
dimension for all points within the
Envelope . 
double 
getMaximum(int dimension)
Returns the maximal ordinate along the specified dimension.

double 
getMedian(int dimension)
Returns the median ordinate along the specified dimension.

double 
getMinimum(int dimension)
Returns the minimal ordinate along the specified dimension.

double 
getSpan(int dimension)
Returns the envelope span (typically width or height) along the specified dimension.

DirectPosition 
getUpperCorner()
A coordinate position consisting of all the maximal ordinates for each
dimension for all points within the
Envelope . 
CoordinateReferenceSystem getCoordinateReferenceSystem()
null
if unknown.
If nonnull, it shall be the same as lower corner
and upper corner CRS.null
if unknown.Departure from OGC/ISO specification:
ISO does not define this method  the CRS or the dimension can be obtained only through one of the cornerDirectPosition
objects. GeoAPI adds this method for convenience as a more direct way of obtaining the information and to free the user from the need to choose an arbitrary corner (very defensive code might feel the need to get the value from both corners to check they were the same).
int getDimension()
Departure from OGC/ISO specification:
ISO does not define this method  the CRS or the dimension can be obtained only through one of the cornerDirectPosition
objects. GeoAPI adds this method for convenience as a more direct way of obtaining the information and to free the user from the need to choose an arbitrary corner (very defensive code might feel the need to get the value from both corners to check they were the same).
@UML(identifier="lowerCorner", obligation=MANDATORY, specification=ISO_19107) DirectPosition getLowerCorner()
Envelope
.@UML(identifier="upperCorner", obligation=MANDATORY, specification=ISO_19107) DirectPosition getUpperCorner()
Envelope
.double getMinimum(int dimension) throws IndexOutOfBoundsException
DirectPosition
object:
getLowerCorner().getOrdinate(dimension)
dimension
 The dimension for which to obtain the ordinate value.IndexOutOfBoundsException
 If the given index is negative or is equals or greater
than the envelope dimension.RectangularShape.getMinX()
,
RectangularShape.getMinY()
Departure from OGC/ISO specification:
This method is not part of ISO specification. GeoAPI adds this method for convenience and efficiency, since some implementations might store the minimum and maximum ordinate values directly in theEnvelope
itself rather than in a containedDirectPosition
corner.
double getMaximum(int dimension) throws IndexOutOfBoundsException
DirectPosition
object:
getUpperCorner().getOrdinate(dimension)
dimension
 The dimension for which to obtain the ordinate value.IndexOutOfBoundsException
 If the given index is negative or is equals or greater
than the envelope dimension.RectangularShape.getMaxX()
,
RectangularShape.getMaxY()
Departure from OGC/ISO specification:
This method is not part of ISO specification. GeoAPI adds this method for convenience and efficiency, since some implementations might store the minimum and maximum ordinate values directly in theEnvelope
itself rather than in a containedDirectPosition
corner.
double getMedian(int dimension) throws IndexOutOfBoundsException
(getMinimum(dimension) + getMaximum(dimension)) / 2
dimension
 The dimension for which to obtain the ordinate value.IndexOutOfBoundsException
 If the given index is negative or is equals or greater
than the envelope dimension.RectangularShape.getCenterX()
,
RectangularShape.getCenterY()
Departure from OGC/ISO specification:
This method is not part of ISO specification. GeoAPI adds this method for convenience and efficiency, since some implementations might store the minimum and maximum ordinate values directly in theEnvelope
itself rather than in a containedDirectPosition
corner.
double getSpan(int dimension) throws IndexOutOfBoundsException
getMaximum(dimension)  getMinimum(dimension)
dimension
 The dimension for which to obtain the ordinate value.IndexOutOfBoundsException
 If the given index is negative or is equals or greater
than the envelope dimension.RectangularShape.getWidth()
,
RectangularShape.getHeight()
Departure from OGC/ISO specification:
This method is not part of ISO specification. GeoAPI adds this method for convenience and efficiency, since some implementations might store the minimum and maximum ordinate values directly in theEnvelope
itself rather than in a containedDirectPosition
corner.
Copyright © 1994–2019 Open Geospatial Consortium. All rights reserved.