| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.util.iso (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.util.iso"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.iso package"> |
| <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="package-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.metadata</a></div> |
| <h1 title="Package org.apache.sis.util.iso" class="title">Package org.apache.sis.util.iso</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.util.iso</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Implementations of GeoAPI types from the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/package-summary.html" class="external-link"><code>org.opengis.util</code></a> package. |
| The main content of this package are: |
| |
| <ul> |
| <li>Implementations of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> (derived from ISO 19103): |
| <ul> |
| <li><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso"><code>DefaultLocalName</code></a> for identifier within a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">name space</a>.</li> |
| <li><a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso"><code>DefaultMemberName</code></a> for identifying a member of a <a href="DefaultRecord.html" title="class in org.apache.sis.util.iso">record</a>.</li> |
| <li><a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> for identifying an attribute type associated to a member.</li> |
| <li><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso"><code>DefaultScopedName</code></a> for a composite of a <cite>head</cite> name and a <cite>tail</cite> name.</li> |
| </ul> |
| </li> |
| <li>Implementations of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link"><code>Record</code></a> and related classes (derived from ISO 19103): |
| <ul> |
| <li><a href="DefaultRecord.html" title="class in org.apache.sis.util.iso"><code>DefaultRecord</code></a> for a list of logically related elements as (<var>name</var>, <var>value</var>) pairs.</li> |
| <li><a href="DefaultRecordType.html" title="class in org.apache.sis.util.iso"><code>DefaultRecordType</code></a> for definition of the type of a <code>Record</code>.</li> |
| <li><a href="DefaultRecordSchema.html" title="class in org.apache.sis.util.iso"><code>DefaultRecordSchema</code></a> for a collection of <code>RecordType</code>s in a given namespace.</li> |
| </ul> |
| </li> |
| <li>Static utility methods: |
| <ul> |
| <li><a href="Types.html" title="class in org.apache.sis.util.iso"><code>Types</code></a> for working with UML identifiers and description of GeoAPI types.</li> |
| <li><a href="Names.html" title="class in org.apache.sis.util.iso"><code>Names</code></a> for simple creation and operations on <code>GenericName</code>.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h2 id="anatomy-of-a-name-heading">Anatomy of a name</h2> |
| Names may be <a href="AbstractName.html#toFullyQualifiedName()">fully qualified</a> |
| (like <code>"urn:ogc:def:crs:EPSG::4326"</code>), |
| or they may be relative to a <a href="AbstractName.html#scope()">scope</a> |
| (like <code>"EPSG::4326"</code> in the <code>"urn:ogc:def:crs"</code> scope). |
| In the following illustration, each line is one possible construction for <code>"urn:ogc:crs:epsg:4326"</code> |
| (taken as an abridged form of above URN for this example only). |
| For each construction: |
| <ul> |
| <li>The first columns shows the <span style="background:LawnGreen">name</span> in a green background.</li> |
| <li>The second and third columns show the |
| (<span style="background:LightSkyBlue"><var>head</var></span>.<span style="background:Yellow"><var>tail</var></span>) and |
| (<span style="background:LightSkyBlue"><var>path</var></span>.<span style="background:Yellow"><var>tip</var></span>) |
| components, respectively.</li> |
| <li>The parts without colored background do not appear in the |
| <a href="AbstractName.html#toString()">string representation</a> or in the |
| <a href="AbstractName.html#getParsedNames()">list of parsed names</a>.</li> |
| </ul> |
| |
| <table class="compact" style="border-spacing:21pt 0; white-space: nowrap"> |
| <caption>Components in scope, head, tail, path and tip</caption> |
| <tr> |
| <th><a href="AbstractName.html#scope()">scope</a>.name</th> |
| <th><a href="AbstractName.html#head()">head</a>.<a href="DefaultScopedName.html#tail()">tail</a></th> |
| <th><a href="DefaultScopedName.html#path()">path</a>.<a href="AbstractName.html#tip()">tip</a></th> |
| <th>Type</th> |
| </tr><tr> |
| <td><code><span style="background:LawnGreen">urn:ogc:crs:epsg:4326</span></code></td> |
| <td><code><span style="background:LightSkyBlue">urn:</span><span style="background:Yellow">ogc:crs:epsg:4326</span></code></td> |
| <td><code><span style="background:LightSkyBlue">urn:ogc:crs:epsg:</span><span style="background:Yellow">4326</span></code></td> |
| <td><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">Scoped name</a> with |
| <a href="DefaultNameSpace.html#isGlobal()">global namespace</a></td> |
| </tr><tr> |
| <td><code>urn:<span style="background:LawnGreen">ogc:crs:epsg:4326</span></code></td> |
| <td><code>urn:<span style="background:LightSkyBlue">ogc:</span><span style="background:Yellow">crs:epsg:4326</span></code></td> |
| <td><code>urn:<span style="background:LightSkyBlue">ogc:crs:epsg:</span><span style="background:Yellow">4326</span></code></td> |
| <td><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">Scoped name</a></td> |
| </tr><tr> |
| <td><code>urn:ogc:<span style="background:LawnGreen">crs:epsg:4326</span></code></td> |
| <td><code>urn:ogc:<span style="background:LightSkyBlue">crs:</span><span style="background:Yellow">epsg:4326</span></code></td> |
| <td><code>urn:ogc:<span style="background:LightSkyBlue">crs:epsg:</span><span style="background:Yellow">4326</span></code></td> |
| <td><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">Scoped name</a></td> |
| </tr><tr> |
| <td><code>urn:ogc:crs:<span style="background:LawnGreen">epsg:4326</span></code></td> |
| <td><code>urn:ogc:crs:<span style="background:LightSkyBlue">epsg:</span><span style="background:Yellow">4326</span></code></td> |
| <td><code>urn:ogc:crs:<span style="background:LightSkyBlue">epsg:</span><span style="background:Yellow">4326</span></code></td> |
| <td><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">Scoped name</a></td> |
| </tr><tr> |
| <td><code>urn:ogc:crs:epsg:<span style="background:LawnGreen">4326</span></code></td> |
| <td><code>urn:ogc:crs:epsg:<span style="background:LightSkyBlue">4326</span></code></td> |
| <td><code>urn:ogc:crs:epsg:<span style="background:Yellow">4326</span></code></td> |
| <td><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">Local name</a></td> |
| </tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Module</div> |
| <div class="table-header col-second">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-plain even-row-color"><a href="../../../../../../org.apache.sis.util/module-summary.html">org.apache.sis.util</a></div> |
| <div class="col-first even-row-color"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/package-summary.html">org.apache.sis.util</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Simple data objects and miscellaneous utilities.</div> |
| </div> |
| <div class="col-plain odd-row-color"><a href="../../../../../../org.apache.sis.util/module-summary.html">org.apache.sis.util</a></div> |
| <div class="col-first odd-row-color"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/collection/package-summary.html">org.apache.sis.util.collection</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Addition to the collection framework.</div> |
| </div> |
| <div class="col-plain even-row-color"><a href="../../../../../../org.apache.sis.util/module-summary.html">org.apache.sis.util</a></div> |
| <div class="col-first even-row-color"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/logging/package-summary.html">org.apache.sis.util.logging</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Extensions to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html" class="external-link">JDK logging</a> framework.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="caption"><span>Classes</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractFactory.html" title="class in org.apache.sis.util.iso">AbstractFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class of factories provided in the Apache SIS library.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for sequence of identifiers rooted within the context of a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">namespace</a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Identifier within a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">name space</a> for a local object.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso">DefaultMemberName</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The name to identify a member of a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link">record</a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso">DefaultNameFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A factory for creating <a href="AbstractName.html" title="class in org.apache.sis.util.iso"><code>AbstractName</code></a> objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">DefaultNameSpace</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A domain in which <a href="AbstractName.html" title="class in org.apache.sis.util.iso">names</a> given by character strings are defined.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultRecord.html" title="class in org.apache.sis.util.iso">DefaultRecord</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A list of logically related elements as (<var>name</var>, <var>value</var>) pairs in a dictionary.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultRecordSchema.html" title="class in org.apache.sis.util.iso">DefaultRecordSchema</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A collection of record types in a given namespace.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultRecordType.html" title="class in org.apache.sis.util.iso">DefaultRecordType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An immutable definition of the type of a <a href="DefaultRecord.html" title="class in org.apache.sis.util.iso">record</a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">DefaultScopedName</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A composite of a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">name space</a> (as a <a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">local name</a>) |
| and a <a href="AbstractName.html" title="class in org.apache.sis.util.iso">generic name</a> valid in that name space.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso">DefaultTypeName</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The name of an attribute type associated to a <a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso">member name</a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Names.html" title="class in org.apache.sis.util.iso">Names</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Static methods for creating, parsing and formatting <a href="AbstractName.html" title="class in org.apache.sis.util.iso">generic names</a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Types.html" title="class in org.apache.sis.util.iso">Types</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Static methods working on GeoAPI types and <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link"><code>CodeList</code></a> values.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |