Google Git
Sign in
apache / sis-site / 742f5abfede39cb998f99b1d3128f30817895bb1 / . / org / apache / sis / metadata / iso / ISOMetadata.html
blob: b5f3e0ca9cc273e14203c9200e83f0d9bfb67b32 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>ISOMetadata (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, class: ISOMetadata">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.metadata.iso.ISOMetadata class">
<meta name="keywords" content="identifiers">
<meta name="keywords" content="getStandard()">
<meta name="keywords" content="getIdentifiers()">
<meta name="keywords" content="getIdentifierMap()">
<meta name="keywords" content="getIdentifier()">
<meta name="keywords" content="setIdentifier()">
<meta name="keywords" content="transitionTo()">
<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="class-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ISOMetadata.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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#field-detail">Field</a></li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</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">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.metadata.iso</a></div>
<h1 title="Class ISOMetadata" class="title">Class ISOMetadata</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a>
<div class="inheritance"><a href="../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a>
<div class="inheritance">ISOMetadata</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="../../util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code>, <code><a href="../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">Identified­Object</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="content/AbstractContentInformation.html" title="class in org.apache.sis.metadata.iso.content">Abstract­Content­Information</a></code>, <code><a href="quality/AbstractElement.html" title="class in org.apache.sis.metadata.iso.quality">Abstract­Element</a></code>, <code><a href="extent/AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">Abstract­Geographic­Extent</a></code>, <code><a href="spatial/AbstractGeolocationInformation.html" title="class in org.apache.sis.metadata.iso.spatial">Abstract­Geolocation­Information</a></code>, <code><a href="identification/AbstractIdentification.html" title="class in org.apache.sis.metadata.iso.identification">Abstract­Identification</a></code>, <code><a href="citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">Abstract­Party</a></code>, <code><a href="quality/AbstractResult.html" title="class in org.apache.sis.metadata.iso.quality">Abstract­Result</a></code>, <code><a href="spatial/AbstractSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Abstract­Spatial­Representation</a></code>, <code><a href="acquisition/DefaultAcquisitionInformation.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Acquisition­Information</a></code>, <code><a href="citation/DefaultAddress.html" title="class in org.apache.sis.metadata.iso.citation">Default­Address</a></code>, <code><a href="lineage/DefaultAlgorithm.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Algorithm</a></code>, <code><a href="DefaultApplicationSchemaInformation.html" title="class in org.apache.sis.metadata.iso">Default­Application­Schema­Information</a></code>, <code><a href="identification/DefaultAssociatedResource.html" title="class in org.apache.sis.metadata.iso.identification">Default­Associated­Resource</a></code>, <code><a href="content/DefaultAttributeGroup.html" title="class in org.apache.sis.metadata.iso.content">Default­Attribute­Group</a></code>, <code><a href="quality/DefaultBasicMeasure.html" title="class in org.apache.sis.metadata.iso.quality">Default­Basic­Measure</a></code>, <code><a href="identification/DefaultBrowseGraphic.html" title="class in org.apache.sis.metadata.iso.identification">Default­Browse­Graphic</a></code>, <code><a href="citation/DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation">Default­Citation</a></code>, <code><a href="citation/DefaultCitationDate.html" title="class in org.apache.sis.metadata.iso.citation">Default­Citation­Date</a></code>, <code><a href="constraint/DefaultConstraints.html" title="class in org.apache.sis.metadata.iso.constraint">Default­Constraints</a></code>, <code><a href="citation/DefaultContact.html" title="class in org.apache.sis.metadata.iso.citation">Default­Contact</a></code>, <code><a href="identification/DefaultCoupledResource.html" title="class in org.apache.sis.metadata.iso.identification">Default­Coupled­Resource</a></code>, <code><a href="distribution/DefaultDataFile.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Data­File</a></code>, <code><a href="quality/DefaultDataQuality.html" title="class in org.apache.sis.metadata.iso.quality">Default­Data­Quality</a></code>, <code><a href="distribution/DefaultDigitalTransferOptions.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Digital­Transfer­Options</a></code>, <code><a href="spatial/DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">Default­Dimension</a></code>, <code><a href="distribution/DefaultDistribution.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Distribution</a></code>, <code><a href="distribution/DefaultDistributor.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Distributor</a></code>, <code><a href="acquisition/DefaultEnvironmentalRecord.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Environmental­Record</a></code>, <code><a href="quality/DefaultEvaluationMethod.html" title="class in org.apache.sis.metadata.iso.quality">Default­Evaluation­Method</a></code>, <code><a href="quality/DefaultEvaluationReportInformation.html" title="class in org.apache.sis.metadata.iso.quality">Default­Evaluation­Report­Information</a></code>, <code><a href="acquisition/DefaultEvent.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Event</a></code>, <code><a href="DefaultExtendedElementInformation.html" title="class in org.apache.sis.metadata.iso">Default­Extended­Element­Information</a></code>, <code><a href="extent/DefaultExtent.html" title="class in org.apache.sis.metadata.iso.extent">Default­Extent</a></code>, <code><a href="content/DefaultFeatureTypeInfo.html" title="class in org.apache.sis.metadata.iso.content">Default­Feature­Type­Info</a></code>, <code><a href="distribution/DefaultFormat.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Format</a></code>, <code><a href="spatial/DefaultGCP.html" title="class in org.apache.sis.metadata.iso.spatial">Default­GCP</a></code>, <code><a href="spatial/DefaultGeometricObjects.html" title="class in org.apache.sis.metadata.iso.spatial">Default­Geometric­Objects</a></code>, <code><a href="DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso">Default­Identifier</a></code>, <code><a href="acquisition/DefaultInstrument.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Instrument</a></code>, <code><a href="identification/DefaultKeywordClass.html" title="class in org.apache.sis.metadata.iso.identification">Default­Keyword­Class</a></code>, <code><a href="identification/DefaultKeywords.html" title="class in org.apache.sis.metadata.iso.identification">Default­Keywords</a></code>, <code><a href="lineage/DefaultLineage.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Lineage</a></code>, <code><a href="maintenance/DefaultMaintenanceInformation.html" title="class in org.apache.sis.metadata.iso.maintenance">Default­Maintenance­Information</a></code>, <code><a href="quality/DefaultMeasureDescription.html" title="class in org.apache.sis.metadata.iso.quality">Default­Measure­Description</a></code>, <code><a href="quality/DefaultMeasureReference.html" title="class in org.apache.sis.metadata.iso.quality">Default­Measure­Reference</a></code>, <code><a href="distribution/DefaultMedium.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Medium</a></code>, <code><a href="DefaultMetadata.html" title="class in org.apache.sis.metadata.iso">Default­Metadata</a></code>, <code><a href="DefaultMetadataExtensionInformation.html" title="class in org.apache.sis.metadata.iso">Default­Metadata­Extension­Information</a></code>, <code><a href="DefaultMetadataScope.html" title="class in org.apache.sis.metadata.iso">Default­Metadata­Scope</a></code>, <code><a href="lineage/DefaultNominalResolution.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Nominal­Resolution</a></code>, <code><a href="acquisition/DefaultObjective.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Objective</a></code>, <code><a href="citation/DefaultOnlineResource.html" title="class in org.apache.sis.metadata.iso.citation">Default­Online­Resource</a></code>, <code><a href="acquisition/DefaultOperation.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Operation</a></code>, <code><a href="identification/DefaultOperationChainMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Default­Operation­Chain­Metadata</a></code>, <code><a href="identification/DefaultOperationMetadata.html" title="class in org.apache.sis.metadata.iso.identification">Default­Operation­Metadata</a></code>, <code><a href="acquisition/DefaultPlan.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Plan</a></code>, <code><a href="acquisition/DefaultPlatform.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Platform</a></code>, <code><a href="acquisition/DefaultPlatformPass.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Platform­Pass</a></code>, <code><a href="DefaultPortrayalCatalogueReference.html" title="class in org.apache.sis.metadata.iso">Default­Portrayal­Catalogue­Reference</a></code>, <code><a href="lineage/DefaultProcessing.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Processing</a></code>, <code><a href="lineage/DefaultProcessStep.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Process­Step</a></code>, <code><a href="lineage/DefaultProcessStepReport.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Process­Step­Report</a></code>, <code><a href="quality/DefaultQualityMeasure.html" title="class in org.apache.sis.metadata.iso.quality">Default­Quality­Measure</a></code>, <code><a href="content/DefaultRangeDimension.html" title="class in org.apache.sis.metadata.iso.content">Default­Range­Dimension</a></code>, <code><a href="content/DefaultRangeElementDescription.html" title="class in org.apache.sis.metadata.iso.content">Default­Range­Element­Description</a></code>, <code><a href="constraint/DefaultReleasability.html" title="class in org.apache.sis.metadata.iso.constraint">Default­Releasability</a></code>, <code><a href="acquisition/DefaultRequestedDate.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Requested­Date</a></code>, <code><a href="acquisition/DefaultRequirement.html" title="class in org.apache.sis.metadata.iso.acquisition">Default­Requirement</a></code>, <code><a href="identification/DefaultResolution.html" title="class in org.apache.sis.metadata.iso.identification">Default­Resolution</a></code>, <code><a href="citation/DefaultResponsibility.html" title="class in org.apache.sis.metadata.iso.citation">Default­Responsibility</a></code>, <code><a href="maintenance/DefaultScope.html" title="class in org.apache.sis.metadata.iso.maintenance">Default­Scope</a></code>, <code><a href="maintenance/DefaultScopeDescription.html" title="class in org.apache.sis.metadata.iso.maintenance">Default­Scope­Description</a></code>, <code><a href="citation/DefaultSeries.html" title="class in org.apache.sis.metadata.iso.citation">Default­Series</a></code>, <code><a href="lineage/DefaultSource.html" title="class in org.apache.sis.metadata.iso.lineage">Default­Source</a></code>, <code><a href="quality/DefaultSourceReference.html" title="class in org.apache.sis.metadata.iso.quality">Default­Source­Reference</a></code>, <code><a href="distribution/DefaultStandardOrderProcess.html" title="class in org.apache.sis.metadata.iso.distribution">Default­Standard­Order­Process</a></code>, <code><a href="citation/DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">Default­Telephone</a></code>, <code><a href="extent/DefaultTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Default­Temporal­Extent</a></code>, <code><a href="identification/DefaultUsage.html" title="class in org.apache.sis.metadata.iso.identification">Default­Usage</a></code>, <code><a href="extent/DefaultVerticalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Default­Vertical­Extent</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ISOMetadata</span>
<span class="extends-implements">extends <a href="../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a>
implements <a href="../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">IdentifiedObject</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
<div class="block">The base class of ISO 19115 implementation classes. Each sub-classes implements one
of the ISO Metadata interface provided by <a href="http://www.geoapi.org">GeoAPI</a>.
<h2>Limitations</h2>
<ul>
<li>Instances of this class are not synchronized for multi-threading.
Synchronization, if needed, is caller's responsibility.</li>
<li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use <a href="../../xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> instead.</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../serialized-form.html#org.apache.sis.metadata.iso.ISOMetadata">Serialized Form</a></li>
</ul>
</dd>
<p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.sis.metadata.ModifiableMetadata">Nested classes/interfaces inherited from class&nbsp;<a href="../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h2>
<code><a href="../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">Modifiable­Metadata​.State</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#identifiers" class="member-name-link">identifiers</a></code></div>
<div class="col-last even-row-color">
<div class="block">All identifiers associated with this metadata, or <code>null</code> if none.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ISOMetadata</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs an initially empty metadata.</div>
</div>
<div class="col-first odd-row-color"><code>protected </code></div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.Object)" class="member-name-link">ISOMetadata</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructs a new metadata initialized with the values from the specified object.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIdentifier()" class="member-name-link">get­Identifier</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../xml/IdentifierMap.html" title="interface in org.apache.sis.xml">Identifier­Map</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIdentifierMap()" class="member-name-link">get­Identifier­Map</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">A map view of the <a href="../../xml/IdentifiedObject.html#getIdentifiers()">identifiers</a> collection
as (<var>authority</var>, <var>code</var>) entries.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIdentifiers()" class="member-name-link">get­Identifiers</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns all identifiers associated to this object (from conceptual model and from XML document).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../MetadataStandard.html" title="class in org.apache.sis.metadata">Metadata­Standard</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStandard()" class="member-name-link">get­Standard</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the metadata standard implemented by subclasses,
which is <a href="../MetadataStandard.html#ISO_19115">ISO 19115</a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIdentifier(org.opengis.metadata.Identifier)" class="member-name-link">set­Identifier</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)" class="member-name-link">transition­To</a><wbr>(<a href="../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">Modifiable­Metadata​.State</a>&nbsp;target)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Requests this metadata instance and (potentially) all its children to transition to a new state.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-ModifiableMetadata">Methods inherited from class&nbsp;<a href="../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3>
<code><a href="../ModifiableMetadata.html#checkWritePermission(java.lang.Object)">check­Write­Permission</a>, <a href="../ModifiableMetadata.html#collectionType(java.lang.Class)">collection­Type</a>, <a href="../ModifiableMetadata.html#copyCollection(java.util.Collection,java.lang.Class)">copy­Collection</a>, <a href="../ModifiableMetadata.html#copyList(java.util.Collection,java.lang.Class)">copy­List</a>, <a href="../ModifiableMetadata.html#copyMap(java.util.Map,java.lang.Class)">copy­Map</a>, <a href="../ModifiableMetadata.html#copySet(java.util.Collection,java.lang.Class)">copy­Set</a>, <a href="../ModifiableMetadata.html#deepCopy(org.apache.sis.metadata.ModifiableMetadata.State)">deep­Copy</a>, <a href="../ModifiableMetadata.html#nonNullCollection(java.util.Collection,java.lang.Class)">non­Null­Collection</a>, <a href="../ModifiableMetadata.html#nonNullList(java.util.List,java.lang.Class)">non­Null­List</a>, <a href="../ModifiableMetadata.html#nonNullMap(java.util.Map,java.lang.Class)">non­Null­Map</a>, <a href="../ModifiableMetadata.html#nonNullSet(java.util.Set,java.lang.Class)">non­Null­Set</a>, <a href="../ModifiableMetadata.html#singleton(E,java.lang.Class)">singleton</a>, <a href="../ModifiableMetadata.html#state()">state</a>, <a href="../ModifiableMetadata.html#writeCollection(java.util.Collection,java.util.Collection,java.lang.Class)">write­Collection</a>, <a href="../ModifiableMetadata.html#writeList(java.util.Collection,java.util.List,java.lang.Class)">write­List</a>, <a href="../ModifiableMetadata.html#writeMap(java.util.Map,java.util.Map,java.lang.Class)">write­Map</a>, <a href="../ModifiableMetadata.html#writeSet(java.util.Collection,java.util.Set,java.lang.Class)">write­Set</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-AbstractMetadata">Methods inherited from class&nbsp;<a href="../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></h3>
<code><a href="../AbstractMetadata.html#asMap()">as­Map</a>, <a href="../AbstractMetadata.html#asTreeTable()">as­Tree­Table</a>, <a href="../AbstractMetadata.html#equals(java.lang.Object)">equals</a>, <a href="../AbstractMetadata.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="../AbstractMetadata.html#getInterface()">get­Interface</a>, <a href="../AbstractMetadata.html#hashCode()">hash­Code</a>, <a href="../AbstractMetadata.html#isEmpty()">is­Empty</a>, <a href="../AbstractMetadata.html#prune()">prune</a>, <a href="../AbstractMetadata.html#toString()">to­String</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="identifiers">
<h3>identifiers</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&gt;</span>&nbsp;<span class="element-name">identifiers</span></div>
<div class="block">All identifiers associated with this metadata, or <code>null</code> if none.
This field is initialized to a non-null value when first needed.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>ISOMetadata</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">ISOMetadata</span>()</div>
<div class="block">Constructs an initially empty metadata.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.Object)">
<h3>ISOMetadata</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">ISOMetadata</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</span></div>
<div class="block">Constructs a new metadata initialized with the values from the specified object.
If the given object is an instance of <a href="../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml"><code>Identified­Object</code></a>, then this constructor
copies the <a href="#identifiers">collection of identifiers</a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getStandard()">
<h3>getStandard</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../MetadataStandard.html" title="class in org.apache.sis.metadata">MetadataStandard</a></span>&nbsp;<span class="element-name">getStandard</span>()</div>
<div class="block">Returns the metadata standard implemented by subclasses,
which is <a href="../MetadataStandard.html#ISO_19115">ISO 19115</a>.
<h4>Note for implementers</h4>
Subclasses shall not override this method in a way that depends on the object state,
since this method may be indirectly invoked by copy constructors (i.e. is may be
invoked before this metadata object is fully constructed).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../AbstractMetadata.html#getStandard()">get­Standard</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractMetadata.html" title="class in org.apache.sis.metadata">Abstract­Metadata</a></code></dd>
<dt>Returns:</dt>
<dd>the metadata standard, which is <a href="../MetadataStandard.html#ISO_19115">ISO 19115</a> by default.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdentifiers()">
<h3>getIdentifiers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&gt;</span>&nbsp;<span class="element-name">getIdentifiers</span>()</div>
<div class="block">Returns all identifiers associated to this object (from conceptual model and from XML document).
This collection may contain identifiers from different sources:
<ul class="verbose">
<li>Identifiers specified in the ISO 19115-1 or 19115-2 abstract models,
typically (but not necessarily) as an <code>identifier</code> property
(may also be <a href="DefaultMetadata.html#getMetadataIdentifier()"><code>metadata­Identifier</code></a>,
<a href="citation/DefaultCitation.html#getISBN()"><code>ISBN</code></a> or
<a href="citation/DefaultCitation.html#getISSN()"><code>ISSN</code></a> properties).</li>
<li>Identifiers specified in the ISO 19115-3 or 19115-4 XML schemas.
Those identifiers are typically stored as a result of unmarshalling an XML document.
Those identifiers can be recognized by an <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html#getAuthority()" title="class or interface in org.opengis.metadata" class="external-link">authority</a>
sets as one of the <a href="../../xml/IdentifierSpace.html" title="interface in org.apache.sis.xml"><code>Identifier­Space</code></a> constants.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../xml/IdentifiedObject.html#getIdentifiers()">get­Identifiers</a></code>&nbsp;in interface&nbsp;<code><a href="../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">Identified­Object</a></code></dd>
<dt>Returns:</dt>
<dd>all identifiers associated to this object, or an empty collection if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="citation/DefaultCitation.html#getIdentifiers()"><code>Default­Citation​.get­Identifiers()</code></a></li>
<li><a href="acquisition/DefaultObjective.html#getIdentifiers()"><code>Default­Objective​.get­Identifiers()</code></a></li>
<li><a href="../../referencing/AbstractIdentifiedObject.html#getIdentifiers()"><code>Abstract­Identified­Object​.get­Identifiers()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdentifierMap()">
<h3>getIdentifierMap</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../xml/IdentifierMap.html" title="interface in org.apache.sis.xml">IdentifierMap</a></span>&nbsp;<span class="element-name">getIdentifierMap</span>()</div>
<div class="block">A map view of the <a href="../../xml/IdentifiedObject.html#getIdentifiers()">identifiers</a> collection
as (<var>authority</var>, <var>code</var>) entries.
Each <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">map entry</a> is associated
to an element from the above identifier collection in which the
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html#getKey()" title="class or interface in java.util" class="external-link">key</a> is the
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html#getAuthority()" title="class or interface in org.opengis.metadata" class="external-link">identifier authority</a> and the
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.Entry.html#getValue()" title="class or interface in java.util" class="external-link">value</a> is the
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html#getCode()" title="class or interface in org.opengis.metadata" class="external-link">identifier code</a>.
<p>There is usually a one-to-one relationship between the map entries and the identifier
elements, but not always:</p>
<ul>
<li>The map view may contain less entries, because the map interface allows only one
entry per authority. If the <a href="../../xml/IdentifiedObject.html#getIdentifiers()">identifier collection</a> contains
many identifiers for the same authority, then only the first occurrence is visible through
this <code>Map</code> view.</li>
<li>The map view may also contain more entries than the <a href="../../xml/IdentifiedObject.html#getIdentifiers()">identifier collection</a>. For example, the <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"><code>Citation</code></a>
interface defines separated attributes for ISBN, ISSN and other identifiers. This map
view may choose to unify all those attributes in a single view.</li>
</ul>
The map supports <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#put(K,V)" title="class or interface in java.util" class="external-link"><code>put</code></a> operations
if and only if this <code>Identified­Object</code> is modifiable.
<p>The default implementation returns a wrapper around the <a href="#identifiers"><code>identifiers</code></a> list.
That map is <em>live</em>: changes in the identifiers list will be reflected in the map,
and conversely.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../xml/IdentifiedObject.html#getIdentifierMap()">get­Identifier­Map</a></code>&nbsp;in interface&nbsp;<code><a href="../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">Identified­Object</a></code></dd>
<dt>Returns:</dt>
<dd>the identifiers as a map of (<var>authority</var>, <var>code</var>) entries,
or an empty map if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdentifier()">
<h3>getIdentifier</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a></span>&nbsp;<span class="element-name">getIdentifier</span>()</div>
<div class="block">Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
This method checks the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html#getAuthority()" title="class or interface in org.opengis.metadata" class="external-link">authority</a> for filtering ignorable
identifiers like ISBN/ISSN codes and XML attributes.
This convenience method is provided for implementation of public <code>get­Identifier(Identifier)</code>
methods in subclasses having an <code>identifier</code> property with [0 … 1] multiplicity.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an identifier from ISO 19115-3 conceptual model (excluding XML identifiers),
or <code>null</code> if none.</dd>
<dt>Since:</dt>
<dd>1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setIdentifier(org.opengis.metadata.Identifier)">
<h3>setIdentifier</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setIdentifier</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>&nbsp;newValue)</span></div>
<div class="block">Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.
This convenience method is provided for implementation of public <code>set­Identifier(Identifier)</code> methods
in subclasses having an <code>identifier</code> property with [0 … 1] multiplicity.
The default implementation removes all identifiers that would be returned by <a href="#getIdentifier()"><code>get­Identifier()</code></a>
before to add the given one in the <a href="#identifiers"><code>identifiers</code></a> collection.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new identifier value, or <code>null</code> for removing the identifier.</dd>
<dt>Since:</dt>
<dd>1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">
<h3>transitionTo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">transitionTo</span><wbr><span class="parameters">(<a href="../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">ModifiableMetadata.State</a>&nbsp;target)</span></div>
<div class="block">Requests this metadata instance and (potentially) all its children to transition to a new state.
The action performed by this method depends on the <a href="../ModifiableMetadata.html#state()">source state</a> and the
given target state, as listed in the following table:
<table class="sis">
<caption>State transitions</caption>
<tr>
<th>Current state</th>
<th>Target state</th>
<th>Action</th>
</tr><tr>
<td><var>Any</var></td>
<td><var>Same</var></td>
<td>Does nothing and returns <code>false</code>.</td>
</tr><tr>
<td><a href="../ModifiableMetadata.State.html#EDITABLE"><code>ModifiableMetadata.State.EDITABLE</code></a></td>
<td><a href="../ModifiableMetadata.State.html#COMPLETABLE"><code>ModifiableMetadata.State.COMPLETABLE</code></a></td>
<td>Marks this metadata and all children as completable.</td>
</tr><tr>
<td>Any</td>
<td><a href="../ModifiableMetadata.State.html#FINAL"><code>ModifiableMetadata.State.FINAL</code></a></td>
<td>Marks this metadata and all children as unmodifiable.</td>
</tr><tr>
<td><a href="../ModifiableMetadata.State.html#FINAL"><code>ModifiableMetadata.State.FINAL</code></a></td>
<td>Any other</td>
<td>Throws <a href="../UnmodifiableMetadataException.html" title="class in org.apache.sis.metadata"><code>Unmodifiable­Metadata­Exception</code></a>.</td>
</tr>
</table>
The effect of invoking this method may be recursive. For example, transitioning to <a href="../ModifiableMetadata.State.html#FINAL"><code>Modifiable­Metadata​.State​.FINAL</code></a>
implies transitioning all children <code>Modifiable­Metadata</code> instances to the final state too.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../ModifiableMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transition­To</a></code>&nbsp;in class&nbsp;<code><a href="../ModifiableMetadata.html" title="class in org.apache.sis.metadata">Modifiable­Metadata</a></code></dd>
<dt>Parameters:</dt>
<dd><code>target</code> - the desired new state (editable, completable or final).</dd>
<dt>Returns:</dt>
<dd><code>true</code> if the state of this <code>Modifiable­Metadata</code> changed as a result of this method call.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>