| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>NamedIdentifier (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.referencing.NamedIdentifier class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="tip()"> |
| <meta name="keywords" content="head()"> |
| <meta name="keywords" content="scope()"> |
| <meta name="keywords" content="depth()"> |
| <meta name="keywords" content="getParsedNames()"> |
| <meta name="keywords" content="push()"> |
| <meta name="keywords" content="toFullyQualifiedName()"> |
| <meta name="keywords" content="toInternationalString()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="compareTo()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <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="NamedIdentifier (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/NamedIdentifier.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 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: </li> |
| <li>Nested | </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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.sis.referencing</a></div> |
| <h2 title="Class NamedIdentifier" class="title">Class NamedIdentifier</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="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>NamedIdentifier</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>></code>, <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>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">NamedIdentifier</span> |
| extends <a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></pre> |
| <div class="block">An identification of a CRS object which is both a <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"><code>Identifier</code></a> and a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a>. |
| This class implements both interfaces in order to allow usage of the same instance either as an object |
| <a href="AbstractIdentifiedObject.html#getName()">name</a> or <a href="AbstractIdentifiedObject.html#getAlias()">alias</a>. |
| This flexibility make easier to uses object's names in two different models: |
| |
| <ul> |
| <li>In the ISO 19111 model, objects have a single name of type <code>RS_Identifier</code> and an arbitrary amount |
| of aliases of type <code>GenericName</code>.</li> |
| <li>In the GML model, objects have an arbitrary amount of names of type <code>gml:CodeType</code>, |
| but do not have any alias.</li> |
| </ul> |
| |
| By using this <code>NamedIdentifier</code> class, users can declare supplemental object's names as |
| <a href="AbstractIdentifiedObject.html#getAlias()">aliases</a> and have those names used in contexts |
| where <code>Identifier</code> instances are required, like GML marshalling time. |
| |
| <div class="section">Name ↔ Identifier mapping</div> |
| The <code>GenericName</code> attributes will be inferred from <code>Identifier</code> attributes as below: |
| |
| <ul> |
| <li><b><a href="#tip()">Tip</a>:</b> derived from the identifier <a href="ImmutableIdentifier.html#getCode()">code</a>.</li> |
| <li><b><a href="#head()">Head</a>:</b> derived from the identifier <a href="ImmutableIdentifier.html#getCodeSpace()">code space</a> if non-null. |
| If there is no code space, then the scope is derived from the shortest <a href="ImmutableIdentifier.html#getAuthority()">authority</a>'s |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true#getAlternateTitles()" title="class or interface in org.opengis.metadata.citation" class="externalLink">alternate titles</a>, or the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true#getTitle()" title="class or interface in org.opengis.metadata.citation" class="externalLink">main title</a> |
| if there is no alternate titles. This policy exploits the ISO 19115 comment saying that citation alternate titles |
| often contain abbreviation (for example "DCW" as an alternative title for <cite>"Digital Chart of the World"</cite>).</li> |
| </ul> |
| |
| <div class="note"><b>Example:</b> |
| If the identifier attributes are <code>authority</code> = <code>new DefaultCitation("IOGP")</code>, |
| <code>codeSpace</code> = <code>"EPSG"</code> and <code>code</code> = <code>"4326"</code>, then the name attributes will be |
| <code>head</code> = <code>"EPSG"</code>, <code>tip</code> = <code>"4326"</code> and <a href="#toString()"><code>toString()</code></a> = <code>"EPSG:4326"</code>. |
| Note that the scope does not appear in the string representation of names.</div> |
| |
| |
| <div class="section">Immutability and thread safety</div> |
| This class is immutable and thus inherently thread-safe if the <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"><code>Citation</code></a> and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> |
| arguments given to the constructor are also immutable. It is caller's responsibility to ensure that those |
| conditions hold, for example by invoking <a href="../metadata/iso/ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)"><code>DefaultCitation.transitionTo(DefaultCitation.State.FINAL)</code></a> before passing the arguments to the constructor. |
| Subclasses shall make sure that any overridden methods remain safe to call from multiple threads and do not change |
| any public <code>NamedIdentifier</code> state.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../metadata/iso/DefaultIdentifier.html" title="class in org.apache.sis.metadata.iso"><code>DefaultIdentifier</code></a>, |
| <a href="../util/iso/AbstractName.html" title="class in org.apache.sis.util.iso"><code>AbstractName</code></a>, |
| <a href="AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.referencing.NamedIdentifier">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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.ImmutableIdentifier"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class <a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a></h3> |
| <code><a href="ImmutableIdentifier.html#DESCRIPTION_KEY">DESCRIPTION_KEY</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.Identifier"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface <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></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#AUTHORITY_KEY" title="class or interface in org.opengis.metadata" class="externalLink">AUTHORITY_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#CODE_KEY" title="class or interface in org.opengis.metadata" class="externalLink">CODE_KEY</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.ReferenceIdentifier"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true#CODESPACE_KEY" title="class or interface in org.opengis.referencing" class="externalLink">CODESPACE_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true#VERSION_KEY" title="class or interface in org.opengis.referencing" class="externalLink">VERSION_KEY</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"> </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(java.util.Map)">NamedIdentifier</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​?> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs an identifier from the given properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.citation.Citation,java.lang.CharSequence)">NamedIdentifier</a></span>​(<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> authority, |
| <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> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs an identifier from an authority and code.</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,java.lang.CharSequence,java.lang.String,org.opengis.util.InternationalString)">NamedIdentifier</a></span>​(<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> 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> codeSpace, |
| <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> code, |
| <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> version, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs an identifier from an authority and localizable code, |
| with an optional version number and description.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.ReferenceIdentifier)">NamedIdentifier</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new identifier from the specified one.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.util.GenericName)">NamedIdentifier</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new identifier from the specified name.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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="NamedIdentifier.html" title="class in org.apache.sis.referencing">NamedIdentifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.referencing.ReferenceIdentifier)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS identifier implementation with the values of the given arbitrary implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="NamedIdentifier.html" title="class in org.apache.sis.referencing">NamedIdentifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.util.GenericName)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS name implementation with the values of the given arbitrary implementation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.opengis.util.GenericName)">compareTo</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this name with the specified object for order.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#depth()">depth</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the depth of this name within the namespace hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<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> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this identifier with the specified object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParsedNames()">getParsedNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the sequence of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">local names</a> making this generic name.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a hash code value for this object.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#head()">head</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element in the sequence of <a href="#getParsedNames()">parsed names</a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/ScopedName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">ScopedName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#push(org.opengis.util.GenericName)">push</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> scope)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns this name expanded with the specified scope.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scope()">scope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the scope (name space) in which this name is local.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tip()">tip</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The last element in the sequence of <a href="#getParsedNames()">parsed names</a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toFullyQualifiedName()">toFullyQualifiedName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a view of this name as a fully-qualified name.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toInternationalString()">toInternationalString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a local-dependent string representation of this generic name.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this generic name.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.ImmutableIdentifier"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a></h3> |
| <code><a href="ImmutableIdentifier.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a>, <a href="ImmutableIdentifier.html#getAuthority()">getAuthority</a>, <a href="ImmutableIdentifier.html#getCode()">getCode</a>, <a href="ImmutableIdentifier.html#getCodeSpace()">getCodeSpace</a>, <a href="ImmutableIdentifier.html#getDescription()">getDescription</a>, <a href="ImmutableIdentifier.html#getVersion()">getVersion</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.FormattableObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3> |
| <code><a href="../io/wkt/FormattableObject.html#print()">print</a>, <a href="../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <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">getClass</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">notifyAll</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> |
| </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="<init>(org.opengis.referencing.ReferenceIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NamedIdentifier</h4> |
| <pre>public NamedIdentifier​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> identifier)</pre> |
| <div class="block">Creates a new identifier from the specified one. This is a copy constructor which get the code, |
| codespace, authority, version and the description (if available) from the given identifier. |
| |
| <p>If the given identifier implements the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a> interface, then calls to |
| <a href="#tip()"><code>tip()</code></a>, <a href="#head()"><code>head()</code></a>, <a href="#scope()"><code>scope()</code></a> and similar methods will delegate |
| to that name.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - the identifier to copy.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#castOrCopy(org.opengis.referencing.ReferenceIdentifier)"><code>castOrCopy(ReferenceIdentifier)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NamedIdentifier</h4> |
| <pre>public NamedIdentifier​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> name)</pre> |
| <div class="block">Creates a new identifier from the specified name. This constructor infers the identifier attributes |
| (code, codespace and authority) from the given name. Calls to name-related methods like <a href="#tip()"><code>tip()</code></a>, |
| <a href="#head()"><code>head()</code></a> and <a href="#scope()"><code>scope()</code></a> will delegate to the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name to wrap.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#castOrCopy(org.opengis.util.GenericName)"><code>castOrCopy(GenericName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NamedIdentifier</h4> |
| <pre>public NamedIdentifier​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​?> properties) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> |
| <div class="block">Constructs an identifier from the given properties. The content of the properties map is used as |
| described in the <a href="ImmutableIdentifier.html#%3Cinit%3E(java.util.Map)">super-class constructor</a>, |
| with the addition of an optional <code>"name"</code> property. |
| |
| <table class="sis"> |
| <caption>Recognized properties</caption> |
| <tr> |
| <th>Property name</th> |
| <th>Value type</th> |
| <th>Returned by</th> |
| </tr> |
| <tr> |
| <td><code>"name"</code></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a></td> |
| <td>(none)</td> |
| </tr> |
| <tr> |
| <th colspan="3" class="hsep">Defined in parent class (reminder)</th> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#CODE_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"code"</a></td> |
| <td><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"><code>String</code></a></td> |
| <td><a href="ImmutableIdentifier.html#getCode()"><code>ImmutableIdentifier.getCode()</code></a></td> |
| </tr> |
| <tr> |
| <td>"codespace"</td> |
| <td><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"><code>String</code></a></td> |
| <td><a href="ImmutableIdentifier.html#getCodeSpace()"><code>ImmutableIdentifier.getCodeSpace()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#AUTHORITY_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"authority"</a></td> |
| <td><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"><code>String</code></a> or <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"><code>Citation</code></a></td> |
| <td><a href="ImmutableIdentifier.html#getAuthority()"><code>ImmutableIdentifier.getAuthority()</code></a></td> |
| </tr> |
| <tr> |
| <td>"version"</td> |
| <td><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"><code>String</code></a></td> |
| <td><a href="ImmutableIdentifier.html#getVersion()"><code>ImmutableIdentifier.getVersion()</code></a></td> |
| </tr> |
| <tr> |
| <td>"description"</td> |
| <td><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"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a></td> |
| <td><a href="ImmutableIdentifier.html#getDescription()"><code>ImmutableIdentifier.getDescription()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="AbstractIdentifiedObject.html#LOCALE_KEY">"locale"</a></td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Locale</code></a></td> |
| <td>(none)</td> |
| </tr> |
| </table> |
| |
| The <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#CODE_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"code"</a> property is mandatory and all other properties |
| are optional. If a <code>"name"</code> property is provided, then calls to name-related methods like |
| <a href="#tip()"><code>tip()</code></a>, <a href="#head()"><code>head()</code></a> and <a href="#scope()"><code>scope()</code></a> will delegate to the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - the properties to be given to this identifier.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if a property has an invalid value.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if a property is invalid for some other reason.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.metadata.citation.Citation,java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NamedIdentifier</h4> |
| <pre>public NamedIdentifier​(<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> authority, |
| <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> code)</pre> |
| <div class="block">Constructs an identifier from an authority and code. |
| This is a convenience constructor for commonly-used parameters. |
| |
| <p>If the given code is an <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a>, then the <code>code.toString(Locale.ROOT)</code> |
| return value will be used for the <a href="ImmutableIdentifier.html#getCode()"><code>code</code></a> property, and the complete international |
| string will be used for the <a href="#getName()"><code>name</code></a> property.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - organization or party responsible for definition and maintenance of the code space or code, |
| or <code>null</code> if not available.</dd> |
| <dd><code>code</code> - identifier code or name, optionally from a controlled list or pattern defined by the authority. |
| The code can not be null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.metadata.citation.Citation,java.lang.String,java.lang.CharSequence,java.lang.String,org.opengis.util.InternationalString)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NamedIdentifier</h4> |
| <pre>public NamedIdentifier​(<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> 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> codeSpace, |
| <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> code, |
| <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> version, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> description)</pre> |
| <div class="block">Constructs an identifier from an authority and localizable code, |
| with an optional version number and description. |
| |
| <p>If the given code is an <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a>, then the <code>code.toString(Locale.ROOT)</code> |
| return value will be used for the <a href="ImmutableIdentifier.html#getCode()"><code>code</code></a> property, and the complete international |
| string will be used for the <a href="#getName()"><code>name</code></a> property.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - organization or party responsible for definition and maintenance of the code space or code, |
| or <code>null</code> if not available.</dd> |
| <dd><code>codeSpace</code> - name or identifier of the person or organization responsible for namespace, or <code>null</code> |
| if not available. This is often an abbreviation of the authority name.</dd> |
| <dd><code>code</code> - identifier code or name, optionally from a controlled list or pattern defined by a code space. |
| The code can not be null.</dd> |
| <dd><code>version</code> - the version of the associated code space or code as specified by the code authority, |
| or <code>null</code> if none.</dd> |
| <dd><code>description</code> - natural language description of the meaning of the code value, or <code>null</code> if none.</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.referencing.ReferenceIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <a href="NamedIdentifier.html" title="class in org.apache.sis.referencing">NamedIdentifier</a> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> object)</pre> |
| <div class="block">Returns a SIS identifier 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>NamedIdentifier</code>, then it is returned unchanged.</li> |
| <li>Otherwise a new <code>NamedIdentifier</code> instance is created using the |
| <a href="#%3Cinit%3E(org.opengis.referencing.ReferenceIdentifier)">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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="castOrCopy(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <a href="NamedIdentifier.html" title="class in org.apache.sis.referencing">NamedIdentifier</a> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> object)</pre> |
| <div class="block">Returns a SIS name 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>NamedIdentifier</code>, then it is returned unchanged.</li> |
| <li>Otherwise a new <code>NamedIdentifier</code> instance is created using the |
| <a href="#%3Cinit%3E(org.opengis.util.GenericName)">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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="tip()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tip</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> tip()</pre> |
| <div class="block">The last element in the sequence of <a href="#getParsedNames()">parsed names</a>. |
| By default, this is the same value than the <a href="ImmutableIdentifier.html#getCode()">code</a> provided as a local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#tip()" title="class or interface in org.opengis.util" class="externalLink">tip</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last element in the list of <a href="#getParsedNames()">parsed names</a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ImmutableIdentifier.html#getCode()"><code>ImmutableIdentifier.getCode()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="head()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>head</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> head()</pre> |
| <div class="block">Returns the first element in the sequence of <a href="#getParsedNames()">parsed names</a>. |
| By default, this is the same value than the <a href="ImmutableIdentifier.html#getCodeSpace()">code space</a> provided as a local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#head()" title="class or interface in org.opengis.util" class="externalLink">head</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the first element in the list of <a href="#getParsedNames()">parsed names</a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#scope()"><code>scope()</code></a>, |
| <a href="ImmutableIdentifier.html#getCodeSpace()"><code>ImmutableIdentifier.getCodeSpace()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="scope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scope</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a> scope()</pre> |
| <div class="block">Returns the scope (name space) in which this name is local. |
| By default, this is the same value than the <a href="ImmutableIdentifier.html#getAuthority()"><code>authority</code></a> provided as a name space.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#scope()" title="class or interface in org.opengis.util" class="externalLink">scope</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the scope of this name.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#head()"><code>head()</code></a>, |
| <a href="ImmutableIdentifier.html#getAuthority()"><code>ImmutableIdentifier.getAuthority()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="depth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>depth</h4> |
| <pre class="methodSignature">public int depth()</pre> |
| <div class="block">Returns the depth of this name within the namespace hierarchy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#depth()" title="class or interface in org.opengis.util" class="externalLink">depth</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the depth of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParsedNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParsedNames</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a>> getParsedNames()</pre> |
| <div class="block">Returns the sequence of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">local names</a> making this generic name. |
| The length of this sequence is the <a href="#depth()">depth</a>. |
| It does not include the <a href="#scope()">scope</a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#getParsedNames()" title="class or interface in org.opengis.util" class="externalLink">getParsedNames</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local names making this generic name, without the <a href="#scope()">scope</a>. |
| Shall never be <code>null</code> neither empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="push(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>push</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/ScopedName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">ScopedName</a> push​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> scope)</pre> |
| <div class="block">Returns this name expanded with the specified scope. One may represent this operation |
| as a concatenation of the specified <code>name</code> with <code>this</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#push(org.opengis.util.GenericName)" title="class or interface in org.opengis.util" class="externalLink">push</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - The name to use as prefix.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a concatenation of the given scope with this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toFullyQualifiedName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toFullyQualifiedName</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> toFullyQualifiedName()</pre> |
| <div class="block">Returns a view of this name as a fully-qualified name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toFullyQualifiedName()" title="class or interface in org.opengis.util" class="externalLink">toFullyQualifiedName</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the fully-qualified name (never <code>null</code>).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toInternationalString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toInternationalString</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> toInternationalString()</pre> |
| <div class="block">Returns a local-dependent string representation of this generic name. |
| This string is similar to the one returned by <a href="#toString()"><code>toString()</code></a> except that each element has |
| been localized in the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true#toString(java.util.Locale)" title="class or interface in org.opengis.util" class="externalLink">specified locale</a>. |
| If no international string is available, then this method returns an implementation mapping |
| to <code>toString()</code> for all locales.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toInternationalString()" title="class or interface in org.opengis.util" class="externalLink">toInternationalString</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a localizable string representation of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <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> toString()</pre> |
| <div class="block">Returns a string representation of this generic name. This string representation |
| is local-independent. It contains all elements listed by <a href="#getParsedNames()"><code>getParsedNames()</code></a> |
| separated by a namespace-dependent character (usually <code>:</code> or <code>/</code>).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toString()" title="class or interface in org.opengis.util" class="externalLink">toString</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../io/wkt/FormattableObject.html#toString()">toString</a></code> in class <code><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a local-independent string representation of this generic name.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="IdentifiedObjects.html#toString(org.opengis.metadata.Identifier)"><code>IdentifiedObjects.toString(Identifier)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="compareTo(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre class="methodSignature">public int compareTo​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> object)</pre> |
| <div class="block">Compares this name with the specified object for order. Returns a negative integer, |
| zero, or a positive integer as this name lexicographically precedes, is equal to, |
| or follows the specified object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang" class="externalLink">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare with.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>-1 if this identifier precedes the given object, +1 if it follows it.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<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> object)</pre> |
| <div class="block">Compares this identifier with the specified object for equality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="ImmutableIdentifier.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare with this name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the given object is equal to this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <div class="block">Returns a hash code value for this object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="ImmutableIdentifier.html#hashCode()">hashCode</a></code> in class <code><a href="ImmutableIdentifier.html" title="class in org.apache.sis.referencing">ImmutableIdentifier</a></code></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/NamedIdentifier.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 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: </li> |
| <li>Nested | </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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |