| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>LocationFormat (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.referencing.gazetteer.LocationFormat class"> |
| <meta name="keywords" content="getValueType()"> |
| <meta name="keywords" content="format()"> |
| <meta name="keywords" content="createFormat()"> |
| <meta name="keywords" content="parse()"> |
| <meta name="keywords" content="clone()"> |
| <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="LocationFormat (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All 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/LocationFormat.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><a href="#nested.class.summary">Nested</a> | </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>Field | </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.referencing.gazetteer</a></div> |
| <h2 title="Class LocationFormat" class="title">Class LocationFormat</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="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>LocationFormat</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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">LocationFormat</span> |
| extends <a href="../../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></pre> |
| <div class="block">Formats <code>Location</code> instances in a tabular format. |
| This format assumes a monospaced font and an encoding supporting drawing box characters (e.g. UTF-8). |
| |
| <div class="note"><b>Example:</b> |
| the location identified by "32TNL83" in the <a href="MilitaryGridReferenceSystem.html" title="class in org.apache.sis.referencing.gazetteer">military grid reference system</a> |
| can be represented by the following string formatted using <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true#ENGLISH" title="class or interface in java.util" class="externalLink"><code>Locale.ENGLISH</code></a>: |
| |
| <blockquote><pre>┌─────────────────────────────────────────────────────────────┐ |
| │ Location type: Grid zone designator │ |
| │ Geographic identifier: 32TNL83 │ |
| │ West bound: 580,000 m — 9°57′00″E │ |
| │ Representative value: 585,000 m — 10°00′36″E │ |
| │ East bound: 590,000 m — 10°04′13″E │ |
| │ South bound: 4,530,000 m — 40°54′58″N │ |
| │ Representative value: 4,535,000 m — 40°57′42″N │ |
| │ North bound: 4,540,000 m — 41°00′27″N │ |
| │ Coordinate reference system: WGS 84 / UTM zone 32N │ |
| └─────────────────────────────────────────────────────────────┘</pre></blockquote> |
| </div> |
| |
| <p><b>Limitations:</b></p> |
| <ul> |
| <li>The current implementation can only format features — parsing is not yet implemented.</li> |
| <li><code>LocationFormat</code>, like most <code>java.text.Format</code> subclasses, is not thread-safe.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.sis.referencing.gazetteer.LocationFormat">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing-by-identifiers</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.text.Format"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.Field.html?is-external=true" title="class or interface in java.text" class="externalLink">Format.Field</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.TabularFormat"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class <a href="../../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a></h3> |
| <code><a href="../../io/TabularFormat.html#beforeFill">beforeFill</a>, <a href="../../io/TabularFormat.html#columnSeparator">columnSeparator</a>, <a href="../../io/TabularFormat.html#fillCharacter">fillCharacter</a>, <a href="../../io/TabularFormat.html#lineSeparator">lineSeparator</a>, <a href="../../io/TabularFormat.html#omitTrailingNulls">omitTrailingNulls</a></code></li> |
| </ul> |
| </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(java.util.Locale,java.util.TimeZone)">LocationFormat</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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util" class="externalLink">TimeZone</a> timezone)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new format for the given locale.</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="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="LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer">LocationFormat</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 format.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createFormat(java.lang.Class)">createFormat</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><?> valueType)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates the format to use for formatting a latitude, longitude or projected coordinate.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(org.apache.sis.referencing.gazetteer.AbstractLocation,java.lang.Appendable)">format</a></span>​(<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a> location, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> toAppendTo)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a textual representation of the given location in the given stream or buffer.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of values formatted by this <code>Format</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</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> text, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParsePosition.html?is-external=true" title="class or interface in java.text" class="externalLink">ParsePosition</a> pos)</code></th> |
| <td class="colLast"> |
| <div class="block">Unsupported operation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.TabularFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a></h3> |
| <code><a href="../../io/TabularFormat.html#getColumnSeparatorMatcher(java.lang.CharSequence)">getColumnSeparatorMatcher</a>, <a href="../../io/TabularFormat.html#getColumnSeparatorPattern()">getColumnSeparatorPattern</a>, <a href="../../io/TabularFormat.html#getLineSeparator()">getLineSeparator</a>, <a href="../../io/TabularFormat.html#setColumnSeparatorPattern(java.lang.String)">setColumnSeparatorPattern</a>, <a href="../../io/TabularFormat.html#setLineSeparator(java.lang.String)">setLineSeparator</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.CompoundFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a></h3> |
| <code><a href="../../io/CompoundFormat.html#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)">format</a>, <a href="../../io/CompoundFormat.html#getFormat(java.lang.Class)">getFormat</a>, <a href="../../io/CompoundFormat.html#getLocale()">getLocale</a>, <a href="../../io/CompoundFormat.html#getLocale(java.util.Locale.Category)">getLocale</a>, <a href="../../io/CompoundFormat.html#getTimeZone()">getTimeZone</a>, <a href="../../io/CompoundFormat.html#parseObject(java.lang.String)">parseObject</a>, <a href="../../io/CompoundFormat.html#parseObject(java.lang.String,java.text.ParsePosition)">parseObject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Format"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#format(java.lang.Object)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="externalLink">formatToCharacterIterator</a></code></li> |
| </ul> |
| <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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.util.Locale,java.util.TimeZone)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LocationFormat</h4> |
| <pre>public LocationFormat​(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util" class="externalLink">TimeZone</a> timezone)</pre> |
| <div class="block">Creates a new format for the given locale. The given locale can be <code>null</code> |
| or <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> if this format shall format "unlocalized" strings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locale</code> - the locale for the new <code>Format</code>, or <code>null</code> for <code>Locale.ROOT</code>.</dd> |
| <dd><code>timezone</code> - the timezone, or <code>null</code> for UTC.</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="getValueType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre class="methodSignature">public <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><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>> getValueType()</pre> |
| <div class="block">Returns the type of values formatted by this <code>Format</code> instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/CompoundFormat.html#getValueType()">getValueType</a></code> in class <code><a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type of values formatted by this <code>Format</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="format(org.apache.sis.referencing.gazetteer.AbstractLocation,java.lang.Appendable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre class="methodSignature">public void format​(<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a> location, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> toAppendTo) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Writes a textual representation of the given location in the given stream or buffer. |
| |
| <div class="warning"><b>Upcoming API change — generalization</b><br> |
| in a future SIS version, the type of <code>location</code> parameter may be generalized |
| to the <code>org.opengis.referencing.gazetteer.Location</code> interface. |
| This change is pending GeoAPI revision.</div></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/CompoundFormat.html#format(T,java.lang.Appendable)">format</a></code> in class <code><a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - the location to format.</dd> |
| <dd><code>toAppendTo</code> - where to format the location.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an error occurred while writing to the given appendable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createFormat(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFormat</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a> createFormat​(<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><?> valueType)</pre> |
| <div class="block">Creates the format to use for formatting a latitude, longitude or projected coordinate. |
| This method is invoked by <code>format(Location, Appendable)</code> when first needed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../io/CompoundFormat.html#createFormat(java.lang.Class)">createFormat</a></code> in class <code><a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueType</code> - <code>Angle.class</code>. <code>Number.class</code> or <code>Unit.class</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../measure/AngleFormat.html" title="class in org.apache.sis.measure"><code>AngleFormat</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/NumberFormat.html?is-external=true" title="class or interface in java.text" class="externalLink"><code>NumberFormat</code></a> or <a href="../../measure/UnitFormat.html" title="class in org.apache.sis.measure"><code>UnitFormat</code></a> instance |
| depending on the argument value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parse(java.lang.CharSequence,java.text.ParsePosition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre class="methodSignature">public <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a> parse​(<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> text, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParsePosition.html?is-external=true" title="class or interface in java.text" class="externalLink">ParsePosition</a> pos) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text" class="externalLink">ParseException</a></pre> |
| <div class="block">Unsupported operation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</a></code> in class <code><a href="../../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>text</code> - the character sequence for the location to parse.</dd> |
| <dd><code>pos</code> - the position where to start the parsing.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parsed location, or <code>null</code> if the text is not recognized.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text" class="externalLink">ParseException</a></code> - if an error occurred while parsing the location.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer">LocationFormat</a> clone()</pre> |
| <div class="block">Returns a clone of this format.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../io/TabularFormat.html#clone()">clone</a></code> in class <code><a href="../../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone of this format.</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/LocationFormat.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><a href="#nested.class.summary">Nested</a> | </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>Field | </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> |