Google Git
Sign in
apache / sis-site / 3eac6c6ff79f5984196de5b19972dbd5b7f38c79 / . / static / apidocs / org / apache / sis / util / iso / DefaultTypeName.html
blob: 194658cfec3b4d3a8d607605b1ebed5c5c80d4a9 [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>DefaultTypeName (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.DefaultTypeName class">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="toClass()">
<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="DefaultTypeName (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":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/DefaultTypeName.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 DefaultTypeName" class="title">Class DefaultTypeName</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="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></li>
<li>
<ul class="inheritance">
<li><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a></li>
<li>
<ul class="inheritance">
<li>DefaultTypeName</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>&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>, <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">Local­Name</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/TypeName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">Type­Name</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DefaultTypeName</span>
extends <a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a>
implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/TypeName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">TypeName</a></pre>
<div class="block">The name of an attribute type associated to a <a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso">member name</a>.
<code>Default­Type­Name</code> can be instantiated by any of the following methods:
<ul>
<li><a href="DefaultNameFactory.html#createTypeName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>Default­Name­Factory​.create­Type­Name(Name­Space, Char­Sequence)</code></a></li>
<li><a href="DefaultNameFactory.html#toTypeName(java.lang.Class)"><code>Default­Name­Factory​.to­Type­Name(Class)</code></a></li>
</ul>
<div class="section">Mapping Java classes to type names</div>
It is sometime useful to establish a mapping between <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Class</code></a> and <code>Type­Name</code>.
When an UML identifier from an OGC standard exists for a given <code>Class</code>, Apache SIS
uses that identifier prefixed by the <code>"OGC"</code> namespace.
Note that this is <strong>not</strong> a standard practice.
A more standard practice would be to use the <cite>definition identifiers in OGC namespace</cite>
(third column in the table below), but the set of data type identifiers defined by OGC is currently
small and is sometime not an exact match.
<table class="sis">
<caption>Mapping from Java classes to type names (non-exhaustive list)</caption>
<tr>
<th>Java class</th>
<th>Type name (unofficial)</th>
<th>Definition identifier in OGC namespace</th>
<th>Recommended URL in Web Processing Services</th>
</tr><tr>
<td><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><code>OGC:FreeText</code></td>
<td></td>
<td></td>
</tr><tr>
<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><code>OGC:CharacterString</code></td>
<td><code>urn:ogc:def:dataType:OGC::string</code></td>
<td><code>http://www.w3.org/2001/XMLSchema#string</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a></td>
<td><code>OGC:URI</code></td>
<td><code>urn:ogc:def:dataType:OGC::anyURI</code></td>
<td></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a></td>
<td><code>OGC:Boolean</code></td>
<td><code>urn:ogc:def:dataType:OGC::boolean</code></td>
<td><code>http://www.w3.org/2001/XMLSchema#boolean</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Integer</code></a></td>
<td><code>OGC:Integer</code></td>
<td><code>urn:ogc:def:dataType:OGC::nonNegativeInteger</code></td>
<td><code>http://www.w3.org/2001/XMLSchema#integer</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math" class="externalLink"><code>BigDecimal</code></a></td>
<td><code>OGC:Decimal</code></td>
<td></td>
<td><code>http://www.w3.org/2001/XMLSchema#decimal</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a></td>
<td><code>OGC:Real</code></td>
<td></td>
<td><code>http://www.w3.org/2001/XMLSchema#double</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Float</code></a></td>
<td><code>OGC:Real</code></td>
<td></td>
<td><code>http://www.w3.org/2001/XMLSchema#float</code></td>
</tr><tr>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Date</code></a></td>
<td><code>OGC:DateTime</code></td>
<td></td>
<td></td>
</tr><tr>
<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><code>OGC:PT_Locale</code></td>
<td></td>
<td></td>
</tr><tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Metadata.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink"><code>Metadata</code></a></td>
<td><code>OGC:MD_Metadata</code></td>
<td></td>
<td></td>
</tr><tr>
<td>Unknown Java class</td>
<td><code>class:</code>&lt;the class name&gt;</td>
<td></td>
<td></td>
</tr>
</table>
The mapping defined by Apache SIS may change in any future version depending on standardization progress.
To protect against such changes, users are encouraged to rely on methods or constructors like
<a href="DefaultNameFactory.html#toTypeName(java.lang.Class)"><code>Default­Name­Factory​.to­Type­Name(Class)</code></a> or <a href="#toClass()"><code>to­Class()</code></a> instead than parsing the name.
<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/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>Name­Space</code></a> and <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"><code>Char­Sequence</code></a>
arguments given to the constructor are also immutable. Subclasses shall make sure that any overridden methods
remain safe to call from multiple threads and do not change any public <code>Type­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="DefaultMemberName.html" title="class in org.apache.sis.util.iso"><code>Default­Member­Name</code></a>,
<a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso"><code>Default­Name­Factory</code></a>,
<a href="../../../../../serialized-form.html#org.apache.sis.util.iso.DefaultTypeName">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(org.opengis.util.NameSpace,java.lang.CharSequence)">DefaultTypeName</a></span>&#8203;(<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,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Constructs a type name from the given character sequence.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso">DefaultTypeName</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.util.TypeName)">castOrCopy</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/TypeName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">TypeName</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Returns a SIS type name implementation with the values of the given arbitrary implementation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toClass()">toClass</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the Java class associated to this type name.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.DefaultLocalName">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a></h3>
<code><a href="DefaultLocalName.html#castOrCopy(org.opengis.util.LocalName)">cast­Or­Copy</a>, <a href="DefaultLocalName.html#compareTo(org.opengis.util.GenericName)">compare­To</a>, <a href="DefaultLocalName.html#depth()">depth</a>, <a href="DefaultLocalName.html#equals(java.lang.Object)">equals</a>, <a href="DefaultLocalName.html#getParsedNames()">get­Parsed­Names</a>, <a href="DefaultLocalName.html#head()">head</a>, <a href="DefaultLocalName.html#scope()">scope</a>, <a href="DefaultLocalName.html#tip()">tip</a>, <a href="DefaultLocalName.html#toInternationalString()">to­International­String</a>, <a href="DefaultLocalName.html#toString()">to­String</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractName">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></h3>
<code><a href="AbstractName.html#castOrCopy(org.opengis.util.GenericName)">cast­Or­Copy</a>, <a href="AbstractName.html#hashCode()">hash­Code</a>, <a href="AbstractName.html#push(org.opengis.util.GenericName)">push</a>, <a href="AbstractName.html#toFullyQualifiedName()">to­Fully­Qualified­Name</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;<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></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.GenericName">
<!-- -->
</a>
<h3>Methods inherited from interface&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></h3>
<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>, <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>, <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>, <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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.LocalName">
<!-- -->
</a>
<h3>Methods inherited from interface&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></h3>
<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#depth()" title="class or interface in org.opengis.util" class="externalLink">depth</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#getParsedNames()" title="class or interface in org.opengis.util" class="externalLink">get­Parsed­Names</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#head()" title="class or interface in org.opengis.util" class="externalLink">head</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#tip()" title="class or interface in org.opengis.util" class="externalLink">tip</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#toString()" title="class or interface in org.opengis.util" class="externalLink">to­String</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;(org.opengis.util.NameSpace,java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultTypeName</h4>
<pre>protected&nbsp;DefaultTypeName&#8203;(<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,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;name)</pre>
<div class="block">Constructs a type name from the given character sequence. The argument are given unchanged to the
<a href="DefaultLocalName.html#%3Cinit%3E(org.opengis.util.NameSpace,java.lang.CharSequence)">super-class constructor</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scope</code> - the scope of this name, or <code>null</code> for a global scope.</dd>
<dd><code>name</code> - the local name (never <code>null</code>).</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultNameFactory.html#createTypeName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>Default­Name­Factory​.create­Type­Name(Name­Space, Char­Sequence)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="castOrCopy(org.opengis.util.TypeName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>castOrCopy</h4>
<pre class="methodSignature">public static&nbsp;<a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso">DefaultTypeName</a>&nbsp;castOrCopy&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/TypeName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">TypeName</a>&nbsp;object)</pre>
<div class="block">Returns a SIS type 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>Default­Type­Name</code>,
then it is returned unchanged.</li>
<li>Otherwise a new <code>Default­Type­Name</code> instance is created
with the same values than the given name.</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>0.5</dd>
</dl>
</li>
</ul>
<a id="toClass()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toClass</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;toClass()
throws <a href="../UnknownNameException.html" title="class in org.apache.sis.util">UnknownNameException</a></pre>
<div class="block">Returns the Java class associated to this type name.
The default implementation parses this name in different ways depending on the <a href="DefaultLocalName.html#scope()">scope</a>:
<ul>
<li>If the scope is <code>"OGC"</code>, then:
<ul>
<li>If the name is <code>"Character­String"</code>, <code>"Integer"</code>, <code>"Real"</code> or other recognized names
(see <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso">class javadoc</a>), then the corresponding class is returned.</li>
<li>Otherwise <a href="../UnknownNameException.html" title="class in org.apache.sis.util"><code>Unknown­Name­Exception</code></a> is thrown.</li>
</ul>
</li>
<li>Else if the scope is <code>"class"</code>, then:
<ul>
<li>If the name is accepted by <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#forName(java.lang.String)" title="class or interface in java.lang" class="externalLink"><code>Class​.for­Name(String)</code></a>, then that class is returned.</li>
<li>Otherwise <a href="../UnknownNameException.html" title="class in org.apache.sis.util"><code>Unknown­Name­Exception</code></a> is thrown.</li>
</ul>
</li>
<li>Else if the scope <a href="DefaultNameSpace.html#isGlobal()">is global</a>, then:
<ul>
<li>If the name is one of the names recognized in <code>"OGC"</code> scope (see above),
then the corresponding class is returned.</li>
<li>Otherwise <code>null</code> is returned. No exception is thrown because names in the global namespace
could be anything, so we can not be sure that the given name was wrong.</li>
</ul>
</li>
<li>Otherwise <code>null</code> is returned, since this method can not check the validity of names in other
namespaces.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Java class associated to this <code>Type­Name</code>,
or <code>null</code> if there is no mapping from this name to a Java class.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../UnknownNameException.html" title="class in org.apache.sis.util">Unknown­Name­Exception</a></code> - if a mapping from this name to a Java class was expected to exist
(typically because of the <a href="DefaultLocalName.html#scope()">scope</a>) but the operation failed.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Names.html#toClass(org.opengis.util.TypeName)"><code>Names​.to­Class(Type­Name)</code></a>,
<a href="DefaultNameFactory.html#toTypeName(java.lang.Class)"><code>Default­Name­Factory​.to­Type­Name(Class)</code></a></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/DefaultTypeName.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>