blob: 3901ebb89e473bf51093d3d9e55d86d8b72612a6 [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>DefaultGeographicDescription (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.extent.DefaultGeographicDescription class">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="getGeographicIdentifier()">
<meta name="keywords" content="setGeographicIdentifier()">
<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="DefaultGeographicDescription (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultGeographicDescription.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>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.metadata.iso.extent</a></div>
<h2 title="Class DefaultGeographicDescription" class="title">Class DefaultGeographicDescription</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></li>
<li>
<ul class="inheritance">
<li><a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></li>
<li>
<ul class="inheritance">
<li><a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">AbstractGeographicExtent</a></li>
<li>
<ul class="inheritance">
<li>DefaultGeographicDescription</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">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>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">Geographic­Description</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">Geographic­Extent</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DefaultGeographicDescription</span>
extends <a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">AbstractGeographicExtent</a>
implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicDescription</a></pre>
<div class="block">Description of the geographic area using identifiers.
The following properties are mandatory in a well-formed metadata according ISO 19115:
<div class="preformat"><code>EX_Geographic­Description</code>
<code>  └─geographic­Identifier……</code> The identifier used to represent a geographic area.
<code>      └─code……………………………………</code> Alphanumeric value identifying an instance in the namespace.</div>
The area is given by a <a href="#getGeographicIdentifier()">geographic identifier</a>,
which may be a code in the codespace of some authority (for example an EPSG code).
In addition, the geographic identifier can optionally have a
<a href="../DefaultIdentifier.html#getDescription()">natural language description</a>.
<div class="note"><b>Example:</b>
a geographic area may be identified by the <code>1731</code> code in the <code>EPSG</code> codespace.
The natural language description for <code>EPSG:1731</code> can be <cite>“France – mainland north of 48.15°N”</cite>.
</div>
<p><b>Limitations:</b></p>
<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>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.sis.metadata.iso.extent.DefaultGeographicDescription">Serialized Form</a></dd>
<p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.sis.metadata.ModifiableMetadata">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;<a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3>
<code><a href="../../ModifiableMetadata.State.html" title="enum in org.apache.sis.metadata">Modifiable­Metadata​.State</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.ISOMetadata">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#identifiers">identifiers</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DefaultGeographicDescription</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructs an initially empty geographic description.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.CharSequence)">DefaultGeographicDescription</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;description)</code></th>
<td class="colLast">
<div class="block">Creates an inclusive geographic description initialized to the given natural language description.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.citation.Citation,java.lang.String)">DefaultGeographicDescription</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a>&nbsp;authority,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;code)</code></th>
<td class="colLast">
<div class="block">Creates an inclusive geographic description initialized to the given identifier.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.extent.GeographicDescription)">DefaultGeographicDescription</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicDescription</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="DefaultGeographicDescription.html" title="class in org.apache.sis.metadata.iso.extent">DefaultGeographicDescription</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.metadata.extent.GeographicDescription)">castOrCopy</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicDescription</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Identifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGeographicIdentifier()">getGeographicIdentifier</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the identifier used to represent a geographic area.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setGeographicIdentifier(org.opengis.metadata.Identifier)">setGeographicIdentifier</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Identifier</a>&nbsp;newValue)</code></th>
<td class="colLast">
<div class="block">Sets the identifier used to represent a geographic area.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractGeographicExtent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">AbstractGeographicExtent</a></h3>
<code><a href="AbstractGeographicExtent.html#castOrCopy(org.opengis.metadata.extent.GeographicExtent)">cast­Or­Copy</a>, <a href="AbstractGeographicExtent.html#getInclusion()">get­Inclusion</a>, <a href="AbstractGeographicExtent.html#setInclusion(java.lang.Boolean)">set­Inclusion</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.ISOMetadata">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#getIdentifier()">get­Identifier</a>, <a href="../ISOMetadata.html#getIdentifierMap()">get­Identifier­Map</a>, <a href="../ISOMetadata.html#getIdentifiers()">get­Identifiers</a>, <a href="../ISOMetadata.html#getStandard()">get­Standard</a>, <a href="../ISOMetadata.html#setIdentifier(org.opengis.metadata.Identifier)">set­Identifier</a>, <a href="../ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transition­To</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.ModifiableMetadata">
<!-- -->
</a>
<h3>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()">check­Write­Permission</a>, <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#freeze()">freeze</a>, <a href="../../ModifiableMetadata.html#isModifiable()">is­Modifiable</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#unmodifiable()">unmodifiable</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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractMetadata">
<!-- -->
</a>
<h3>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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.GeographicExtent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicExtent</a></h3>
<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicExtent.html?is-external=true#getInclusion()" title="class or interface in org.opengis.metadata.extent" class="externalLink">get­Inclusion</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultGeographicDescription</h4>
<pre>public&nbsp;DefaultGeographicDescription()</pre>
<div class="block">Constructs an initially empty geographic description.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.opengis.metadata.citation.Citation,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultGeographicDescription</h4>
<pre>public&nbsp;DefaultGeographicDescription&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a>&nbsp;authority,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;code)</pre>
<div class="block">Creates an inclusive geographic description initialized to the given identifier.
This constructor sets the <a href="AbstractGeographicExtent.html#getInclusion()">inclusion</a> property to <code>true</code>.
<p><b>Usage note:</b> if the description is a sentence like “Netherlands offshore”, it may not be suitable
for the <code>code</code> argument. Callers may consider using the <a href="../DefaultIdentifier.html#getDescription()">identifier description</a> as an alternative and keep the code for a more compact string (often a primary key).</p>
<div class="note"><b>Example:</b>
<code>new Default­Geographic­Description(<a href="../citation/Citations.html#EPSG"><code>Citations​.EPSG</code></a>, "1731")</code>
can stand for <cite>“France – mainland north of 48.15°N”</cite>.</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authority</code> - the authority of the identifier code, or <code>null</code> if none.</dd>
<dd><code>code</code> - the identifier code used to represent a geographic area, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultGeographicDescription</h4>
<pre>public&nbsp;DefaultGeographicDescription&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;description)</pre>
<div class="block">Creates an inclusive geographic description initialized to the given natural language description.
This constructor sets the <a href="AbstractGeographicExtent.html#getInclusion()">inclusion</a> property to <code>true</code> and the
<a href="../DefaultIdentifier.html#getCode()">identifier code</a> to one of the following choices:
<ul>
<li>the given <code>description</code> string if it is a valid
<a href="../../../util/CharSequences.html#isUnicodeIdentifier(java.lang.CharSequence)">Unicode identifier</a>,</li>
<li>otherwise an <a href="../../../util/CharSequences.html#camelCaseToAcronym(java.lang.CharSequence)">acronym</a>
of the given <code>description</code>.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - the natural language description of the meaning of the code value, or <code>null</code> if none.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.opengis.metadata.extent.GeographicDescription)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultGeographicDescription</h4>
<pre>public&nbsp;DefaultGeographicDescription&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicDescription</a>&nbsp;object)</pre>
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.
This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the
given object are not recursively copied.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#castOrCopy(org.opengis.metadata.extent.GeographicDescription)"><code>cast­Or­Copy(Geographic­Description)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="castOrCopy(org.opengis.metadata.extent.GeographicDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>castOrCopy</h4>
<pre class="methodSignature">public static&nbsp;<a href="DefaultGeographicDescription.html" title="class in org.apache.sis.metadata.iso.extent">DefaultGeographicDescription</a>&nbsp;castOrCopy&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicDescription</a>&nbsp;object)</pre>
<div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.
This method performs the first applicable action in the following choices:
<ul>
<li>If the given object is <code>null</code>, then this method returns <code>null</code>.</li>
<li>Otherwise if the given object is already an instance of
<code>Default­Geographic­Description</code>, then it is returned unchanged.</li>
<li>Otherwise a new <code>Default­Geographic­Description</code> instance is created using the
<a href="#%3Cinit%3E(org.opengis.metadata.extent.GeographicDescription)">copy constructor</a>
and returned. Note that this is a <cite>shallow</cite> copy operation, since the other
metadata contained in the given object are not recursively copied.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SIS implementation containing the values of the given object (may be the
given object itself), or <code>null</code> if the argument was null.</dd>
</dl>
</li>
</ul>
<a id="getGeographicIdentifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeographicIdentifier</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Identifier</a>&nbsp;getGeographicIdentifier()</pre>
<div class="block">Returns the identifier used to represent a geographic area.
<div class="note"><b>Example:</b>
an identifier with the following properties:
<ul>
<li>the <code>"EPSG"</code> code space,</li>
<li>the <code>"1731"</code> code, and</li>
<li>the <cite>“France – mainland north of 48.15°N”</cite> description.</li>
</ul></div></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true#getGeographicIdentifier()" title="class or interface in org.opengis.metadata.extent" class="externalLink">get­Geographic­Identifier</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicDescription.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">Geographic­Description</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identifier used to represent a geographic area, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="setGeographicIdentifier(org.opengis.metadata.Identifier)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setGeographicIdentifier</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setGeographicIdentifier&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Identifier</a>&nbsp;newValue)</pre>
<div class="block">Sets the identifier used to represent a geographic area.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>new­Value</code> - the new geographic identifier.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultGeographicDescription.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>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>