blob: d4c0315e7f4ed1b20c706f5ad1a9f0a872d19b65 [file] [log] [blame]
<!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.identification (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.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="../../../../../../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.identification (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&nbsp;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">&nbsp;</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&nbsp;org.apache.sis.metadata.iso.identification</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<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/metadata/identification/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.
<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/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/identification/Progress.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Progress</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/KeywordType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Keyword type</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/AssociationType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Association type</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/InitiativeType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Initiative type</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/TopicCategory.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">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/metadata/identification/TopicCategory.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Topic category</a> «code list»<br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/Progress.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">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/metadata/identification/KeywordType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">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/metadata/identification/AssociationType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">Association type</a> «code list»<br>
<code>     └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/identification/InitiativeType.html?is-external=true" title="class or interface in org.opengis.metadata.identification" class="externalLink">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="../../../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>Default­Representative­Fraction​.set­Scale(double)</code></a>
for computing the denominator from a scale value.</li>
</ul>
<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>Nil­Reason​.create­Nil­Object(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>Nil­Object</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">&nbsp;</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="AbstractIdentification.html" title="class in org.apache.sis.metadata.iso.identification">AbstractIdentification</a></th>
<td class="colLast">
<div class="block">Basic information required to uniquely identify a resource or resources.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultAggregateInformation.html" title="class in org.apache.sis.metadata.iso.identification">DefaultAggregateInformation</a></th>
<td class="colLast">
<div class="block">Associated resource information.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultAssociatedResource.html" title="class in org.apache.sis.metadata.iso.identification">DefaultAssociatedResource</a></th>
<td class="colLast">
<div class="block">Associated resource information.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultBrowseGraphic.html" title="class in org.apache.sis.metadata.iso.identification">DefaultBrowseGraphic</a></th>
<td class="colLast">
<div class="block">Graphic that provides an illustration of the dataset (should include a legend for the graphic).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultCoupledResource.html" title="class in org.apache.sis.metadata.iso.identification">DefaultCoupledResource</a></th>
<td class="colLast">
<div class="block">Links a given operation name with a resource identified by an "identifier".</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultDataIdentification.html" title="class in org.apache.sis.metadata.iso.identification">DefaultDataIdentification</a></th>
<td class="colLast">
<div class="block">Information required to identify a dataset.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultKeywordClass.html" title="class in org.apache.sis.metadata.iso.identification">DefaultKeywordClass</a></th>
<td class="colLast">
<div class="block">Specification of a class to categorize keywords in a domain-specific vocabulary
that has a binding to a formal ontology.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultKeywords.html" title="class in org.apache.sis.metadata.iso.identification">DefaultKeywords</a></th>
<td class="colLast">
<div class="block">Keywords, their type and reference source.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultOperationChainMetadata.html" title="class in org.apache.sis.metadata.iso.identification">DefaultOperationChainMetadata</a></th>
<td class="colLast">
<div class="block">Operation chain information.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultOperationMetadata.html" title="class in org.apache.sis.metadata.iso.identification">DefaultOperationMetadata</a></th>
<td class="colLast">
<div class="block">Parameter information.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultRepresentativeFraction.html" title="class in org.apache.sis.metadata.iso.identification">DefaultRepresentativeFraction</a></th>
<td class="colLast">
<div class="block">A scale defined as the inverse of a denominator.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">DefaultResolution</a></th>
<td class="colLast">
<div class="block">Level of detail expressed as a scale factor or a ground distance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultServiceIdentification.html" title="class in org.apache.sis.metadata.iso.identification">DefaultServiceIdentification</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultUsage.html" title="class in org.apache.sis.metadata.iso.identification">DefaultUsage</a></th>
<td class="colLast">
<div class="block">Brief description of ways in which the resource(s) is/are currently or has been used.</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&nbsp;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 &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>