| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Symbols (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.io.wkt.Symbols class"> |
| <meta name="keywords" content="SQUARE_BRACKETS"> |
| <meta name="keywords" content="CURLY_BRACKETS"> |
| <meta name="keywords" content="getDefault()"> |
| <meta name="keywords" content="getLocale()"> |
| <meta name="keywords" content="setLocale()"> |
| <meta name="keywords" content="getNumPairedBrackets()"> |
| <meta name="keywords" content="getOpeningBracket()"> |
| <meta name="keywords" content="getClosingBracket()"> |
| <meta name="keywords" content="setPairedBrackets()"> |
| <meta name="keywords" content="getNumPairedQuotes()"> |
| <meta name="keywords" content="getOpeningQuote()"> |
| <meta name="keywords" content="getClosingQuote()"> |
| <meta name="keywords" content="setPairedQuotes()"> |
| <meta name="keywords" content="getOpenSequence()"> |
| <meta name="keywords" content="getCloseSequence()"> |
| <meta name="keywords" content="setSequenceBrackets()"> |
| <meta name="keywords" content="getSeparator()"> |
| <meta name="keywords" content="setSeparator()"> |
| <meta name="keywords" content="containsElement()"> |
| <meta name="keywords" content="containsAxis()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Symbols (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Symbols.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.io.wkt</a></div> |
| <h2 title="Class Symbols" class="title">Class Symbols</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>Symbols</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">Symbols</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre> |
| <div class="block">The set of symbols to use for <cite>Well Known Text</cite> (WKT) parsing and formatting. |
| The two constants defined in this class, namely <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a> and <a href="#CURLY_BRACKETS"><code>CURLY_BRACKETS</code></a>, |
| define the symbols for ISO 19162 compliant WKT formatting. Their properties are: |
| |
| <table class="sis"> |
| <caption>Standard WKT symbols</caption> |
| <tr> |
| <th>WKT aspect</th> |
| <th>Standard value</th> |
| <th>Comment</th> |
| </tr> |
| <tr> |
| <td>Locale for number format:</td> |
| <td><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></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>Bracket symbols:</td> |
| <td><code>[</code>…<code>]</code> or <code>(</code>…<code>)</code></td> |
| <td><span style="font-size: small"><b>Note:</b> the <code>[…]</code> brackets are common in referencing WKT, |
| while the <code>(…)</code> brackets are common in geometry WKT.</span></td> |
| </tr> |
| <tr> |
| <td>Quote symbols:</td> |
| <td><code>"</code>…<code>"</code></td> |
| <td><span style="font-size: small"><b>Note:</b> Apache SIS accepts also <code>“…”</code> quotes |
| for more readable <code>String</code> literals in Java code, but this is non-standard.</span></td> |
| </tr> |
| <tr> |
| <td>Sequence symbols:</td> |
| <td><code>{</code>…<code>}</code></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>Separator:</td> |
| <td><code>,</code></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| Users can create their own <code>Symbols</code> instance for parsing or formatting a WKT with different symbols.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WKTFormat.html#getSymbols()"><code>WKTFormat.getSymbols()</code></a>, |
| <a href="WKTFormat.html#setSymbols(org.apache.sis.io.wkt.Symbols)"><code>WKTFormat.setSymbols(Symbols)</code></a>, |
| <a href="../../../../../serialized-form.html#org.apache.sis.io.wkt.Symbols">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CURLY_BRACKETS">CURLY_BRACKETS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A set of symbols with values between parentheses, like <code>DATUM("WGS84")</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SQUARE_BRACKETS">SQUARE_BRACKETS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A set of symbols with values between square brackets, like <code>DATUM["WGS84"]</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.io.wkt.Symbols)">Symbols</a></span>​(<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> symbols)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new set of WKT symbols initialized to a copy of the given symbols.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a clone of this <code>Symbols</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAxis(java.lang.CharSequence)">containsAxis</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> wkt)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the <code>AXIS[…]</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsElement(java.lang.CharSequence,java.lang.String)">containsElement</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> wkt, |
| <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> element)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the given element.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<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> other)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this <code>Symbols</code> with the given object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCloseSequence()">getCloseSequence</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the character used for closing a sequence of values.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClosingBracket(int)">getClosingBracket</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the closing bracket character at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClosingQuote(int)">getClosingQuote</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the closing quote character at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefault()">getDefault</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default set of symbols.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocale()">getLocale</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the locale for formatting dates and numbers.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumPairedBrackets()">getNumPairedBrackets</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of paired brackets.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumPairedQuotes()">getNumPairedQuotes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of paired quotes.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpeningBracket(int)">getOpeningBracket</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the opening bracket character at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpeningQuote(int)">getOpeningQuote</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the opening quote character at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenSequence()">getOpenSequence</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the character used for opening a sequence of values.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSeparator()">getSeparator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the string used as a separator in a list of values.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a hash code value for this object.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLocale(java.util.Locale)">setLocale</a></span>​(<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">Sets the locale of decimal format symbols or other symbols.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPairedBrackets(java.lang.String,java.lang.String...)">setPairedBrackets</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> preferred, |
| <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>... alternatives)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the opening and closing brackets to the given pairs.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPairedQuotes(java.lang.String,java.lang.String...)">setPairedQuotes</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> preferred, |
| <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>... alternatives)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the opening and closing quotes to the given pairs.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSeparator(java.lang.String)">setSeparator</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> separator)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the string to use as a separator in a list of values.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSequenceBrackets(int,int)">setSequenceBrackets</a></span>​(int openSequence, |
| int closeSequence)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the characters used for opening and closing a sequence of values.</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#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="SQUARE_BRACKETS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SQUARE_BRACKETS</h4> |
| <pre>public static final <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> SQUARE_BRACKETS</pre> |
| <div class="block">A set of symbols with values between square brackets, like <code>DATUM["WGS84"]</code>. |
| This instance defines: |
| |
| <ul> |
| <li><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> for <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormatSymbols.html?is-external=true" title="class or interface in java.text" class="externalLink">decimal format symbols</a>.</li> |
| <li>Square brackets by default, as in <code>DATUM["WGS84"]</code>, but accepting also curly brackets as in |
| <code>DATUM("WGS84")</code>. Both are legal WKT.</li> |
| <li>English quotation mark (<code>'"'</code>) by default, but accepting also “…” quotes |
| for more readable <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> constants in Java code.</li> |
| <li>Coma separator followed by a space (<code>", "</code>).</li> |
| </ul> |
| |
| This is the most frequently used WKT format for referencing objects.</div> |
| </li> |
| </ul> |
| <a id="CURLY_BRACKETS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CURLY_BRACKETS</h4> |
| <pre>public static final <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> CURLY_BRACKETS</pre> |
| <div class="block">A set of symbols with values between parentheses, like <code>DATUM("WGS84")</code>. |
| This instance is identical to <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a> except that the default |
| brackets are the curly ones instead than the square ones (but both are still |
| accepted at parsing time). |
| |
| <p>This format is rare with referencing objects but common with geometry objects.</p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.sis.io.wkt.Symbols)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Symbols</h4> |
| <pre>public Symbols​(<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> symbols)</pre> |
| <div class="block">Creates a new set of WKT symbols initialized to a copy of the given symbols.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>symbols</code> - the symbols to copy.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getDefault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefault</h4> |
| <pre class="methodSignature">public static <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> getDefault()</pre> |
| <div class="block">Returns the default set of symbols. |
| This is currently set to <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default set of symbols.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocale()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocale</h4> |
| <pre class="methodSignature">public final <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> getLocale()</pre> |
| <div class="block">Returns the locale for formatting dates and numbers. |
| The default value is <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>. |
| |
| <div class="section">Relationship between <code>Symbols</code> locale and <code>WKTFormat</code> locale</div> |
| The <code>WKTFormat.getLocale(Locale.DISPLAY)</code> property specifies the language to use when |
| formatting <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> instances and can be set to any value. |
| On the contrary, the <code>Locale</code> property of this <code>Symbols</code> class controls |
| the decimal format symbols and is very rarely set to an other locale than <code>Locale.ROOT</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../util/Localized.html#getLocale()">getLocale</a></code> in interface <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the locale for dates and numbers.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WKTFormat.html#getLocale(java.util.Locale.Category)"><code>WKTFormat.getLocale(Locale.Category)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLocale(java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocale</h4> |
| <pre class="methodSignature">public void setLocale​(<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">Sets the locale of decimal format symbols or other symbols. |
| Note that any non-English locale is likely to produce WKT that do not conform to ISO 19162. |
| Such WKT can be used for human reading, but not for data export.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locale</code> - the new symbols locale.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumPairedBrackets()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumPairedBrackets</h4> |
| <pre class="methodSignature">public final int getNumPairedBrackets()</pre> |
| <div class="block">Returns the number of paired brackets. For example if the WKT parser accepts both the |
| <code>[…]</code> and <code>(…)</code> bracket pairs, then this method returns 2.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bracket pairs.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getOpeningBracket(int)"><code>getOpeningBracket(int)</code></a>, |
| <a href="#getClosingBracket(int)"><code>getClosingBracket(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOpeningBracket(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpeningBracket</h4> |
| <pre class="methodSignature">public final int getOpeningBracket​(int index)</pre> |
| <div class="block">Returns the opening bracket character at the given index. |
| Index 0 stands for the default bracket used at formatting time. |
| All other index are for optional brackets accepted at parsing time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the opening bracket to get, from 0 to <a href="#getNumPairedBrackets()"><code>getNumPairedBrackets()</code></a> exclusive.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the opening bracket at the given index, as a Unicode code point.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClosingBracket(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClosingBracket</h4> |
| <pre class="methodSignature">public final int getClosingBracket​(int index)</pre> |
| <div class="block">Returns the closing bracket character at the given index. |
| Index 0 stands for the default bracket used at formatting time. |
| All other index are for optional brackets accepted at parsing time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the closing bracket to get, from 0 to <a href="#getNumPairedBrackets()"><code>getNumPairedBrackets()</code></a> exclusive.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the closing bracket at the given index, as a Unicode code point.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPairedBrackets(java.lang.String,java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPairedBrackets</h4> |
| <pre class="methodSignature">public void setPairedBrackets​(<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> preferred, |
| <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>... alternatives)</pre> |
| <div class="block">Sets the opening and closing brackets to the given pairs. |
| Each string shall contain exactly two code points (usually two characters). |
| The first code point is taken as the opening bracket, and the second code point as the closing bracket. |
| |
| <div class="note"><b>Example:</b> |
| The following code will instruct the WKT formatter to use the (…) pair of brackets at formatting time, |
| but still accept the more common […] pair of brackets at parsing time: |
| |
| <blockquote><pre>symbols.<b>setPairedBrackets</b>(<font color="orangered">"()"</font>, <font color="orangered">"[]"</font>);</pre></blockquote></div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>preferred</code> - the preferred pair of opening and closing quotes, used at formatting time.</dd> |
| <dd><code>alternatives</code> - alternative pairs of opening and closing quotes accepted at parsing time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumPairedQuotes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumPairedQuotes</h4> |
| <pre class="methodSignature">public final int getNumPairedQuotes()</pre> |
| <div class="block">Returns the number of paired quotes. For example if the WKT parser accepts both the |
| <code>"…"</code> and <code>“…”</code> quote pairs, then this method returns 2.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of quote pairs.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getOpeningQuote(int)"><code>getOpeningQuote(int)</code></a>, |
| <a href="#getClosingQuote(int)"><code>getClosingQuote(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOpeningQuote(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpeningQuote</h4> |
| <pre class="methodSignature">public final int getOpeningQuote​(int index)</pre> |
| <div class="block">Returns the opening quote character at the given index. |
| Index 0 stands for the default quote used at formatting time, which is usually <code>'"'</code>. |
| All other index are for optional quotes accepted at parsing time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the opening quote to get, from 0 to <a href="#getNumPairedQuotes()"><code>getNumPairedQuotes()</code></a> exclusive.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the opening quote at the given index, as a Unicode code point.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClosingQuote(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClosingQuote</h4> |
| <pre class="methodSignature">public final int getClosingQuote​(int index)</pre> |
| <div class="block">Returns the closing quote character at the given index. |
| Index 0 stands for the default quote used at formatting time, which is usually <code>'"'</code>. |
| All other index are for optional quotes accepted at parsing time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the closing quote to get, from 0 to <a href="#getNumPairedQuotes()"><code>getNumPairedQuotes()</code></a> exclusive.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the closing quote at the given index, as a Unicode code point.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPairedQuotes(java.lang.String,java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPairedQuotes</h4> |
| <pre class="methodSignature">public void setPairedQuotes​(<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> preferred, |
| <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>... alternatives)</pre> |
| <div class="block">Sets the opening and closing quotes to the given pairs. |
| Each string shall contain exactly two code points (usually two characters). |
| The first code point is taken as the opening quote, and the second code point as the closing quote. |
| |
| <div class="note"><b>Example:</b> |
| The following code will instruct the WKT formatter to use the prettier “…” quotation marks at formatting time |
| (especially useful for <code>String</code> constants in Java code), but still accept the standard "…" quotation marks |
| at parsing time: |
| |
| <blockquote><pre>symbols.<b>setPairedQuotes</b>(<font color="orangered">"“”"</font>, <font color="orangered">"\"</font>\<font color="orangered">""</font>);</pre></blockquote></div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>preferred</code> - the preferred pair of opening and closing quotes, used at formatting time.</dd> |
| <dd><code>alternatives</code> - alternative pairs of opening and closing quotes accepted at parsing time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOpenSequence()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenSequence</h4> |
| <pre class="methodSignature">public final int getOpenSequence()</pre> |
| <div class="block">Returns the character used for opening a sequence of values. |
| This is usually <code>'{'</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the character used for opening a sequence of values, as a Unicode code point.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCloseSequence()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloseSequence</h4> |
| <pre class="methodSignature">public final int getCloseSequence()</pre> |
| <div class="block">Returns the character used for closing a sequence of values. |
| This is usually <code>'}'</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the character used for closing a sequence of values, as a Unicode code point.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSequenceBrackets(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSequenceBrackets</h4> |
| <pre class="methodSignature">public void setSequenceBrackets​(int openSequence, |
| int closeSequence)</pre> |
| <div class="block">Sets the characters used for opening and closing a sequence of values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>openSequence</code> - the character for opening a sequence of values, as a Unicode code point.</dd> |
| <dd><code>closeSequence</code> - the character for closing a sequence of values, as a Unicode code point.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSeparator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSeparator</h4> |
| <pre class="methodSignature">public final <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> getSeparator()</pre> |
| <div class="block">Returns the string used as a separator in a list of values. This is usually <code>", "</code>, |
| but may be different if a non-English locale is used for formatting numbers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string used as a separator in a list of values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSeparator(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSeparator</h4> |
| <pre class="methodSignature">public void setSeparator​(<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> separator)</pre> |
| <div class="block">Sets the string to use as a separator in a list of values. |
| The given string will be used "as-is" at formatting time, |
| but leading and trailing spaces will be ignored at parsing time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>separator</code> - the new string to use as a separator in a list of values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="containsElement(java.lang.CharSequence,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsElement</h4> |
| <pre class="methodSignature">public boolean containsElement​(<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> wkt, |
| <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> element)</pre> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the given element. |
| Invoking this method is equivalent to invoking <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#contains(java.lang.CharSequence)" title="class or interface in java.lang" class="externalLink"><code>String.contains(CharSequence)</code></a> except |
| for the following: |
| |
| <ul> |
| <li>The search is case-insensitive.</li> |
| <li>Characters between <a href="#getOpeningQuote(int)">opening quotes</a> and |
| <a href="#getClosingQuote(int)">closing quotes</a> are ignored.</li> |
| <li>The element found in the given WKT can not be preceded by other |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true#isUnicodeIdentifierPart(int)" title="class or interface in java.lang" class="externalLink">Unicode identifier characters</a>.</li> |
| <li>The element found in the given WKT must be followed, ignoring space, by an |
| <a href="#getOpeningBracket(int)">opening bracket</a>.</li> |
| </ul> |
| |
| The purpose of this method is to guess some characteristics about the encoded object without |
| the cost of a full WKT parsing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wkt</code> - the WKT to inspect.</dd> |
| <dd><code>element</code> - the element to search for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the given WKT contains at least one instance of the given element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="containsAxis(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsAxis</h4> |
| <pre class="methodSignature">public boolean containsAxis​(<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> wkt)</pre> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the <code>AXIS[…]</code> element. |
| Invoking this method is equivalent to invoking |
| <code><a href="#containsElement(java.lang.CharSequence,java.lang.String)">containsElement</a>(wkt, "AXIS")</code>. |
| |
| <div class="section">Use case</div> |
| The check for axis elements is of particular interest because the axis order is a frequent cause |
| of confusion when processing geographic data. Some applications just ignore any declared axis order |
| in favor of their own hard-coded (<var>longitude</var>, <var>latitude</var>) axis order. |
| Consequently, the presence of <code>AXIS[…]</code> elements in a WKT is an indication that the encoded |
| object may not be understood as intended by some external software products.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wkt</code> - the WKT to inspect.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the given WKT contains at least one instance of the <code>AXIS[…]</code> element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> clone()</pre> |
| <div class="block">Returns a clone of this <code>Symbols</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone of this <code>Symbols</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> other)</pre> |
| <div class="block">Compares this <code>Symbols</code> with the given object for equality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>other</code> - the object to compare with this <code>Symbols</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if both objects are equal.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <div class="block">Returns a hash code value for this object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="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></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a hash code value.</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/Symbols.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |