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.identification;
033
034 import org.opengis.annotation.UML;
035 import org.opengis.annotation.Profile;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039 import static org.opengis.annotation.ComplianceLevel.*;
040
041
042 /**
043 * Level of detail expressed as a scale factor or a ground distance.
044 *
045 * @author Martin Desruisseaux (IRD)
046 * @author Cory Horner (Refractions Research)
047 * @version 3.0
048 * @since 2.0
049 *
050 * @navassoc - - - RepresentativeFraction
051 */
052 @UML(identifier="MD_Resolution", specification=ISO_19115)
053 public interface Resolution {
054 /**
055 * Level of detail expressed as the scale of a comparable hardcopy map or chart.
056 * Only one of {@linkplain #getEquivalentScale equivalent scale} and
057 * {@linkplain #getDistance ground sample distance} may be provided.
058 *
059 * @return Level of detail expressed as the scale of a comparable hardcopy, or {@code null}.
060 *
061 * @condition {@linkplain #getDistance() Distance} not documented.
062 */
063 @Profile(level=CORE)
064 @UML(identifier="equivalentScale", obligation=CONDITIONAL, specification=ISO_19115)
065 RepresentativeFraction getEquivalentScale();
066
067 /**
068 * Ground sample distance.
069 * Only one of {@linkplain #getEquivalentScale equivalent scale} and
070 * {@linkplain #getDistance ground sample distance} may be provided.
071 * <p>
072 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
073 * <TR><TD>
074 * <P align="justify"><B>Warning:</B> The return type of this method may change in GeoAPI
075 * 3.1. It may be replaced by the {@link javax.measure.quantity.Length} type in order to
076 * provide unit of measurement together with the value.</P>
077 * </TD></TR>
078 * </TABLE>
079 *
080 * @return The ground sample distance, or {@code null}.
081 * @unitof Distance
082 *
083 * @condition {@linkplain #getEquivalentScale() Equivalent scale} not documented.
084 */
085 @Profile(level=CORE)
086 @UML(identifier="distance", obligation=CONDITIONAL, specification=ISO_19115)
087 Double getDistance();
088 }