| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.metadata.iso.identification (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"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.metadata.iso.identification 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.metadata.iso.identification" class="title">Package org.apache.sis.metadata.iso.identification</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.metadata.iso.identification</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Information to uniquely identify the data or service. |
| An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/package-summary.html" class="external-link">OpenGIS® javadoc</a>. |
| The remaining discussion on this page is specific to the SIS implementation. |
| |
| <h2 id="overview-heading">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. |
| |
| <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="AbstractIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Identification</a> «abstract»<br> |
| <code> │ ├─</code> <a href="DefaultDataIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Data identification</a><br> |
| <code> │ └─</code> <a href="DefaultServiceIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Service identification</a><br> |
| <code> ├─</code> <a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">Resolution</a><br> |
| <code> ├─</code> <a href="DefaultBrowseGraphic.html" title="class in org.apache.sis.metadata.iso.identification">Browse graphic</a><br> |
| <code> ├─</code> <a href="DefaultKeywords.html" title="class in org.apache.sis.metadata.iso.identification">Keywords</a><br> |
| <code> ├─</code> <a href="DefaultUsage.html" title="class in org.apache.sis.metadata.iso.identification">Usage</a><br> |
| <code> ├─</code> <a href="DefaultAggregateInformation.html" title="class in org.apache.sis.metadata.iso.identification">Aggregate information</a><br> |
| <code> ├─</code> <a href="DefaultCoupledResource.html" title="class in org.apache.sis.metadata.iso.identification">Coupled resource</a><br> |
| <code> ├─</code> <a href="DefaultOperationMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Operation metadata</a><br> |
| <code> └─</code> <a href="DefaultOperationChainMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Operation chain metadata</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/identification/Progress.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Progress</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/KeywordType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Keyword type</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/AssociationType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Association type</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/InitiativeType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Initiative type</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/TopicCategory.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Topic category</a><br> |
| <code> ├─</code> Coupling type}<br> |
| <code> └─</code> Distributed computing platform}<br> |
| </td><td class="sep" style="width: 50%; white-space: nowrap"> |
| <a href="AbstractIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Identification</a> «abstract»<br> |
| <code> ├─</code> <a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">Resolution</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/TopicCategory.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Topic category</a> «code list»<br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/Progress.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Progress</a> «code list»<br> |
| <code> ├─</code> <a href="DefaultBrowseGraphic.html" title="class in org.apache.sis.metadata.iso.identification">Browse graphic</a><br> |
| <code> ├─</code> <a href="DefaultKeywords.html" title="class in org.apache.sis.metadata.iso.identification">Keywords</a><br> |
| <code> │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/KeywordType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Keyword type</a> «code list»<br> |
| <code> ├─</code> <a href="DefaultUsage.html" title="class in org.apache.sis.metadata.iso.identification">Usage</a><br> |
| <code> └─</code> <a href="DefaultAssociatedResource.html" title="class in org.apache.sis.metadata.iso.identification">Associated resource</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/AssociationType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Association type</a> «code list»<br> |
| <code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/identification/InitiativeType.html" title="class or interface in org.opengis.metadata.identification" class="external-link">Initiative type</a> «code list»<br> |
| <a href="DefaultDataIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Data identification</a><br> |
| <a href="DefaultServiceIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Service identification</a><br> |
| <code> ├─</code> Coupling type} «code list»<br> |
| <code> ├─</code> <a href="DefaultCoupledResource.html" title="class in org.apache.sis.metadata.iso.identification">Coupled resource</a><br> |
| <code> ├─</code> <a href="DefaultOperationMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Operation metadata</a><br> |
| <code> │ ├─</code> Distributed computing platform} «code list»<br> |
| <code> │ └─</code> <a href="../../../../../../../org.apache.sis.referencing/org/apache/sis/parameter/DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">Parameter descriptor</a><br> |
| <code> │ └─</code> Parameter direction} «enum»<br> |
| <code> └─</code> <a href="DefaultOperationChainMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Operation chain metadata</a><br> |
| </td></tr></table> |
| |
| <p>In addition to the standard properties, SIS provides the following methods:</p> |
| <ul> |
| <li><a href="DefaultRepresentativeFraction.html#setScale(double)"><code>DefaultRepresentativeFraction.setScale(double)</code></a> |
| for computing the denominator from a scale value.</li> |
| </ul> |
| |
| <h2 id="null-values-nil-objects-and-collections-heading">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> |
| </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.iso</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Root package for ISO 19115 metadata about resources (data or services).</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="AbstractIdentification.html" title="class in org.apache.sis.metadata.iso.identification">AbstractIdentification</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Basic information required to uniquely identify a resource or resources.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultAggregateInformation.html" title="class in org.apache.sis.metadata.iso.identification">DefaultAggregateInformation</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Associated resource information.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultAssociatedResource.html" title="class in org.apache.sis.metadata.iso.identification">DefaultAssociatedResource</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Associated resource information.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultBrowseGraphic.html" title="class in org.apache.sis.metadata.iso.identification">DefaultBrowseGraphic</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Graphic that provides an illustration of the dataset (should include a legend for the graphic).</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultCoupledResource.html" title="class in org.apache.sis.metadata.iso.identification">DefaultCoupledResource</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Links a given operation name with a resource identified by an "identifier".</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultDataIdentification.html" title="class in org.apache.sis.metadata.iso.identification">DefaultDataIdentification</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information required to identify a dataset.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultKeywordClass.html" title="class in org.apache.sis.metadata.iso.identification">DefaultKeywordClass</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Specification of a class to categorize keywords in a domain-specific vocabulary |
| that has a binding to a formal ontology.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultKeywords.html" title="class in org.apache.sis.metadata.iso.identification">DefaultKeywords</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Keywords, their type and reference source.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultOperationChainMetadata.html" title="class in org.apache.sis.metadata.iso.identification">DefaultOperationChainMetadata</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Operation chain information.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultOperationMetadata.html" title="class in org.apache.sis.metadata.iso.identification">DefaultOperationMetadata</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Parameter information.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultRepresentativeFraction.html" title="class in org.apache.sis.metadata.iso.identification">DefaultRepresentativeFraction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A scale defined as the inverse of a denominator.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">DefaultResolution</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Level of detail expressed as a scale factor or a ground distance.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultServiceIdentification.html" title="class in org.apache.sis.metadata.iso.identification">DefaultServiceIdentification</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Identification of capabilities which a service provider makes available to a service user |
| through a set of interfaces that define a behaviour.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultUsage.html" title="class in org.apache.sis.metadata.iso.identification">DefaultUsage</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Brief description of ways in which the resource(s) is/are currently or has been used.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |