001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.extent;
033
034 import org.opengis.referencing.crs.VerticalCRS;
035 import org.opengis.annotation.UML;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039
040
041 /**
042 * Vertical domain of dataset.
043 *
044 * @author Martin Desruisseaux (IRD)
045 * @author Cory Horner (Refractions Research)
046 * @version 3.0
047 * @since 1.0
048 *
049 * @navassoc 1 - - VerticalCRS
050 */
051 @UML(identifier="EX_VerticalExtent", specification=ISO_19115)
052 public interface VerticalExtent {
053 /**
054 * Returns the lowest vertical extent contained in the dataset.
055 *
056 * @return Double mandatory for valid content, may be null for an invalid document.
057 */
058 @UML(identifier="minimumValue", obligation=MANDATORY, specification=ISO_19115)
059 Double getMinimumValue();
060
061 /**
062 * Returns the highest vertical extent contained in the dataset.
063 *
064 * @return Double mandatory for valid content, may be null for an invalid document.
065 */
066 @UML(identifier="maximumValue", obligation=MANDATORY, specification=ISO_19115)
067 Double getMaximumValue();
068
069 /**
070 * Provides information about the vertical coordinate reference system to
071 * which the maximum and minimum elevation values are measured. The CRS
072 * identification includes unit of measure.
073 *
074 * @return The vertical CRS.
075 *
076 * @departure integration
077 * ISO 19115 specifies a generic <code>CoordinateReferenceSystem</code> instead than the more
078 * restrictive <code>VerticalCRS</code>. GeoAPI uses the more specific type for type-safety and
079 * consistency with <code>VerticalExtent</code> usage. However this restriction prevents usage
080 * of <cite>Height above the ellipsoid</cite> when only the constants defined in the
081 * <code>VerticalDatumType</code> code list are used. If such height is wanted, implementors
082 * need to extend the above code list with their own <code>ELLIPSOIDAL</code> constant.
083 *
084 * @issue http://jira.codehaus.org/browse/GEO-134
085 *
086 * @since 2.1
087 */
088 @UML(identifier="verticalCRS", obligation=MANDATORY, specification=ISO_19115)
089 VerticalCRS getVerticalCRS();
090 }