| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>org.apache.sis.metadata.iso (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <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="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.metadata.iso (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.metadata.iso</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <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/metadata/package-summary.html?is-external=true" class="externalLink">OpenGIS® javadoc</a>. |
| The remaining discussion on this page is specific to the SIS implementation. |
| |
| <div class="section">Overview</div> |
| 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/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">Code list</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Datatype.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Data type</a><br> |
| <code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Obligation.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">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/metadata/Datatype.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Data type</a> «code list»<br> |
| <code> │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Obligation.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">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> |
| |
| <div class="section">Localization</div> |
| When a metadata object is marshalled as an ISO 19115-3 compliant XML document, the marshaller |
| <a href="../../xml/XML.html#LOCALE"><code>LOCALE</code></a> property will be used for the localization of every |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><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 later behavior is compliant with INSPIRE rules. |
| |
| <div class="section">Null values, nil objects and collections</div> |
| All constructors and setter methods accept <code>null</code> arguments. |
| A null argument value means that the metadata element can not 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 <cite>live</cite>: adding new elements in the collection |
| modify directly the underlying metadata object.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultApplicationSchemaInformation.html" title="class in org.apache.sis.metadata.iso">DefaultApplicationSchemaInformation</a></th> |
| <td class="colLast"> |
| <div class="block">Information about the application schema used to build the dataset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultExtendedElementInformation.html" title="class in org.apache.sis.metadata.iso">DefaultExtendedElementInformation</a></th> |
| <td class="colLast"> |
| <div class="block">New metadata element, not found in ISO 19115, which is required to describe geographic data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso">DefaultIdentifier</a></th> |
| <td class="colLast"> |
| <div class="block">Value uniquely identifying an object within a namespace.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso">DefaultMetadata</a></th> |
| <td class="colLast"> |
| <div class="block">Root entity which defines metadata about a resource or resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultMetadataExtensionInformation.html" title="class in org.apache.sis.metadata.iso">DefaultMetadataExtensionInformation</a></th> |
| <td class="colLast"> |
| <div class="block">Information describing metadata extensions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultMetadataScope.html" title="class in org.apache.sis.metadata.iso">DefaultMetadataScope</a></th> |
| <td class="colLast"> |
| <div class="block">Information about the scope of the resource.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultPortrayalCatalogueReference.html" title="class in org.apache.sis.metadata.iso">DefaultPortrayalCatalogueReference</a></th> |
| <td class="colLast"> |
| <div class="block">Information identifying the portrayal catalogue used.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ImmutableIdentifier.html" title="class in org.apache.sis.metadata.iso">ImmutableIdentifier</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">Moved to <a href="../../referencing/package-summary.html"><code>org.apache.sis.referencing</code></a> for anticipation with Jigsaw modules.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></th> |
| <td class="colLast"> |
| <div class="block">The base class of ISO 19115 implementation classes.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |