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.quality;
033
034 import java.util.Collection;
035
036 import org.opengis.metadata.extent.Extent;
037 import org.opengis.metadata.maintenance.ScopeCode;
038 import org.opengis.metadata.maintenance.ScopeDescription;
039 import org.opengis.annotation.UML;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043
044
045 /**
046 * Description of the data specified by the scope.
047 *
048 * @author Martin Desruisseaux (IRD)
049 * @version 3.0
050 * @since 2.0
051 *
052 * @navassoc 1 - - ScopeCode
053 * @navassoc - - - ScopeDescription
054 * @navassoc 1 - - Extent
055 */
056 @UML(identifier="DQ_Scope", specification=ISO_19115)
057 public interface Scope {
058 /**
059 * Hierarchical level of the data specified by the scope.
060 *
061 * @return Hierarchical level of the data.
062 */
063 @UML(identifier="level", obligation=MANDATORY, specification=ISO_19115)
064 ScopeCode getLevel();
065
066 /**
067 * Detailed description about the level of the data specified by the scope.
068 * Shall be defined only if the {@linkplain #getLevel level} is not equal
069 * to {@link ScopeCode#DATASET DATASET} or {@link ScopeCode#SERIES SERIES}.
070 *
071 * @return Detailed description about the level of the data.
072 *
073 * @since 2.1
074 */
075 @UML(identifier="levelDescription", obligation=CONDITIONAL, specification=ISO_19115)
076 Collection<? extends ScopeDescription> getLevelDescription();
077
078 /**
079 * Information about the spatial, vertical and temporal extent of the data specified by the
080 * scope.
081 *
082 * @return Information about the extent of the data, or {@code null}.
083 */
084 @UML(identifier="extent", obligation=OPTIONAL, specification=ISO_19115)
085 Extent getExtent();
086 }