| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>org.apache.sis.metadata.iso.citation (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.citation"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.metadata.iso.citation 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.citation" class="title">Package org.apache.sis.metadata.iso.citation</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.metadata.iso.citation</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Reference to the data or service (citation, responsible party, contact information). |
| An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/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. |
| |
| <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="DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation">Citation</a><br> |
| <code> ├─</code> <a href="DefaultCitationDate.html" title="class in org.apache.sis.metadata.iso.citation">Citation date</a><br> |
| <code> ├─</code> <a href="DefaultResponsibility.html" title="class in org.apache.sis.metadata.iso.citation">Responsibility</a><br> |
| <code> ├─</code> <a href="AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">Party</a><br> |
| <code> │ ├─</code> <a href="DefaultIndividual.html" title="class in org.apache.sis.metadata.iso.citation">Individual</a><br> |
| <code> │ └─</code> <a href="DefaultOrganisation.html" title="class in org.apache.sis.metadata.iso.citation">Organisation</a><br> |
| <code> ├─</code> <a href="DefaultContact.html" title="class in org.apache.sis.metadata.iso.citation">Contact</a><br> |
| <code> ├─</code> <a href="DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">Telephone</a><br> |
| <code> ├─</code> <a href="DefaultAddress.html" title="class in org.apache.sis.metadata.iso.citation">Address</a><br> |
| <code> ├─</code> <a href="DefaultOnlineResource.html" title="class in org.apache.sis.metadata.iso.citation">Online resource</a><br> |
| <code> └─</code> <a href="DefaultSeries.html" title="class in org.apache.sis.metadata.iso.citation">Series</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/citation/DateType.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Date type</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/OnLineFunction.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Online function</a><br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/PresentationForm.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Presentation form</a><br> |
| <code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Role.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Role</a><br> |
| </td><td class="sep" style="width: 50%; white-space: nowrap"> |
| <a href="DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation">Citation</a><br> |
| <code> ├─</code> <a href="DefaultCitationDate.html" title="class in org.apache.sis.metadata.iso.citation">Citation date</a><br> |
| <code> │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/DateType.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Date type</a> «code list»<br> |
| <code> ├─</code> <a href="DefaultResponsibility.html" title="class in org.apache.sis.metadata.iso.citation">Responsibility</a><br> |
| <code> │ ├─</code> <a href="AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">Party</a><br> |
| <code> │ │ └─</code> <a href="DefaultContact.html" title="class in org.apache.sis.metadata.iso.citation">Contact</a><br> |
| <code> │ │ ├─</code> <a href="DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">Telephone</a><br> |
| <code> │ │ ├─</code> <a href="DefaultAddress.html" title="class in org.apache.sis.metadata.iso.citation">Address</a><br> |
| <code> │ │ └─</code> <a href="DefaultOnlineResource.html" title="class in org.apache.sis.metadata.iso.citation">Online resource</a><br> |
| <code> │ │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/OnLineFunction.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Online function</a> «code list»<br> |
| <code> │ └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Role.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Role</a> «code list»<br> |
| <code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/PresentationForm.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Presentation form</a> «code list»<br> |
| <code> └─</code> <a href="DefaultSeries.html" title="class in org.apache.sis.metadata.iso.citation">Series</a><br> |
| </td></tr></table> |
| |
| <h2>Unified identifiers view</h2> |
| Apache SIS provides a unified view of all metadata identifiers. This view includes the citation |
| <a href="DefaultCitation.html#getISBN()">ISBN</a> and |
| <a href="DefaultCitation.html#getISSN()">ISSN</a> codes, |
| except at XML marshalling time (for ISO 19115-3 compliance). |
| See <a href="../../../xml/IdentifierMap.html" title="interface in org.apache.sis.xml"><code>IdentifierMap</code></a> for more information. |
| |
| <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.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="AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">AbstractParty</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the individual and / or organization of the party.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Citations.html" title="class in org.apache.sis.metadata.iso.citation">Citations</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A set of predefined constants and static methods working on <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Citation.html" title="class or interface in org.opengis.metadata.citation" class="external-link">citations</a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultAddress.html" title="class in org.apache.sis.metadata.iso.citation">DefaultAddress</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Location of the responsible individual or organization.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation">DefaultCitation</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Standardized resource reference.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultCitationDate.html" title="class in org.apache.sis.metadata.iso.citation">DefaultCitationDate</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Reference date and event used to describe it.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultContact.html" title="class in org.apache.sis.metadata.iso.citation">DefaultContact</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information required to enable contact with the responsible person and/or organization.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultIndividual.html" title="class in org.apache.sis.metadata.iso.citation">DefaultIndividual</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the party if the party is an individual.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultOnlineResource.html" title="class in org.apache.sis.metadata.iso.citation">DefaultOnlineResource</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about on-line sources from which the dataset, specification, or |
| community profile name and extended metadata elements can be obtained.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultOrganisation.html" title="class in org.apache.sis.metadata.iso.citation">DefaultOrganisation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the party if the party is an organization.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultResponsibility.html" title="class in org.apache.sis.metadata.iso.citation">DefaultResponsibility</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the party and their role.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultResponsibleParty.html" title="class in org.apache.sis.metadata.iso.citation">DefaultResponsibleParty</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Identification of, and means of communication with, person(s) and |
| organizations associated with the dataset.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultSeries.html" title="class in org.apache.sis.metadata.iso.citation">DefaultSeries</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the series, or aggregate dataset, to which a dataset belongs.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">DefaultTelephone</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Telephone numbers for contacting the responsible individual or organization.</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> |
