blob: 67a437944febbfc3f2f5590fdf104b5af072aa9b [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>AbstractName (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.util.iso.AbstractName class">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="scope()">
<meta name="keywords" content="depth()">
<meta name="keywords" content="getParsedNames()">
<meta name="keywords" content="head()">
<meta name="keywords" content="tip()">
<meta name="keywords" content="toFullyQualifiedName()">
<meta name="keywords" content="push()">
<meta name="keywords" content="toString()">
<meta name="keywords" content="toInternationalString()">
<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="AbstractName (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractName.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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.util.iso</a></div>
<h2 title="Class AbstractName" class="title">Class AbstractName</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>AbstractName</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>&lt;<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">Generic­Name</a>&gt;</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">Generic­Name</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">Default­Local­Name</a></code>, <code><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso">Default­Scoped­Name</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractName</span>
extends <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>
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>, <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></pre>
<div class="block">Base class for sequence of identifiers rooted within the context of a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">namespace</a>.
Names shall be <em>immutable</em> and thread-safe. A name can be local to a namespace.
See the <a href="package-summary.html">package javadoc</a> for an illustration of name anatomy.
<p>The easiest way to create a name is to use the <a href="Names.html#createLocalName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)"><code>Names​.create­Local­Name(Char­Sequence, String, Char­Sequence)</code></a>
convenience static method. That method supports the common case where the name is made only of a
(<var>namespace</var>, <var>local part</var>) pair of strings. However generic names allows finer grain.
For example the above-cited strings can both be split into smaller name components.
If such finer grain control is desired, <a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso"><code>Default­Name­Factory</code></a> can be used instead of <a href="Names.html" title="class in org.apache.sis.util.iso"><code>Names</code></a>.</p>
<div class="section">Natural ordering</div>
This class has a natural ordering that is inconsistent with <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a>.
See <a href="#compareTo(org.opengis.util.GenericName)"><code>compare­To(Generic­Name)</code></a> for more information.
<div class="section">Note for implementers</div>
Subclasses need only to implement the following methods:
<ul>
<li><a href="#scope()"><code>scope()</code></a></li>
<li><a href="#getParsedNames()"><code>get­Parsed­Names()</code></a></li>
</ul>
Subclasses shall make sure that any overridden methods remain safe to call from multiple threads
and do not change any public <code>Generic­Name</code> state.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../referencing/NamedIdentifier.html" title="class in org.apache.sis.referencing"><code>Named­Identifier</code></a>,
<a href="../../storage/FeatureNaming.html" title="class in org.apache.sis.storage"><code>Feature­Naming</code></a>,
<a href="../../feature/AbstractIdentifiedType.html#getName()"><code>Abstract­Identified­Type​.get­Name()</code></a>,
<a href="../../referencing/AbstractIdentifiedObject.html#getAlias()"><code>Abstract­Identified­Object​.get­Alias()</code></a>,
<a href="../../../../../serialized-form.html#org.apache.sis.util.iso.AbstractName">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">
<!-- ======== 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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractName</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new instance of generic 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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.util.GenericName)">castOrCopy</a></span>&#8203;(<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>&nbsp;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="i1" class="rowColor">
<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>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Compares this name with the specified name for order.</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="#depth()">depth</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicates the number of levels specified by this name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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>&#8203;(<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>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Compares this generic name with the specified object for equality.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <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>&lt;? 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>&gt;</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="DefaultLocalName.html" title="class in org.apache.sis.util.iso">local names</a> making this generic name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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 generic name.</div>
</td>
</tr>
<tr id="i6" 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="#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="i7" class="rowColor">
<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>&#8203;(<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>&nbsp;scope)</code></th>
<td class="colLast">
<div class="block">Returns this name expanded with the specified scope.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <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="i9" 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="#tip()">tip</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the last element in the sequence of <a href="#getParsedNames()">parsed names</a>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<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="i11" class="rowColor">
<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="i12" class="altColor">
<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.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>
</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="blockListLast">
<li class="blockList">
<h4>AbstractName</h4>
<pre>protected&nbsp;AbstractName()</pre>
<div class="block">Creates a new instance of generic name.</div>
</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.util.GenericName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>castOrCopy</h4>
<pre class="methodSignature">public static&nbsp;<a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a>&nbsp;castOrCopy&#8203;(<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>&nbsp;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 an instance 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"><code>Local­Name</code></a>, then this
method delegates to <a href="DefaultLocalName.html#castOrCopy(org.opengis.util.LocalName)"><code>Default­Local­Name​.cast­Or­Copy(Local­Name)</code></a>.</li>
<li>Otherwise if the given object is already an instance of <code>Abstract­Name</code>,
then it is returned unchanged.</li>
<li>Otherwise a new instance of an <code>Abstract­Name</code> subclass is created using the
<a href="DefaultNameFactory.html#createGenericName(org.opengis.util.NameSpace,java.lang.CharSequence...)"><code>Default­Name­Factory​.create­Generic­Name(Name­Space, Char­Sequence[])</code></a> method.</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="scope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scope</h4>
<pre class="methodSignature">public abstract&nbsp;<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>&nbsp;scope()</pre>
<div class="block">Returns the scope (name space) in which this name is local. For example if a
<a href="#toFullyQualifiedName()">fully qualified name</a> is <code>"org​.opengis​.util​.Record"</code>
and if this instance is the <code>"util​.Record"</code> part, then its scope is
<a href="DefaultNameSpace.html#name()">named</a> <code>"org​.opengis"</code>.
<p>Continuing with the above example, the full <code>"org​.opengis​.util​.Record"</code> name has
no scope. If this method is invoked on such name, then the SIS implementation returns a
global scope instance (i.e. an instance for which <a href="DefaultNameSpace.html#isGlobal()"><code>Default­Name­Space​.is­Global()</code></a>
returns <code>true</code>) which is unique and named <code>"global"</code>.</p></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>&nbsp;in interface&nbsp;<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">Generic­Name</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the scope of this name.</dd>
</dl>
</li>
</ul>
<a id="depth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>depth</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;depth()</pre>
<div class="block">Indicates the number of levels specified by this name. The default implementation returns
the size of the list returned by the <a href="#getParsedNames()"><code>get­Parsed­Names()</code></a> method.</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>&nbsp;in interface&nbsp;<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">Generic­Name</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 abstract&nbsp;<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>&lt;? 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>&gt;&nbsp;getParsedNames()</pre>
<div class="block">Returns the sequence of <a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">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">get­Parsed­Names</a></code>&nbsp;in interface&nbsp;<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">Generic­Name</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="head()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>head</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;head()</pre>
<div class="block">Returns the first element in the sequence of <a href="#getParsedNames()">parsed names</a>.
For any <code>Local­Name</code>, this is always <code>this</code>.
<div class="note"><b>Example:</b>
If <code>this</code> name is <code>"org​.opengis​.util​.Record"</code>
(no matter its scope, then this method returns <code>"org"</code>.</div></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>&nbsp;in interface&nbsp;<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">Generic­Name</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>
</dl>
</li>
</ul>
<a id="tip()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tip</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;tip()</pre>
<div class="block">Returns the last element in the sequence of <a href="#getParsedNames()">parsed names</a>.
For any <code>Local­Name</code>, this is always <code>this</code>.
<div class="note"><b>Example:</b>
If <code>this</code> name is <code>"org​.opengis​.util​.Record"</code>
(no matter its scope, then this method returns <code>"Record"</code>.</div></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>&nbsp;in interface&nbsp;<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">Generic­Name</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>
</dl>
</li>
</ul>
<a id="toFullyQualifiedName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toFullyQualifiedName</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;toFullyQualifiedName()</pre>
<div class="block">Returns a view of this name as a fully-qualified name. The <a href="#scope()">scope</a>
of a fully qualified name is <a href="DefaultNameSpace.html#isGlobal()">global</a>.
If the scope of this name is already global, then this method returns <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#toFullyQualifiedName()" title="class or interface in org.opengis.util" class="externalLink">to­Fully­Qualified­Name</a></code>&nbsp;in interface&nbsp;<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">Generic­Name</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="push(org.opengis.util.GenericName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;push&#8203;(<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>&nbsp;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>scope</code> with <code>this</code>. For example if
<code>this</code> name is <code>"util​.Record"</code> and the given <code>scope</code> argument is
<code>"org​.opengis"</code>, then <code>this​.push(scope)</code> shall return
<code>"org​.opengis​.util​.Record"</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>&nbsp;in interface&nbsp;<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">Generic­Name</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="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<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;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>get­Parsed­Names()</code></a>
separated by a namespace-dependent character (usually <code>':'</code> or <code>'/'</code>).
This rule implies that the result may or may not be fully qualified.
Special cases:
<ul>
<li><code><a href="#toFullyQualifiedName()">to­Fully­Qualified­Name()</a>.to­String()</code> is guaranteed to
contain the <a href="#scope()">scope</a> (if any).</li>
<li><code><a href="#tip()">tip()</a>.to­String()</code> is guaranteed to not contain
any scope.</li>
</ul></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">to­String</a></code>&nbsp;in interface&nbsp;<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">Generic­Name</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">to­String</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a local-independent string representation of this name.</dd>
</dl>
</li>
</ul>
<a id="toInternationalString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toInternationalString</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;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>to­String()</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 <a href="#toString()"><code>to­String()</code></a> 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">to­International­String</a></code>&nbsp;in interface&nbsp;<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">Generic­Name</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a localizable string representation of this name.</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&nbsp;int&nbsp;compareTo&#8203;(<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>&nbsp;name)</pre>
<div class="block">Compares this name with the specified name for order. Returns a negative integer,
zero, or a positive integer as this name lexicographically precedes, is equal to,
or follows the specified name. The comparison is performed in the following way:
<ul>
<li>For each element of the <a href="#getParsedNames()">list of parsed names</a> taken
in iteration order, compare the <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"><code>Local­Name</code></a>. If a name lexicographically
precedes or follows the corresponding element of the specified name, returns
a negative or a positive integer respectively.</li>
<li>If all elements in both names are lexicographically equal, then if this name has less
or more elements than the specified name, returns a negative or a positive integer
respectively.</li>
<li>Otherwise, returns 0.</li>
</ul></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">compare­To</a></code>&nbsp;in interface&nbsp;<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>&lt;<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">Generic­Name</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the other name to compare with this name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>-1 if this name precedes the given one, +1 if it follows, 0 if equals.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<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>&nbsp;object)</pre>
<div class="block">Compares this generic name with the specified object for equality.
The default implementation returns <code>true</code> if the <a href="#scope()">scopes</a>
and the lists of <a href="#getParsedNames()">parsed names</a> are equal.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the object to compare with this name for equality.</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&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code value for this generic name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hash­Code</a></code>&nbsp;in class&nbsp;<code><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></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/AbstractName.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>