| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>org.apache.sis.metadata.iso (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.metadata.iso"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.metadata.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"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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"> |
| <h1 title="Package org.apache.sis.metadata.iso" class="title">Package org.apache.sis.metadata.iso</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.metadata.iso</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Root package for ISO 19115 metadata about resources (data or services). |
| An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/package-summary.html" class="external-link">OpenGIS® javadoc</a>. |
| The remaining discussion on this page is specific to the SIS implementation. |
| |
| <h2>Overview</h2> |
| For a global overview of metadata in SIS, see the <a href="../package-summary.html"><code>org.apache.sis.metadata</code></a> package javadoc. |
| For some explanation about how to use various ISO 19115 elements for scientific dataset, the |
| <a href="https://geo-ide.noaa.gov/wiki/index.php?title=Category:ISO_19115">NOAA wiki page</a> |
| is a good source of information. |
| |
| <table class="sis"> |
| <caption>Package overview</caption> |
| <tr> |
| <th>Class hierarchy</th> |
| <th class="sep">Aggregation hierarchy</th> |
| </tr><tr><td style="width: 50%; white-space: nowrap"> |
| <a href="ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISO 19115 metadata</a><br> |
| <code> ├─</code> <a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso">Metadata</a><br> |
| <code> ├─</code> <a href="DefaultMetadataScope.html" title="class in org.apache.sis.metadata.iso">Metadata scope</a><br> |
| <code> ├─</code> <a href="DefaultPortrayalCatalogueReference.html" title="class in org.apache.sis.metadata.iso">Portrayal catalogue reference</a><br> |
| <code> ├─</code> <a href="DefaultApplicationSchemaInformation.html" title="class in org.apache.sis.metadata.iso">Application schema information</a><br> |
| <code> ├─</code> <a href="DefaultMetadataExtensionInformation.html" title="class in org.apache.sis.metadata.iso">Metadata extension information</a><br> |
| <code> ├─</code> <a href="DefaultExtendedElementInformation.html" title="class in org.apache.sis.metadata.iso">Extended element information</a><br> |
| <code> └─</code> <a href="DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso">Identifier</a><br> |
| <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 list</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Datatype.html" title="class or interface in org.opengis.metadata" class="external-link">Data type</a><br> |
| <code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Obligation.html" title="class or interface in org.opengis.metadata" class="external-link">Obligation</a><br> |
| </td><td class="sep" style="width: 50%; white-space: nowrap"> |
| <a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso">Metadata</a><br> |
| <code> ├─</code> <a href="DefaultMetadataScope.html" title="class in org.apache.sis.metadata.iso">Metadata scope</a><br> |
| <code> ├─</code> <a href="DefaultPortrayalCatalogueReference.html" title="class in org.apache.sis.metadata.iso">Portrayal catalogue reference</a><br> |
| <code> ├─</code> <a href="DefaultApplicationSchemaInformation.html" title="class in org.apache.sis.metadata.iso">Application schema information</a><br> |
| <code> ├─</code> <a href="DefaultMetadataExtensionInformation.html" title="class in org.apache.sis.metadata.iso">Metadata extension information</a><br> |
| <code> │ └─</code> <a href="DefaultExtendedElementInformation.html" title="class in org.apache.sis.metadata.iso">Extended element information</a><br> |
| <code> │ ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Datatype.html" title="class or interface in org.opengis.metadata" class="external-link">Data type</a> «code list»<br> |
| <code> │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Obligation.html" title="class or interface in org.opengis.metadata" class="external-link">Obligation</a> «code list»<br> |
| <code> └─</code> <a href="DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso">Identifier</a><br> |
| </td></tr></table> |
| |
| <h2>Localization</h2> |
| When a metadata object is marshalled as an ISO 19115-3 compliant XML document, the marshaller |
| <a href="../../xml/XML.html#LOCALE"><code>XML.LOCALE</code></a> property will be used for the localization of every |
| <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"><code>InternationalString</code></a> 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> instances, |
| <strong>except</strong> if the object to be marshalled is an instance of |
| <a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso"><code>DefaultMetadata</code></a>, in which case the value given to the |
| <a href="DefaultMetadata.html#setLanguage(java.util.Locale)"><code>setLanguage(Locale)</code></a> method |
| will have precedence. The latter behavior is compliant with INSPIRE rules. |
| |
| <h2>Null values, nil objects and collections</h2> |
| All constructors and setter methods accept <code>null</code> arguments. |
| A null argument value means that the metadata element cannot be provided, and the reason for that is unspecified. |
| Alternatively, users can specify why a metadata element is missing by providing a value created by |
| <a href="../../xml/NilReason.html#createNilObject(java.lang.Class)"><code>NilReason.createNilObject(Class)</code></a>. |
| |
| <p>Unless otherwise noted in the Javadoc, all getter methods may return an empty collection, |
| an empty array or <code>null</code> if the type is neither a collection or an array. |
| Note that non-null values may be <a href="../../xml/NilObject.html" title="interface in org.apache.sis.xml"><code>NilObject</code></a>s.</p> |
| |
| <p>Unless the metadata object has been marked as unmodifiable and unless otherwise noted in the Javadoc, |
| all collections returned by getter methods are <em>live</em>: adding new elements in the collection |
| modify directly the underlying metadata object.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </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 two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.metadata</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Root package for various metadata implementations.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="acquisition/package-summary.html">org.apache.sis.metadata.iso.acquisition</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information about the measuring instruments, the platform carrying them, and the mission to which the data contributes.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="citation/package-summary.html">org.apache.sis.metadata.iso.citation</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Reference to the data or service (citation, responsible party, contact information).</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="constraint/package-summary.html">org.apache.sis.metadata.iso.constraint</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information about legal and security constraints placed on data.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="content/package-summary.html">org.apache.sis.metadata.iso.content</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Description of the dataset content.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="distribution/package-summary.html">org.apache.sis.metadata.iso.distribution</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information about the options for obtaining a resource (data or service).</div> |
| </div> |
| <div class="col-first even-row-color"><a href="extent/package-summary.html">org.apache.sis.metadata.iso.extent</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Information about spatial, vertical, and temporal extent.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="identification/package-summary.html">org.apache.sis.metadata.iso.identification</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information to uniquely identify the data or service.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="lineage/package-summary.html">org.apache.sis.metadata.iso.lineage</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Information about the sources and production processes of a dataset.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="maintenance/package-summary.html">org.apache.sis.metadata.iso.maintenance</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information about the frequency and scope of data updates.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="quality/package-summary.html">org.apache.sis.metadata.iso.quality</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Information about data quality, accuracy and consistency of a dataset.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="spatial/package-summary.html">org.apache.sis.metadata.iso.spatial</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Information about the mechanisms (grid or vector) used to represent spatial data.</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="DefaultApplicationSchemaInformation.html" title="class in org.apache.sis.metadata.iso">DefaultApplicationSchemaInformation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the application schema used to build the dataset.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultExtendedElementInformation.html" title="class in org.apache.sis.metadata.iso">DefaultExtendedElementInformation</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">New metadata element, not found in ISO 19115, which is required to describe geographic data.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso">DefaultIdentifier</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Value uniquely identifying an object within a namespace.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso">DefaultMetadata</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Root entity which defines metadata about a resource or resources.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultMetadataExtensionInformation.html" title="class in org.apache.sis.metadata.iso">DefaultMetadataExtensionInformation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information describing metadata extensions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultMetadataScope.html" title="class in org.apache.sis.metadata.iso">DefaultMetadataScope</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the scope of the resource.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultPortrayalCatalogueReference.html" title="class in org.apache.sis.metadata.iso">DefaultPortrayalCatalogueReference</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information identifying the portrayal catalogue used.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The base class of ISO 19115 implementation classes.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
