blob: 539acddb61daa0b6b0e170f46e28c9b87bbbef34 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>DefaultResolution (Apache SIS 1.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-05">
<meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.metadata.iso.identification, class: DefaultResolution">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.metadata.iso.identification.DefaultResolution class">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="getEquivalentScale()">
<meta name="keywords" content="setEquivalentScale()">
<meta name="keywords" content="getDistance()">
<meta name="keywords" content="setDistance()">
<meta name="keywords" content="getVertical()">
<meta name="keywords" content="setVertical()">
<meta name="keywords" content="getAngularDistance()">
<meta name="keywords" content="setAngularDistance()">
<meta name="keywords" content="getLevelOfDetail()">
<meta name="keywords" content="setLevelOfDetail()">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">org.apache.sis.metadata</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.metadata.iso.identification</a></div>
<h1 title="Class DefaultResolution" class="title">Class DefaultResolution</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a>
<div class="inheritance"><a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a>
<div class="inheritance"><a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a>
<div class="inheritance">DefaultResolution</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code>, <code><a href="../../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">Identified­Object</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultResolution</span>
<span class="extends-implements">extends <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a>
implements <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a></span></div>
<div class="block">Level of detail expressed as a scale factor or a ground distance.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
<div class="preformat"><code>MD_Resolution</code>
<code>  ├─angular­Distance……</code> Angular sampling measure.
<code>  ├─distance………………………</code> Ground sample distance.
<code>  ├─equivalent­Scale……</code> Level of detail expressed as the scale of a comparable hardcopy map or chart.
<code>  │   └─denominator……</code> The number below the line in a vulgar fraction.
<code>  ├─level­Of­Detail…………</code> Brief textual description of the spatial resolution of the resource.
<code>  └─vertical………………………</code> Vertical sampling distance.</div>
ISO 19115 defines <code>Resolution</code> as an <cite>union</cite> (in the C/C++ sense):
only one of the properties in this class can be set to a non-empty value.
Setting any property to a non-empty value discard all the other ones.
See the <a href="#%3Cinit%3E(org.opengis.metadata.identification.Resolution)">constructor javadoc</a>
for information about which property has precedence on copy operations.
<h2 id="limitations-heading">Limitations</h2>
<ul>
<li>Instances of this class are not synchronized for multi-threading.
Synchronization, if needed, is caller's responsibility.</li>
<li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use <a href="../../../xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> instead.</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="AbstractIdentification.html#getSpatialResolutions()"><code>Abstract­Identification​.get­Spatial­Resolutions()</code></a></li>
<li><a href="../../../../../../../serialized-form.html#org.apache.sis.metadata.iso.identification.DefaultResolution">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.sis.metadata.ModifiableMetadata">Nested classes/interfaces inherited from class&nbsp;<a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h2>
<code><a href="../../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">Modifiable­Metadata​.State</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-ISOMetadata">Fields inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#identifiers">identifiers</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Default­Resolution</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs an initially empty resolution.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.opengis.metadata.identification.RepresentativeFraction)" class="member-name-link">Default­Resolution</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Representative­Fraction</a>&nbsp;scale)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new resolution initialized to the given scale.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.opengis.metadata.identification.Resolution)" class="member-name-link">Default­Resolution</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a>&nbsp;object)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">Default­Resolution</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#castOrCopy(org.opengis.metadata.identification.Resolution)" class="member-name-link">cast­Or­Copy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a>&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAngularDistance()" class="member-name-link">get­Angular­Distance</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the angular sampling measure.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDistance()" class="member-name-link">get­Distance</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the ground sample distance.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Representative­Fraction</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEquivalentScale()" class="member-name-link">get­Equivalent­Scale</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the level of detail expressed as the scale of a comparable hardcopy map or chart.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">International­String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLevelOfDetail()" class="member-name-link">get­Level­Of­Detail</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a brief textual description of the spatial resolution of the resource.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVertical()" class="member-name-link">get­Vertical</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the vertical sampling distance.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngularDistance(java.lang.Double)" class="member-name-link">set­Angular­Distance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the angular sampling measure.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDistance(java.lang.Double)" class="member-name-link">set­Distance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;new­Value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the ground sample distance.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEquivalentScale(org.opengis.metadata.identification.RepresentativeFraction)" class="member-name-link">set­Equivalent­Scale</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Representative­Fraction</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the level of detail expressed as the scale of a comparable hardcopy map or chart.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLevelOfDetail(org.opengis.util.InternationalString)" class="member-name-link">set­Level­Of­Detail</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">International­String</a>&nbsp;new­Value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the textual description of the spatial resolution of the resource.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVertical(java.lang.Double)" class="member-name-link">set­Vertical</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the vertical sampling distance.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-ISOMetadata">Methods inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#getIdentifier()">get­Identifier</a>, <a href="../ISOMetadata.html#getIdentifierMap()">get­Identifier­Map</a>, <a href="../ISOMetadata.html#getIdentifiers()">get­Identifiers</a>, <a href="../ISOMetadata.html#getStandard()">get­Standard</a>, <a href="../ISOMetadata.html#setIdentifier(org.opengis.metadata.Identifier)">set­Identifier</a>, <a href="../ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transition­To</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-ModifiableMetadata">Methods inherited from class&nbsp;<a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3>
<code><a href="../../ModifiableMetadata.html#checkWritePermission(java.lang.Object)">check­Write­Permission</a>, <a href="../../ModifiableMetadata.html#collectionType(java.lang.Class)">collection­Type</a>, <a href="../../ModifiableMetadata.html#copyCollection(java.util.Collection,java.lang.Class)">copy­Collection</a>, <a href="../../ModifiableMetadata.html#copyList(java.util.Collection,java.lang.Class)">copy­List</a>, <a href="../../ModifiableMetadata.html#copyMap(java.util.Map,java.lang.Class)">copy­Map</a>, <a href="../../ModifiableMetadata.html#copySet(java.util.Collection,java.lang.Class)">copy­Set</a>, <a href="../../ModifiableMetadata.html#deepCopy(org.apache.sis.metadata.ModifiableMetadata.State)">deep­Copy</a>, <a href="../../ModifiableMetadata.html#nonNullCollection(java.util.Collection,java.lang.Class)">non­Null­Collection</a>, <a href="../../ModifiableMetadata.html#nonNullList(java.util.List,java.lang.Class)">non­Null­List</a>, <a href="../../ModifiableMetadata.html#nonNullMap(java.util.Map,java.lang.Class)">non­Null­Map</a>, <a href="../../ModifiableMetadata.html#nonNullSet(java.util.Set,java.lang.Class)">non­Null­Set</a>, <a href="../../ModifiableMetadata.html#singleton(E,java.lang.Class)">singleton</a>, <a href="../../ModifiableMetadata.html#state()">state</a>, <a href="../../ModifiableMetadata.html#writeCollection(java.util.Collection,java.util.Collection,java.lang.Class)">write­Collection</a>, <a href="../../ModifiableMetadata.html#writeList(java.util.Collection,java.util.List,java.lang.Class)">write­List</a>, <a href="../../ModifiableMetadata.html#writeMap(java.util.Map,java.util.Map,java.lang.Class)">write­Map</a>, <a href="../../ModifiableMetadata.html#writeSet(java.util.Collection,java.util.Set,java.lang.Class)">write­Set</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-AbstractMetadata">Methods inherited from class&nbsp;<a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></h3>
<code><a href="../../AbstractMetadata.html#asMap()">as­Map</a>, <a href="../../AbstractMetadata.html#asTreeTable()">as­Tree­Table</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object)">equals</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="../../AbstractMetadata.html#getInterface()">get­Interface</a>, <a href="../../AbstractMetadata.html#hashCode()">hash­Code</a>, <a href="../../AbstractMetadata.html#isEmpty()">is­Empty</a>, <a href="../../AbstractMetadata.html#prune()">prune</a>, <a href="../../AbstractMetadata.html#toString()">to­String</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>DefaultResolution</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultResolution</span>()</div>
<div class="block">Constructs an initially empty resolution.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.opengis.metadata.identification.RepresentativeFraction)">
<h3>DefaultResolution</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultResolution</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">RepresentativeFraction</a>&nbsp;scale)</span></div>
<div class="block">Creates a new resolution initialized to the given scale.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scale</code> - the scale, or <code>null</code> if none.</dd>
<dt>Since:</dt>
<dd>0.4</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.opengis.metadata.identification.Resolution)">
<h3>DefaultResolution</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultResolution</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a>&nbsp;object)</span></div>
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.
This is a <em>shallow</em> copy constructor, because the other metadata contained in the
given object are not recursively copied.
<p>If more than one of the <a href="#getEquivalentScale()">equivalent scale</a>,
<a href="#getDistance()">distance</a>, <a href="#getVertical()">vertical</a>,
<a href="#getAngularDistance()">angular distance</a> and <a href="#getLevelOfDetail()">level of detail</a>
are specified, then the first of those values is taken and the other values are silently discarded.</p>
<h4 id="note-on-properties-validation-heading">Note on properties validation</h4>
This constructor does not verify the property values of the given metadata (e.g. whether it contains
unexpected negative values). This is because invalid metadata exist in practice, and verifying their
validity in this copy constructor is often too late. Note that this is not the only hole, as invalid
metadata instances can also be obtained by unmarshalling an invalid XML document.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#castOrCopy(org.opengis.metadata.identification.Resolution)"><code>cast­Or­Copy(Resolution)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="castOrCopy(org.opengis.metadata.identification.Resolution)">
<h3>castOrCopy</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">DefaultResolution</a></span>&nbsp;<span class="element-name">castOrCopy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a>&nbsp;object)</span></div>
<div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.
This method performs the first applicable action in the following choices:
<ul>
<li>If the given object is <code>null</code>, then this method returns <code>null</code>.</li>
<li>Otherwise if the given object is already an instance of
<code>Default­Resolution</code>, then it is returned unchanged.</li>
<li>Otherwise a new <code>Default­Resolution</code> instance is created using the
<a href="#%3Cinit%3E(org.opengis.metadata.identification.Resolution)">copy constructor</a> and returned.
Note that this is a <em>shallow</em> copy operation, because the other
metadata contained in the given object are not recursively copied.</li>
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd>
<dt>Returns:</dt>
<dd>a SIS implementation containing the values of the given object (may be the
given object itself), or <code>null</code> if the argument was null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getEquivalentScale()">
<h3>getEquivalentScale</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">RepresentativeFraction</a></span>&nbsp;<span class="element-name">getEquivalentScale</span>()</div>
<div class="block">Returns the level of detail expressed as the scale of a comparable hardcopy map or chart.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html#getEquivalentScale()" title="class or interface in org.opengis.metadata.identification" class="external-link">get­Equivalent­Scale</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a></code></dd>
<dt>Returns:</dt>
<dd>level of detail expressed as the scale of a comparable hardcopy, or <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setEquivalentScale(org.opengis.metadata.identification.RepresentativeFraction)">
<h3>setEquivalentScale</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setEquivalentScale</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/RepresentativeFraction.html" title="class or interface in org.opengis.metadata.identification" class="external-link">RepresentativeFraction</a>&nbsp;newValue)</span></div>
<div class="block">Sets the level of detail expressed as the scale of a comparable hardcopy map or chart.
<h4 id="effect-on-other-properties-heading">Effect on other properties</h4>
If and only if the <code>new­Value</code> is non-null, then this method automatically
discards all other properties.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new equivalent scale.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDistance()">
<h3>getDistance</h3>
<div class="member-signature"><span class="annotations"><a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=0.0,
<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#isMinIncluded()">isMinIncluded</a>=false)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span>&nbsp;<span class="element-name">getDistance</span>()</div>
<div class="block">Returns the ground sample distance.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html#getDistance()" title="class or interface in org.opengis.metadata.identification" class="external-link">get­Distance</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Resolution.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Resolution</a></code></dd>
<dt>Returns:</dt>
<dd>the ground sample distance, or <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDistance(java.lang.Double)">
<h3>setDistance</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDistance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;newValue)</span></div>
<div class="block">Sets the ground sample distance.
<h4 id="effect-on-other-properties-heading1">Effect on other properties</h4>
If and only if the <code>new­Value</code> is non-null, then this method automatically
discards all other properties.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new distance, or <code>null</code>.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">Illegal­Argument­Exception</a></code> - if the given value is NaN, zero or negative.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVertical()">
<h3>getVertical</h3>
<div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="vertical",
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#CONDITIONAL" title="class or interface in org.opengis.annotation" class="external-link">CONDITIONAL</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>)
<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=0.0,
<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#isMinIncluded()">isMinIncluded</a>=false)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span>&nbsp;<span class="element-name">getVertical</span>()</div>
<div class="block">Returns the vertical sampling distance.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the vertical sampling distance, or <code>null</code>.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVertical(java.lang.Double)">
<h3>setVertical</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVertical</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;newValue)</span></div>
<div class="block">Sets the vertical sampling distance.
<h4 id="effect-on-other-properties-heading2">Effect on other properties</h4>
If and only if the <code>new­Value</code> is non-null, then this method automatically
discards all other properties.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new distance, or <code>null</code>.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">Illegal­Argument­Exception</a></code> - if the given value is NaN, zero or negative.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAngularDistance()">
<h3>getAngularDistance</h3>
<div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="angularDistance",
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#CONDITIONAL" title="class or interface in org.opengis.annotation" class="external-link">CONDITIONAL</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>)
<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=0.0,
<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#isMinIncluded()">isMinIncluded</a>=false)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span>&nbsp;<span class="element-name">getAngularDistance</span>()</div>
<div class="block">Returns the angular sampling measure.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the angular sampling measure, or <code>null</code>.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAngularDistance(java.lang.Double)">
<h3>setAngularDistance</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAngularDistance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;newValue)</span></div>
<div class="block">Sets the angular sampling measure.
<h4 id="effect-on-other-properties-heading3">Effect on other properties</h4>
If and only if the <code>new­Value</code> is non-null, then this method automatically
discards all other properties.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new distance, or <code>null</code>.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">Illegal­Argument­Exception</a></code> - if the given value is NaN, zero or negative.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLevelOfDetail()">
<h3>getLevelOfDetail</h3>
<div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="levelOfDetail",
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#CONDITIONAL" title="class or interface in org.opengis.annotation" class="external-link">CONDITIONAL</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></span>&nbsp;<span class="element-name">getLevelOfDetail</span>()</div>
<div class="block">Returns a brief textual description of the spatial resolution of the resource.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>textual description of the spatial resolution, or <code>null</code>.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLevelOfDetail(org.opengis.util.InternationalString)">
<h3>setLevelOfDetail</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setLevelOfDetail</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a>&nbsp;newValue)</span></div>
<div class="block">Sets the textual description of the spatial resolution of the resource.
<h4 id="effect-on-other-properties-heading4">Effect on other properties</h4>
If and only if the <code>new­Value</code> is non-null, then this method automatically
discards all other properties.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new distance.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>