| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>Names (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.util.iso, class: Names"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.iso.Names class"> |
| <meta name="keywords" content="parseGenericName()"> |
| <meta name="keywords" content="createGenericName()"> |
| <meta name="keywords" content="createScopedName()"> |
| <meta name="keywords" content="createLocalName()"> |
| <meta name="keywords" content="createTypeName()"> |
| <meta name="keywords" content="createMemberName()"> |
| <meta name="keywords" content="toClass()"> |
| <meta name="keywords" content="toExpandedString()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.metadata</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util.iso</a></div> |
| <h1 title="Class Names" class="title">Class Names</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Static.html" title="class in org.apache.sis.util">Static</a> |
| <div class="inheritance">Names</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Names</span> |
| <span class="extends-implements">extends <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Static.html" title="class in org.apache.sis.util">Static</a></span></div> |
| <div class="block">Static methods for creating, parsing and formatting <a href="AbstractName.html" title="class in org.apache.sis.util.iso">generic names</a>. |
| This convenience class does not add new functionality compared to <a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso"><code>DefaultNameFactory</code></a>, |
| but makes some tasks easier by avoiding the need to find a factory, and by creating name and |
| their namespace in a single step. |
| |
| <h2 id="relationship-with-java-content-repository-jcr-names-heading">Relationship with Java Content Repository (JCR) names</h2> |
| In the Java standard <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/javax/xml/namespace/QName.html" title="class or interface in javax.xml.namespace" class="external-link"><code>QName</code></a> class and in the Java Content Repository (JCR) specification, |
| a name is an ordered pair of (<code>namespace</code>, <code>localPart</code>) strings. A JCR name can take two lexical forms: |
| <cite>expanded form</cite> and <cite>qualified form</cite>. Those names are mapped to generic names as below: |
| |
| <blockquote><table class="sis" style="white-space: nowrap"> |
| <caption>Equivalence between JCR name and <code>GenericName</code></caption> |
| <tr> |
| <th>JCR name</th> |
| <th class="sep" colspan="2">GeoAPI equivalence</th> |
| </tr><tr> |
| <td><code>ExpandedName ::= '{' Namespace '}' LocalPart</code></td> |
| <td class="sep"><code>GenericName.<a href="AbstractName.html#scope()">scope()</a>.name().toString()</code></td> |
| <td>= JCR <code>Namespace</code></td> |
| </tr><tr> |
| <td></td> |
| <td class="sep"><code>GenericName.<a href="AbstractName.html#toString()">toString()</a></code></td> |
| <td>= JCR <code>LocalPart</code></td> |
| </tr><tr> |
| <td class="hsep"><code>QualifiedName ::= [Prefix ':'] LocalPart</code></td> |
| <td class="hsep sep"><code>ScopedName.<a href="AbstractName.html#scope()">scope()</a></code></td> |
| <td class="hsep">= <a href="DefaultNameSpace.html#isGlobal()">global namespace</a></td> |
| </tr><tr> |
| <td></td> |
| <td class="sep"><code>ScopedName.<a href="AbstractName.html#head()">head()</a>.toString()</code></td> |
| <td>= JCR <code>Prefix</code></td> |
| </tr><tr> |
| <td></td> |
| <td class="sep"><code>ScopedName.<a href="DefaultScopedName.html#tail()">tail()</a>.toString()</code></td> |
| <td>= JCR <code>LocalPart</code></td> |
| </tr> |
| </table></blockquote></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso"><code>DefaultNameFactory</code></a></li> |
| <li><a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso"><code>DefaultNameSpace</code></a></li> |
| <li><a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso"><code>DefaultScopedName</code></a></li> |
| <li><a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso"><code>DefaultLocalName</code></a></li> |
| <li><a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a></li> |
| <li><a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso"><code>DefaultMemberName</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createGenericName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence...)" class="member-name-link">createGenericName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>... parsedNames)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a local or scoped name from an array of parsed names.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/LocalName.html" title="class or interface in org.opengis.util" class="external-link">LocalName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createLocalName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)" class="member-name-link">createLocalName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a name which is local in the given namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createMemberName(java.lang.CharSequence,java.lang.String,int)" class="member-name-link">createMemberName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| int localPart)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a member name for the given sequence number.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)" class="member-name-link">createMemberName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> valueClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a member name for values of the given class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,org.opengis.util.TypeName)" class="member-name-link">createMemberName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a> attributeType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a member name for attribute values of the given type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/ScopedName.html" title="class or interface in org.opengis.util" class="external-link">ScopedName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScopedName(org.opengis.util.GenericName,java.lang.String,java.lang.CharSequence)" class="member-name-link">createScopedName</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a> scope, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a scoped name as the concatenation of the given generic name with a single character sequence.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTypeName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)" class="member-name-link">createTypeName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a type name from the given character sequence and automatically inferred Java type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTypeName(java.lang.Class)" class="member-name-link">createTypeName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> valueClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a type name for the given class using naming convention documented in <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#parseGenericName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)" class="member-name-link">parseGenericName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> scopedName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a local or scoped name in the given namespace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr><?></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toClass(org.opengis.util.TypeName)" class="member-name-link">toClass</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Java class associated to the given type name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toExpandedString(org.opengis.util.GenericName)" class="member-name-link">toExpandedString</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Formats the given name in <cite>expanded form</cite> close to the Java Content Repository (JCR) definition.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="parseGenericName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)"> |
| <h3>parseGenericName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a></span> <span class="element-name">parseGenericName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> scopedName)</span></div> |
| <div class="block">Creates a local or scoped name in the given namespace. |
| The character sequences can be either <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> instances. |
| The <code>namespace</code> character sequences is taken verbatim, while <code>scopedName</code> is splitted |
| around the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>, which is <code>":"</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the generic name, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>scopedName</code> - the name to parse using <code>':'</code> as the separator between components.</dd> |
| <dt>Returns:</dt> |
| <dd>a local or scoped name in the given namespace.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="DefaultNameFactory.html#parseGenericName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.parseGenericName(NameSpace, CharSequence)</code></a></li> |
| </ul> |
| </dd> |
| <dt>"TODO:"</dt> |
| <dd>Bug in current implementation: the <code>separator</code> argument is ignored if <code>namespace</code> is null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createGenericName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence...)"> |
| <h3>createGenericName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a></span> <span class="element-name">createGenericName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>... parsedNames)</span></div> |
| <div class="block">Creates a local or scoped name from an array of parsed names. This method returns a local name if the |
| length of the <code>parsedNames</code> array is 1, or a scoped named if the length of the array is 2 or more. |
| The first <code>parsedNames</code> element will be the <a href="AbstractName.html#head()">head</a> |
| and the last <code>parsedNames</code> element will be the <a href="AbstractName.html#tip()"><code>tip</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the generic name, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>parsedNames</code> - the local names as an array of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> instances. |
| This array shall contain at least one element.</dd> |
| <dt>Returns:</dt> |
| <dd>the generic name for the given parsed names.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createScopedName(org.opengis.util.GenericName,java.lang.String,java.lang.CharSequence)"> |
| <h3>createScopedName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/ScopedName.html" title="class or interface in org.opengis.util" class="external-link">ScopedName</a></span> <span class="element-name">createScopedName</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a> scope, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> name)</span></div> |
| <div class="block">Creates a scoped name as the concatenation of the given generic name with a single character sequence. |
| The scope of the new name will be the scope of the <code>path</code> argument. |
| The tail is a local name created from the given character sequence.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scope</code> - the first part to concatenate.</dd> |
| <dd><code>separator</code> - the separator between the head and the tail, |
| or <code>null</code> for inheriting the same separator than the given scope.</dd> |
| <dd><code>name</code> - the second part to concatenate.</dd> |
| <dt>Returns:</dt> |
| <dd>a scoped name in the given namespace.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLocalName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)"> |
| <h3>createLocalName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/LocalName.html" title="class or interface in org.opengis.util" class="external-link">LocalName</a></span> <span class="element-name">createLocalName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart)</span></div> |
| <div class="block">Creates a name which is local in the given namespace. |
| The character sequences can be either <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> instances. |
| Those character sequences are taken verbatim; they are <em>not</em> parsed into their components. |
| |
| <div class="note"><b>Note:</b> it is possible to split the <code>namespace</code> and <code>localPart</code> |
| strings into smaller name components (e.g. namespaces contained in other namespaces). If such finer |
| grain control is desired, one can use <a href="DefaultNameFactory.html" title="class in org.apache.sis.util.iso"><code>DefaultNameFactory</code></a> instead of this <code>Names</code> class.</div> |
| |
| The following table shows where the strings given in argument will go: |
| |
| <blockquote><table class="sis"> |
| <caption>Mapping from arguments to name components</caption> |
| <tr><th>Argument</th> <th>Mapped to</th></tr> |
| <tr><td><code>namespace</code></td> <td><code>name.<a href="DefaultLocalName.html#scope()">scope()</a>.name().toString()</code></td></tr> |
| <tr><td><code>localPart</code></td> <td><code>name.<a href="DefaultLocalName.html#toString()">toString()</a></code></td></tr> |
| </table></blockquote> |
| |
| <h4 id="example-heading">Example</h4> |
| For a name created by <code>createLocalName("http://www.opengis.net/gml/srs/epsg.xml", "#", "4326")</code>: |
| <ul> |
| <li><code>name.<a href="DefaultLocalName.html#toString()">toString()</a></code> |
| returns the <code>"4326"</code> string.</li> |
| <li><code>name.<a href="DefaultLocalName.html#scope()">scope()</a></code> |
| returns the <code>"http://www.opengis.net/gml/srs/epsg.xml"</code> namespace.</li> |
| <li><code>name.<a href="AbstractName.html#toFullyQualifiedName()">toFullyQualifiedName()</a></code> |
| returns the <code>"http://www.opengis.net/gml/srs/epsg.xml#4326"</code> name.</li> |
| <li><code><a href="#toExpandedString(org.opengis.util.GenericName)">toExpandedString</a>(name)</code> |
| returns the <code>"{http://www.opengis.net/gml/srs/epsg.xml}4326"</code> string.</li> |
| </ul> |
| |
| <h4 id="performance-note-heading">Performance note</h4> |
| This method is okay for <em>casual</em> use. |
| If many names need to be created in the same namespace, |
| then <a href="DefaultNameFactory.html#createLocalName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.createLocalName(NameSpace, CharSequence)</code></a> |
| is more efficient since it allows to create the <code>NameSpace</code> object only once.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the local part, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>localPart</code> - the name which is locale in the given namespace.</dd> |
| <dt>Returns:</dt> |
| <dd>a local name in the given namespace.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="DefaultNameFactory.html#createLocalName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.createLocalName(NameSpace, CharSequence)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTypeName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence)"> |
| <h3>createTypeName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></span> <span class="element-name">createTypeName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart)</span></div> |
| <div class="block">Creates a type name from the given character sequence and automatically inferred Java type. |
| The character sequences can be either <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> instances. |
| Those character sequences are taken verbatim; they are <em>not</em> parsed into their components. |
| |
| <h4 id="example-heading1">Example</h4> |
| <code>createTypeName("gco", ":", "Integer")</code> returns a name |
| which can be used for representing the type of <code><gco:Integer></code> elements in XML files. |
| |
| <h4 id="performance-note-heading1">Performance note</h4> |
| This method is okay for <em>casual</em> use. |
| If many names need to be created in the same namespace, |
| then <a href="DefaultNameFactory.html#createTypeName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.createTypeName(NameSpace, CharSequence)</code></a> |
| is more efficient since it allows to create the <code>NameSpace</code> object only once.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the local part, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>localPart</code> - the name which is locale in the given namespace.</dd> |
| <dt>Returns:</dt> |
| <dd>a type name in the given namespace.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="DefaultNameFactory.html#createTypeName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.createTypeName(NameSpace, CharSequence)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTypeName(java.lang.Class)"> |
| <h3>createTypeName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></span> <span class="element-name">createTypeName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> valueClass)</span></div> |
| <div class="block">Creates a type name for the given class using naming convention documented in <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a>. |
| This method is a shortcut for <a href="DefaultNameFactory.html#toTypeName(java.lang.Class)"><code>DefaultNameFactory.toTypeName(Class)</code></a> |
| and is the converse of <a href="#toClass(org.opengis.util.TypeName)"><code>toClass(TypeName)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueClass</code> - the type of values for which to infer a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link"><code>TypeName</code></a> instance.</dd> |
| <dt>Returns:</dt> |
| <dd>a type name for values of the given type.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)"><code>createMemberName(CharSequence, String, CharSequence, Class)</code></a></li> |
| <li><a href="DefaultNameFactory.html#toTypeName(java.lang.Class)"><code>DefaultNameFactory.toTypeName(Class)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)"> |
| <h3>createMemberName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></span> <span class="element-name">createMemberName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> valueClass)</span></div> |
| <div class="block">Creates a member name for values of the given class. A <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link"><code>TypeName</code></a> will be inferred |
| from the given <code>valueClass</code> as documented in the <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> javadoc. |
| |
| <h4 id="performance-note-heading2">Performance note</h4> |
| This method is okay for <em>casual</em> use. If many names need to be created, |
| then <a href="DefaultNameFactory.html#createMemberName(org.opengis.util.NameSpace,java.lang.CharSequence,org.opengis.util.TypeName)"><code>DefaultNameFactory.createMemberName(NameSpace, CharSequence, TypeName)</code></a> |
| is more efficient since it allows to create the <code>NameSpace</code> and <code>TypeName</code> objects only once.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the local part, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>localPart</code> - the name which is locale in the given namespace.</dd> |
| <dd><code>valueClass</code> - the type of values, used for inferring a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link"><code>TypeName</code></a> instance.</dd> |
| <dt>Returns:</dt> |
| <dd>a member name in the given namespace for values of the given type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,org.opengis.util.TypeName)"> |
| <h3>createMemberName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></span> <span class="element-name">createMemberName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> localPart, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a> attributeType)</span></div> |
| <div class="block">Creates a member name for attribute values of the given type. |
| This is a shortcut for <a href="DefaultNameFactory.html#createMemberName(org.opengis.util.NameSpace,java.lang.CharSequence,org.opengis.util.TypeName)"><code>DefaultNameFactory.createMemberName(NameSpace, CharSequence, TypeName)</code></a>. |
| See <a href="#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)">performance note</a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the local part, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>localPart</code> - the name which is locale in the given namespace.</dd> |
| <dd><code>attributeType</code> - the type of the data associated with the member.</dd> |
| <dt>Returns:</dt> |
| <dd>a member name in the given namespace for values of the given type.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMemberName(java.lang.CharSequence,java.lang.String,int)"> |
| <h3>createMemberName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></span> <span class="element-name">createMemberName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> namespace, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| int localPart)</span></div> |
| <div class="block">Creates a member name for the given sequence number. The member type will be <code>"OGC:Integer"</code>. |
| This method can be used for <a href="../../metadata/iso/content/DefaultRangeDimension.html#setSequenceIdentifier(org.opengis.util.MemberName)">setting band identifier in metadata</a> in the common case where band identifier are just numbers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - the namespace, or <code>null</code> for the global namespace.</dd> |
| <dd><code>separator</code> - the separator between the namespace and the local part, or <code>null</code> |
| for the <a href="DefaultNameSpace.html#DEFAULT_SEPARATOR">default separator</a>.</dd> |
| <dd><code>localPart</code> - the sequence number to use as local part.</dd> |
| <dt>Returns:</dt> |
| <dd>a member name in the given namespace with the given sequence number.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeDimension.html#getSequenceIdentifier()" title="class or interface in org.opengis.metadata.content" class="external-link"><code>RangeDimension.getSequenceIdentifier()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toClass(org.opengis.util.TypeName)"> |
| <h3>toClass</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?></span> <span class="element-name">toClass</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a> type)</span> |
| throws <span class="exceptions"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnknownNameException.html" title="class in org.apache.sis.util">UnknownNameException</a></span></div> |
| <div class="block">Returns the Java class associated to the given type name. |
| The method performs the following choices: |
| |
| <ul> |
| <li>If the given type name is <code>null</code>, then this method returns <code>null</code>.</li> |
| <li>Else if the value returned by <a href="DefaultTypeName.html#toJavaType()"><code>DefaultTypeName.toJavaType()</code></a> is a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a>, returns that class.</li> |
| <li>Else if the type name <a href="DefaultLocalName.html#scope()">scope</a> is <code>"OGC"</code>, then: |
| <ul> |
| <li>If the name is <code>"CharacterString"</code>, <code>"Integer"</code>, <code>"Real"</code> or other recognized names |
| (see <a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> javadoc), then the corresponding class is returned.</li> |
| <li>Otherwise <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnknownNameException.html" title="class in org.apache.sis.util"><code>UnknownNameException</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/en/java/javase/11/docs/api/java.base/java/lang/Class.html#forName(java.lang.String)" title="class or interface in java.lang" class="external-link"><code>Class.forName(String)</code></a>, then that class is returned.</li> |
| <li>Otherwise <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnknownNameException.html" title="class in org.apache.sis.util"><code>UnknownNameException</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; this method cannot be sure that the given name was wrong.</li> |
| </ul> |
| </li> |
| <li>Otherwise <code>null</code> is returned, |
| because this method cannot check the validity of names in other namespaces.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the type name from which to infer a Java class.</dd> |
| <dt>Returns:</dt> |
| <dd>the Java class associated to the given <code>TypeName</code>, |
| or <code>null</code> if there is no mapping from the given name to a Java class.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnknownNameException.html" title="class in org.apache.sis.util">UnknownNameException</a></code> - if a mapping from the given name to a Java class was expected to exist |
| (typically because of the <a href="DefaultLocalName.html#scope()">scope</a>) but the lookup failed.</dd> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#createTypeName(java.lang.Class)"><code>createTypeName(Class)</code></a></li> |
| <li><a href="DefaultTypeName.html#toJavaType()"><code>DefaultTypeName.toJavaType()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toExpandedString(org.opengis.util.GenericName)"> |
| <h3>toExpandedString</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toExpandedString</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a> name)</span></div> |
| <div class="block">Formats the given name in <cite>expanded form</cite> close to the Java Content Repository (JCR) definition. |
| The expanded form is defined as below: |
| |
| <blockquote><pre> ExpandedName ::= '{' NameSpace '}' LocalPart |
| NameSpace ::= name.<a href="AbstractName.html#scope()">scope()</a>.<a href="DefaultNameSpace.html#name()">name()</a>.toString() |
| LocalPart ::= name.<a href="AbstractName.html#toString()">toString()</a></pre></blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the generic name to format in expanded form, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>expanded form of the given generic name, or <code>null</code> if the given name was null.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="DefaultNameSpace.html#toString()"><code>DefaultNameSpace.toString()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |