org.opengis.metadata.extent.VerticalExtent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoapi Show documentation
Show all versions of geoapi Show documentation
The development community in building GIS solutions is sustaining an enormous level
of effort. The GeoAPI project aims to reduce duplication and increase interoperability
by providing neutral, interface-only APIs derived from OGC/ISO Standards.
/*
* GeoAPI - Java interfaces for OGC/ISO standards
* http://www.geoapi.org
*
* Copyright (C) 2004-2011 Open Geospatial Consortium, Inc.
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
*
* Permission to use, copy, and modify this software and its documentation, with
* or without modification, for any purpose and without fee or royalty is hereby
* granted, provided that you include the following on ALL copies of the software
* and documentation or portions thereof, including modifications, that you make:
*
* 1. The full text of this NOTICE in a location viewable to users of the
* redistributed or derivative work.
* 2. Notice of any changes or modifications to the OGC files, including the
* date changes were made.
*
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
*
* The name and trademarks of copyright holders may NOT be used in advertising or
* publicity pertaining to the software without specific, written prior permission.
* Title to copyright in this software and any associated documentation will at all
* times remain with copyright holders.
*/
package org.opengis.metadata.extent;
import org.opengis.referencing.crs.VerticalCRS;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* Vertical domain of dataset.
*
* @author Martin Desruisseaux (IRD)
* @author Cory Horner (Refractions Research)
* @version 3.0
* @since 1.0
*
* @navassoc 1 - - VerticalCRS
*/
@UML(identifier="EX_VerticalExtent", specification=ISO_19115)
public interface VerticalExtent {
/**
* Returns the lowest vertical extent contained in the dataset.
*
* @return Double mandatory for valid content, may be null for an invalid document.
*/
@UML(identifier="minimumValue", obligation=MANDATORY, specification=ISO_19115)
Double getMinimumValue();
/**
* Returns the highest vertical extent contained in the dataset.
*
* @return Double mandatory for valid content, may be null for an invalid document.
*/
@UML(identifier="maximumValue", obligation=MANDATORY, specification=ISO_19115)
Double getMaximumValue();
/**
* Provides information about the vertical coordinate reference system to
* which the maximum and minimum elevation values are measured. The CRS
* identification includes unit of measure.
*
* @return The vertical CRS.
*
* @departure integration
* ISO 19115 specifies a generic CoordinateReferenceSystem
instead than the more
* restrictive VerticalCRS
. GeoAPI uses the more specific type for type-safety and
* consistency with VerticalExtent
usage. However this restriction prevents usage
* of Height above the ellipsoid when only the constants defined in the
* VerticalDatumType
code list are used. If such height is wanted, implementors
* need to extend the above code list with their own ELLIPSOIDAL
constant.
*
* @issue http://jira.codehaus.org/browse/GEO-134
*
* @since 2.1
*/
@UML(identifier="verticalCRS", obligation=MANDATORY, specification=ISO_19115)
VerticalCRS getVerticalCRS();
}