| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Types (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.Types class"> |
| <meta name="keywords" content="getStandardName()"> |
| <meta name="keywords" content="getListName()"> |
| <meta name="keywords" content="getCodeName()"> |
| <meta name="keywords" content="getCodeLabel()"> |
| <meta name="keywords" content="getCodeTitle()"> |
| <meta name="keywords" content="getDescription()"> |
| <meta name="keywords" content="getCodeValues()"> |
| <meta name="keywords" content="forStandardName()"> |
| <meta name="keywords" content="forEnumName()"> |
| <meta name="keywords" content="forCodeName()"> |
| <meta name="keywords" content="forCodeTitle()"> |
| <meta name="keywords" content="toInternationalString()"> |
| <meta name="keywords" content="toInternationalStrings()"> |
| <meta name="keywords" content="toString()"> |
| <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="Types (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Types.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.util.iso</a></div> |
| <h2 title="Class Types" class="title">Class Types</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="../Static.html" title="class in org.apache.sis.util">Static</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>Types</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">Types</span> |
| extends <a href="../Static.html" title="class in org.apache.sis.util">Static</a></pre> |
| <div class="block">Static methods working on GeoAPI types and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList</code></a> values. |
| This class provides: |
| |
| <ul> |
| <li>Methods for fetching the ISO name or description of a code list:<ul> |
| <li><a href="#getStandardName(java.lang.Class)"><code>getStandardName(Class)</code></a> for ISO name</li> |
| <li><a href="#getListName(org.opengis.util.CodeList)"><code>getListName(CodeList)</code></a> for ISO name</li> |
| <li><a href="#getDescription(java.lang.Class)"><code>getDescription(Class)</code></a> for a description</li> |
| </ul></li> |
| <li>Methods for fetching the ISO name or description of a code value:<ul> |
| <li><a href="#getCodeName(org.opengis.util.CodeList)"><code>getCodeName(CodeList)</code></a> for ISO name,</li> |
| <li><a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a> for a label or title</li> |
| <li><a href="#getDescription(org.opengis.util.CodeList)"><code>getDescription(CodeList)</code></a> for a more verbose description</li> |
| </ul></li> |
| <li>Methods for fetching an instance from a name (converse of above <code>get</code> methods):<ul> |
| <li><a href="#forCodeName(java.lang.Class,java.lang.String,boolean)"><code>forCodeName(Class, String, boolean)</code></a></li> |
| <li><a href="#forEnumName(java.lang.Class,java.lang.String)"><code>forEnumName(Class, String)</code></a></li> |
| </ul></li> |
| </ul> |
| |
| <div class="section">Substituting a free text by a code list</div> |
| The ISO standard allows to substitute some character strings in the <cite>"free text"</cite> domain |
| by a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList</code></a> value. |
| |
| <div class="note"><b>Example:</b> |
| in the following XML fragment, the <code><mac:type></code> value is normally a <code><gco:CharacterString></code> |
| but has been replaced by a <code>SensorType</code> code below: |
| |
| <blockquote><pre><mac:MI_Instrument> |
| <mac:type> |
| <gmi:MI_SensorTypeCode |
| codeList="http://standards.iso.org/…snip…/codelists.xml#CI_SensorTypeCode" |
| codeListValue="RADIOMETER">Radiometer</gmi:MI_SensorTypeCode> |
| </mac:type> |
| </mac:MI_Instrument></pre></blockquote> |
| </div> |
| |
| Such substitution can be done with: |
| |
| <ul> |
| <li><a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a> for getting the <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> instance |
| to store in a metadata property.</li> |
| <li><a href="#forCodeTitle(java.lang.CharSequence)"><code>forCodeTitle(CharSequence)</code></a> for retrieving the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList</code></a> previously stored as an |
| <code>InternationalString</code>.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</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"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><T>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forCodeName(java.lang.Class,java.lang.String,boolean)">forCodeName</a></span>​(<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><T> codeType, |
| <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> name, |
| boolean canCreate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the code of the given type that matches the given name, or optionally returns a new one if none |
| match the name.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forCodeTitle(java.lang.CharSequence)">forCodeTitle</a></span>​(<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> title)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the code list or enumeration value for the given title, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a><T>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEnumName(java.lang.Class,java.lang.String)">forEnumName</a></span>​(<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><T> enumType, |
| <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> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enumeration value of the given type that matches the given name, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <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><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forStandardName(java.lang.String)">forStandardName</a></span>​(<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> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Java type (usually a GeoAPI interface) for the given ISO name, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <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="#getCodeLabel(org.opengis.util.CodeList)">getCodeLabel</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a unlocalized title for the given enumeration or code list value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <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="#getCodeName(org.opengis.util.CodeList)">getCodeName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ISO name (if available) or the Java name (as a fallback) of the given enumeration or code list |
| value.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <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="#getCodeTitle(org.opengis.util.CodeList)">getCodeTitle</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the title of the given enumeration or code list value.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <T extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?>><br>T[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCodeValues(java.lang.Class)">getCodeValues</a></span>​(<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><T> codeType)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all known values for the given type of code list.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <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="#getDescription(java.lang.Class)">getDescription</a></span>​(<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><?> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a description for the given class, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <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="#getDescription(java.lang.Class,java.lang.String)">getDescription</a></span>​(<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><?> type, |
| <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> property)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a description for the given property, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <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="#getDescription(org.opengis.util.CodeList)">getDescription</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the description of the given enumeration or code list value, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <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="#getListName(org.opengis.util.CodeList)">getListName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ISO classname (if available) or the Java classname (as a fallback) of the given |
| enumeration or code list value.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <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="#getStandardName(java.lang.Class)">getStandardName</a></span>​(<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><?> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ISO name for the given class, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <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(java.lang.CharSequence)">toInternationalString</a></span>​(<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> string)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the given characters sequence as an international string.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <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(java.util.Map,java.lang.String)">toInternationalString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties, |
| <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> prefix)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an international string for the values in the given properties map, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <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="#toInternationalStrings(java.lang.CharSequence...)">toInternationalStrings</a></span>​(<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>... strings)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the given array of <code>CharSequence</code>s as an array of <code>InternationalString</code>s.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <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(org.opengis.util.InternationalString,java.util.Locale)">toString</a></span>​(<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> i18n, |
| <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">Locale</a> locale)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the given international string in the given locale, or <code>null</code> if the given string is null.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getStandardName(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStandardName</h4> |
| <pre class="methodSignature">public static <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> getStandardName​(<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><?> type)</pre> |
| <div class="block">Returns the ISO name for the given class, or <code>null</code> if none. |
| This method can be used for GeoAPI interfaces or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList</code></a>. |
| |
| <div class="note"><b>Examples:</b> |
| <ul> |
| <li><code>getStandardName(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a>.class)</code> |
| (an interface) returns <code>"CI_Citation"</code>.</li> |
| <li><code>getStandardName(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>.class)</code> |
| (a code list) returns <code>"CS_AxisDirection"</code>.</li> |
| </ul> |
| </div> |
| |
| This method looks for the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink"><code>UML</code></a> annotation on the given type. It does not search for |
| parent classes or interfaces if the given type is not directly annotated (i.e. <code>@UML</code> |
| annotations are not inherited). If no annotation is found, then this method does not fallback |
| on the Java name since, as the name implies, this method is about standard names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the GeoAPI interface or code list from which to get the ISO name, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ISO name for the given type, or <code>null</code> if none or if the given type is <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#forStandardName(java.lang.String)"><code>forStandardName(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getListName(org.opengis.util.CodeList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListName</h4> |
| <pre class="methodSignature">public static <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> getListName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</pre> |
| <div class="block">Returns the ISO classname (if available) or the Java classname (as a fallback) of the given |
| enumeration or code list value. This method uses the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink"><code>UML</code></a> annotation if it exists, or |
| fallback on the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink">simple class name</a> otherwise. |
| |
| <div class="note"><b>Examples:</b> |
| <ul> |
| <li><code>getListName(ParameterDirection.IN_OUT)</code> returns <code>"SV_ParameterDirection"</code>.</li> |
| <li><code>getListName(AxisDirection.NORTH)</code> returns <code>"CS_AxisDirection"</code>.</li> |
| <li><code>getListName(TopicCategory.INLAND_WATERS)</code> returns <code>"MD_TopicCategoryCode"</code>.</li> |
| <li><code>getListName(ImagingCondition.BLURRED_IMAGE)</code> returns <code>"MD_ImagingConditionCode"</code>.</li> |
| </ul> |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>code</code> - the code for which to get the class name, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ISO (preferred) or Java (fallback) class name, or <code>null</code> if the given code is null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCodeName(org.opengis.util.CodeList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCodeName</h4> |
| <pre class="methodSignature">public static <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> getCodeName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</pre> |
| <div class="block">Returns the ISO name (if available) or the Java name (as a fallback) of the given enumeration or code list |
| value. If the value has no <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink"><code>UML</code></a> identifier, then the programmatic name is used as a fallback. |
| |
| <div class="note"><b>Examples:</b> |
| <ul> |
| <li><code>getCodeName(ParameterDirection.IN_OUT)</code> returns <code>"in/out"</code>.</li> |
| <li><code>getCodeName(AxisDirection.NORTH)</code> returns <code>"north"</code>.</li> |
| <li><code>getCodeName(TopicCategory.INLAND_WATERS)</code> returns <code>"inlandWaters"</code>.</li> |
| <li><code>getCodeName(ImagingCondition.BLURRED_IMAGE)</code> returns <code>"blurredImage"</code>.</li> |
| </ul> |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>code</code> - the code for which to get the name, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UML identifiers or programmatic name for the given code, or <code>null</code> if the given code is null.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getCodeLabel(org.opengis.util.CodeList)"><code>getCodeLabel(CodeList)</code></a>, |
| <a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a>, |
| <a href="#getDescription(org.opengis.util.CodeList)"><code>getDescription(CodeList)</code></a>, |
| <a href="#forCodeName(java.lang.Class,java.lang.String,boolean)"><code>forCodeName(Class, String, boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCodeLabel(org.opengis.util.CodeList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCodeLabel</h4> |
| <pre class="methodSignature">public static <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> getCodeLabel​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</pre> |
| <div class="block">Returns a unlocalized title for the given enumeration or code list value. |
| This method builds a title using heuristics rules, which should give reasonable |
| results without the need of resource bundles. For better results, consider using |
| <a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a> instead. |
| |
| <p>The current heuristic implementation iterates over <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true#names()" title="class or interface in org.opengis.util" class="externalLink">all code names</a>, |
| selects the longest one excluding the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true#name()" title="class or interface in org.opengis.util" class="externalLink">field name</a> if possible, then |
| <a href="../CharSequences.html#camelCaseToSentence(java.lang.CharSequence)">makes a sentence</a> from that name.</p> |
| |
| <div class="note"><b>Examples:</b> |
| <ul> |
| <li><code>getCodeLabel(AxisDirection.NORTH)</code> returns <code>"North"</code>.</li> |
| <li><code>getCodeLabel(TopicCategory.INLAND_WATERS)</code> returns <code>"Inland waters"</code>.</li> |
| <li><code>getCodeLabel(ImagingCondition.BLURRED_IMAGE)</code> returns <code>"Blurred image"</code>.</li> |
| </ul> |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>code</code> - the code from which to get a title, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a unlocalized title for the given code, or <code>null</code> if the given code is null.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getCodeName(org.opengis.util.CodeList)"><code>getCodeName(CodeList)</code></a>, |
| <a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a>, |
| <a href="#getDescription(org.opengis.util.CodeList)"><code>getDescription(CodeList)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCodeTitle(org.opengis.util.CodeList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCodeTitle</h4> |
| <pre class="methodSignature">public static <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> getCodeTitle​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</pre> |
| <div class="block">Returns the title of the given enumeration or code list value. Title are usually much shorter than descriptions. |
| English titles are often the same than the <a href="#getCodeLabel(org.opengis.util.CodeList)">code labels</a>. |
| |
| <p>The code or enumeration value given in argument to this method can be retrieved from the returned title |
| with the <a href="#forCodeTitle(java.lang.CharSequence)"><code>forCodeTitle(CharSequence)</code></a> method. See <cite>Substituting a free text by a code list</cite> |
| in this class javadoc for more information.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>code</code> - the code for which to get the title, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the title, or <code>null</code> if the given code is null.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getDescription(org.opengis.util.CodeList)"><code>getDescription(CodeList)</code></a>, |
| <a href="#forCodeTitle(java.lang.CharSequence)"><code>forCodeTitle(CharSequence)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDescription(org.opengis.util.CodeList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre class="methodSignature">public static <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> getDescription​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> code)</pre> |
| <div class="block">Returns the description of the given enumeration or code list value, or <code>null</code> if none. |
| For a description of the code list as a whole instead than a particular code, |
| see <a href="#getDescription(java.lang.Class)"><code>getDescription(Class)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>code</code> - the code for which to get the localized description, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the description, or <code>null</code> if none or if the given code is null.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a>, |
| <a href="#getDescription(java.lang.Class)"><code>getDescription(Class)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDescription(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre class="methodSignature">public static <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> getDescription​(<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><?> type)</pre> |
| <div class="block">Returns a description for the given class, or <code>null</code> if none. |
| This method can be used for GeoAPI interfaces or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the GeoAPI interface or code list from which to get the description, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the description, or <code>null</code> if none or if the given type is <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getDescription(org.opengis.util.CodeList)"><code>getDescription(CodeList)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDescription(java.lang.Class,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre class="methodSignature">public static <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> getDescription​(<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><?> type, |
| <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> property)</pre> |
| <div class="block">Returns a description for the given property, or <code>null</code> if none. |
| The given type shall be a GeoAPI interface, and the given property shall |
| be a UML identifier. If any of the input argument is <code>null</code>, then |
| this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the GeoAPI interface from which to get the description of a property, or <code>null</code>.</dd> |
| <dd><code>property</code> - the ISO name of the property for which to get the description, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the description, or <code>null</code> if none or if the given type or property name is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCodeValues(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCodeValues</h4> |
| <pre class="methodSignature">public static <T extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?>> T[] getCodeValues​(<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><T> codeType)</pre> |
| <div class="block">Returns all known values for the given type of code list. |
| Note that the size of the returned array may growth between different invocations of this method, |
| since users can add their own codes to an existing list.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the compile-time type given as the <code>codeType</code> parameter.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>codeType</code> - the type of code list.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of values for the given code list, or an empty array if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getEnumConstants()" title="class or interface in java.lang" class="externalLink"><code>Class.getEnumConstants()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forStandardName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forStandardName</h4> |
| <pre class="methodSignature">public static <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><?> forStandardName​(<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> identifier)</pre> |
| <div class="block">Returns the Java type (usually a GeoAPI interface) for the given ISO name, or <code>null</code> if none. |
| The identifier argument shall be the value documented in the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#identifier()" title="class or interface in org.opengis.annotation" class="externalLink"><code>UML.identifier()</code></a> annotation on |
| the Java type. |
| |
| <div class="note"><b>Examples:</b> |
| <ul> |
| <li><code>forStandardName("CI_Citation")</code> returns <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a>.class</code></li> |
| <li><code>forStandardName("CS_AxisDirection")</code> returns <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>.class</code></li> |
| </ul> |
| </div> |
| |
| The package prefix (e.g. <code>"CI_"</code> in <code>"CI_Citation"</code>) can be omitted. |
| The flexibility is provided for allowing transition to newer ISO standards, |
| which are dropping the package prefixes. |
| For example <code>"CS_AxisDirection"</code> in ISO 19111:2007 |
| has been renamed <code>"AxisDirection"</code> in ISO 19111:2018. |
| |
| <p>Only identifiers for the stable part of GeoAPI or for some Apache SIS classes are recognized. |
| This method does not handle the identifiers for interfaces in the <code>geoapi-pending</code> module.</p> |
| |
| <div class="note"><b>Future evolution:</b> |
| when a new ISO type does not yet have a corresponding GeoAPI interface, |
| this method may temporarily return an Apache SIS class instead, until a future version can use the interface. |
| For example <code>forStandardName("CI_Individual")</code> returns |
| <code><a href="../../metadata/iso/citation/DefaultIndividual.html" title="class in org.apache.sis.metadata.iso.citation">DefaultIndividual</a>.class</code> in Apache SIS versions |
| that depend on GeoAPI 3.0, but the return type may be changed to <code>Individual.class</code> when Apache SIS will |
| be upgraded to GeoAPI 3.1.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - the ISO <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink">UML</a> identifier, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the GeoAPI interface, or <code>null</code> if the given identifier is <code>null</code> or unknown.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forEnumName(java.lang.Class,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEnumName</h4> |
| <pre class="methodSignature">public static <T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a><T>> T forEnumName​(<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><T> enumType, |
| <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> name)</pre> |
| <div class="block">Returns the enumeration value of the given type that matches the given name, or <code>null</code> if none. |
| This method is similar to the standard <code>Enum.valueOf(…)</code> method, except that this method is more |
| tolerant on string comparisons: |
| |
| <ul> |
| <li>Name comparisons are case-insensitive.</li> |
| <li>Only <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true#isLetterOrDigit(int)" title="class or interface in java.lang" class="externalLink">letter and digit</a> characters are compared. |
| Spaces and punctuation characters like <code>'_'</code> and <code>'-'</code> are ignored.</li> |
| </ul> |
| |
| If there is no match, this method returns <code>null</code> — it does not thrown an exception, |
| unless the given class is not an enumeration.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the compile-time type given as the <code>enumType</code> parameter.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enumType</code> - the type of enumeration.</dd> |
| <dd><code>name</code> - the name of the enumeration value to obtain, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a value matching the given name, or <code>null</code> if the name is null |
| or if no matching enumeration is found.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink"><code>Enum.valueOf(Class, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forCodeName(java.lang.Class,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forCodeName</h4> |
| <pre class="methodSignature">public static <T extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><T>> T forCodeName​(<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><T> codeType, |
| <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> name, |
| boolean canCreate)</pre> |
| <div class="block">Returns the code of the given type that matches the given name, or optionally returns a new one if none |
| match the name. This method performs the same work than the GeoAPI <code>CodeList.valueOf(…)</code> method, |
| except that this method is more tolerant on string comparisons when looking for an existing code: |
| |
| <ul> |
| <li>Name comparisons are case-insensitive.</li> |
| <li>Only <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true#isLetterOrDigit(int)" title="class or interface in java.lang" class="externalLink">letter and digit</a> characters are compared. |
| Spaces and punctuation characters like <code>'_'</code> and <code>'-'</code> are ignored.</li> |
| </ul> |
| |
| If no match is found, then a new code is created only if the <code>canCreate</code> argument is <code>true</code>. |
| Otherwise this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the compile-time type given as the <code>codeType</code> parameter.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>codeType</code> - the type of code list.</dd> |
| <dd><code>name</code> - the name of the code to obtain, or <code>null</code>.</dd> |
| <dd><code>canCreate</code> - <code>true</code> if this method is allowed to create new code.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a code matching the given name, or <code>null</code> if the name is null |
| or if no matching code is found and <code>canCreate</code> is <code>false</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getCodeName(org.opengis.util.CodeList)"><code>getCodeName(CodeList)</code></a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in org.opengis.util" class="externalLink"><code>CodeList.valueOf(Class, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forCodeTitle(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forCodeTitle</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a><?> forCodeTitle​(<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> title)</pre> |
| <div class="block">Returns the code list or enumeration value for the given title, or <code>null</code> if none. |
| The current implementation performs the following choice: |
| |
| <ul> |
| <li>If the given title is a value returned by a previous call to <a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a>, |
| returns the code or enumeration value used for creating that title.</li> |
| <li>Otherwise returns <code>null</code>.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>title</code> - the title for which to get a code or enumeration value, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the code or enumeration value associated with the given title, or <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getCodeTitle(org.opengis.util.CodeList)"><code>getCodeTitle(CodeList)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toInternationalString(java.util.Map,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toInternationalString</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> toInternationalString​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties, |
| <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> prefix) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> |
| <div class="block">Returns an international string for the values in the given properties map, or <code>null</code> if none. |
| This method is used when a property in a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> may have many localized variants. |
| For example the given map may contains a <code>"remarks"</code> property defined by values associated to |
| the <code>"remarks_en"</code> and <code>"remarks_fr"</code> keys, for English and French locales respectively. |
| |
| <p>If the given map is <code>null</code>, then this method returns <code>null</code>. |
| Otherwise this method iterates over the entries having a key that starts with the specified prefix, |
| followed by the <code>'_'</code> character. For each such key:</p> |
| |
| <ul> |
| <li>If the key is exactly equals to <code>prefix</code>, selects <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true#ROOT" title="class or interface in java.util" class="externalLink"><code>Locale.ROOT</code></a>.</li> |
| <li>Otherwise the characters after <code>'_'</code> are parsed as an ISO language and country code |
| by the <a href="../Locales.html#parse(java.lang.String,int)"><code>Locales.parse(String, int)</code></a> method. Note that 3-letters codes are replaced |
| by their 2-letters counterparts on a <cite>best effort</cite> basis.</li> |
| <li>The value for the decoded locale is added in the international string to be returned.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - the map from which to get the string values for an international string, or <code>null</code>.</dd> |
| <dd><code>prefix</code> - the prefix of keys to use for creating the international string.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the international string, or <code>null</code> if the given map is null or does not contain values |
| associated to keys starting with the given prefix.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if a key starts by the given prefix and: |
| <ul> |
| <li>The key suffix is an illegal <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> code,</li> |
| <li>or the value associated to that key is a not a <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>CharSequence</code></a>.</li> |
| </ul></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Locales.html#parse(java.lang.String,int)"><code>Locales.parse(String, int)</code></a>, |
| <a href="DefaultInternationalString.html#%3Cinit%3E(java.util.Map)"><code>DefaultInternationalString(Map)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toInternationalString(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toInternationalString</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> toInternationalString​(<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> string)</pre> |
| <div class="block">Returns the given characters sequence as an international string. If the given sequence is |
| null or an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a>, then this method returns it unchanged. |
| Otherwise, this method copies the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true#toString()" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString.toString()</code></a> value in a new |
| <a href="SimpleInternationalString.html" title="class in org.apache.sis.util.iso"><code>SimpleInternationalString</code></a> instance and returns it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>string</code> - the characters sequence to convert, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given sequence as an international string, or <code>null</code> if the given sequence was null.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultNameFactory.html#createInternationalString(java.util.Map)"><code>DefaultNameFactory.createInternationalString(Map)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toInternationalStrings(java.lang.CharSequence...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toInternationalStrings</h4> |
| <pre class="methodSignature">public static <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>[] toInternationalStrings​(<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>... strings)</pre> |
| <div class="block">Returns the given array of <code>CharSequence</code>s as an array of <code>InternationalString</code>s. |
| If the given array is null or an instance of <code>InternationalString[]</code>, then this method |
| returns it unchanged. Otherwise a new array of type <code>InternationalString[]</code> is created |
| and every elements from the given array is copied or |
| <a href="#toInternationalString(java.lang.CharSequence)">casted</a> in the new array. |
| |
| <p>If a defensive copy of the <code>strings</code> array is wanted, then the caller needs to check |
| if the returned array is the same instance than the one given in argument to this method.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>strings</code> - the characters sequences to convert, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given array as an array of type <code>InternationalString[]</code>, |
| or <code>null</code> if the given array was null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString(org.opengis.util.InternationalString,java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString​(<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> i18n, |
| <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">Locale</a> locale)</pre> |
| <div class="block">Returns the given international string in the given locale, or <code>null</code> if the given string is null. |
| If the given locale is <code>null</code>, then the <code>i18n</code> default locale is used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>i18n</code> - the international string to get as a localized string, or <code>null</code> if none.</dd> |
| <dd><code>locale</code> - the desired locale, or <code>null</code> for the <code>i18n</code> default locale.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the localized string, or <code>null</code> if <code>i18n</code> is <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</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/Types.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |