/*$************************************************************************************************
**
** $Id: Envelope.java 831 2006-05-01 00:27:23Z Desruisseaux $
**
** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/spatialschema/geometry/Envelope.java $
**
** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.spatialschema.geometry;
// OpenGIS direct dependencies
import org.opengis.referencing.crs.CoordinateReferenceSystem;
// Annotations
import org.opengis.annotation.UML;
import org.opengis.annotation.Extension;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* A minimum bounding box or rectangle. Regardless of dimension, an {@code Envelope} can
* be represented without ambiguity as two direct positions (coordinate points). To encode an
* {@code 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.
*
* @version Abstract specification 5
* @author Martin Desruisseaux (IRD)
* @since GeoAPI 1.0
*/
@UML(identifier="GM_Envelope", specification=ISO_19107)
public interface Envelope {
/**
* The length of coordinate sequence (the number of entries) in this envelope.
*
* @return The dimensionality of this envelope.
*
* @since GeoAPI 2.0
*/
@Extension
int getDimension();
/**
* Returns the minimal ordinate along the specified dimension.
*
* @since GeoAPI 2.0
*/
@Extension
double getMinimum(final int dimension);
/**
* Returns the maximal ordinate along the specified dimension.
*
* @since GeoAPI 2.0
*/
@Extension
double getMaximum(final int dimension);
/**
* Returns the center ordinate along the specified dimension.
*
* @since GeoAPI 2.0
*/
@Extension
double getCenter(final int dimension);
/**
* Returns the envelope length along the specified dimension.
* This length is equals to the {@linkplain #getMaximum maximum ordinate}
* minus the {@linkplain #getMinimum minimal ordinate}.
*
* @since GeoAPI 2.0
*/
@Extension
double getLength(final int dimension);
/**
* A coordinate position consisting of all the maximal ordinates for each
* dimension for all points within the {@code Envelope}.
*
* @return The upper corner.
*/
@UML(identifier="upperCorner", obligation=MANDATORY, specification=ISO_19107)
DirectPosition getUpperCorner();
/**
* A coordinate position consisting of all the minimal ordinates for each
* dimension for all points within the {@code Envelope}.
*
* @return The lower corner.
*/
@UML(identifier="lowerCorner", obligation=MANDATORY, specification=ISO_19107)
DirectPosition getLowerCorner();
}
Ads help maintain this website.