| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>TabularFormat (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.TabularFormat class"> |
| <meta name="keywords" content="lineSeparator"> |
| <meta name="keywords" content="columnSeparator"> |
| <meta name="keywords" content="fillCharacter"> |
| <meta name="keywords" content="beforeFill"> |
| <meta name="keywords" content="omitTrailingNulls"> |
| <meta name="keywords" content="getLineSeparator()"> |
| <meta name="keywords" content="setLineSeparator()"> |
| <meta name="keywords" content="getColumnSeparatorPattern()"> |
| <meta name="keywords" content="setColumnSeparatorPattern()"> |
| <meta name="keywords" content="getColumnSeparatorMatcher()"> |
| <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="TabularFormat (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/TabularFormat.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><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</a></div> |
| <h2 title="Class TabularFormat" class="title">Class TabularFormat<T></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="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>TabularFormat<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the base type of objects parsed and formatted by this class.</dd> |
| </dl> |
| <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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../feature/FeatureFormat.html" title="class in org.apache.sis.feature">FeatureFormat</a></code>, <code><a href="../referencing/gazetteer/LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer">LocationFormat</a></code>, <code><a href="../parameter/ParameterFormat.html" title="class in org.apache.sis.parameter">ParameterFormat</a></code>, <code><a href="../math/StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></code>, <code><a href="../util/collection/TreeTableFormat.html" title="class in org.apache.sis.util.collection">TreeTableFormat</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">TabularFormat<T></span> |
| extends <a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><T></pre> |
| <div class="block">Base class for parser and formatter of tabular data, providing control on line and column separators. |
| The line separator is specified by a string. But the column separator is specified by a pattern which |
| provide some control on the character to repeat, and on the strings to insert before and after the |
| repeated character. See the following methods for details: |
| |
| <ul> |
| <li><a href="#setLineSeparator(java.lang.String)"><code>setLineSeparator(String)</code></a></li> |
| <li><a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a></li> |
| </ul> |
| |
| <div class="section">Note for subclass implementions</div> |
| This base class takes care of splitting a column separator pattern into its components |
| (<a href="#beforeFill"><code>beforeFill</code></a>, <a href="#fillCharacter"><code>fillCharacter</code></a> and <a href="#columnSeparator"><code>columnSeparator</code></a>) |
| for easier usage in <code>format(…)</code> method implementations. |
| Subclasses can use those fields like below: |
| |
| <p><b>Formatting table without border:</b></p> |
| <blockquote><pre>TableAppender table = <font color="green">new</font> <b>TableAppender</b>(out, <font color="orangered">""</font>); |
| <i><font color="gray">// ... do some work, then add a column separator:</font></i> |
| table.<b>append</b>(beforeFill); |
| table.<b>nextColumn</b>(fillCharacter); |
| table.<b>append</b>(columnSeparator);</pre></blockquote> |
| |
| <p><b>Formatting table with a border:</b></p> |
| <blockquote><pre>TableAppender table = <font color="green">new</font> <b>TableAppender</b>(out, columnSeparator); |
| <i><font color="gray">// ... do some work, then add a column separator:</font></i> |
| table.<b>append</b>(beforeFill); |
| table.<b>nextColumn</b>(fillCharacter);</pre></blockquote></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="TableAppender.html" title="class in org.apache.sis.io"><code>TableAppender</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.io.TabularFormat">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</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> |
| <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>protected <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="#beforeFill">beforeFill</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The string to write before the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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="#columnSeparator">columnSeparator</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The string to write after the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected char</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fillCharacter">fillCharacter</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The character to repeat after the content of a cell for alignment with the next column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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="#lineSeparator">lineSeparator</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The line separator to use for formatting the tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#omitTrailingNulls">omitTrailingNulls</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><code>true</code> if the trailing <code>null</code> values shall be omitted at formatting time.</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(java.util.Locale,java.util.TimeZone)">TabularFormat</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 tabular format.</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="TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="TabularFormat.html" title="type parameter in TabularFormat">T</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/util/regex/Matcher.html?is-external=true" title="class or interface in java.util.regex" class="externalLink">Matcher</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColumnSeparatorMatcher(java.lang.CharSequence)">getColumnSeparatorMatcher</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)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a matcher for the column separators in the given text.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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="#getColumnSeparatorPattern()">getColumnSeparatorPattern</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the pattern of characters used in column separators.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <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="#getLineSeparator()">getLineSeparator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the current line separator.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColumnSeparatorPattern(java.lang.String)">setColumnSeparatorPattern</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> pattern)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the pattern of the characters to insert between the columns.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLineSeparator(java.lang.String)">setLineSeparator</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 line separator.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.CompoundFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a></h3> |
| <code><a href="CompoundFormat.html#createFormat(java.lang.Class)">createFormat</a>, <a href="CompoundFormat.html#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)">format</a>, <a href="CompoundFormat.html#format(T,java.lang.Appendable)">format</a>, <a href="CompoundFormat.html#getFormat(java.lang.Class)">getFormat</a>, <a href="CompoundFormat.html#getLocale()">getLocale</a>, <a href="CompoundFormat.html#getLocale(java.util.Locale.Category)">getLocale</a>, <a href="CompoundFormat.html#getTimeZone()">getTimeZone</a>, <a href="CompoundFormat.html#getValueType()">getValueType</a>, <a href="CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</a>, <a href="CompoundFormat.html#parseObject(java.lang.String)">parseObject</a>, <a href="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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="lineSeparator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lineSeparator</h4> |
| <pre>protected <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> lineSeparator</pre> |
| <div class="block">The line separator to use for formatting the tree. |
| The default value is system-dependent.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getLineSeparator()"><code>getLineSeparator()</code></a>, |
| <a href="#setLineSeparator(java.lang.String)"><code>setLineSeparator(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="columnSeparator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnSeparator</h4> |
| <pre>protected <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> columnSeparator</pre> |
| <div class="block">The string to write after the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none. |
| This is the sequence of characters after the "<code>[ ]</code>" pair of brackets in the |
| pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</div> |
| </li> |
| </ul> |
| <a id="fillCharacter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fillCharacter</h4> |
| <pre>protected char fillCharacter</pre> |
| <div class="block">The character to repeat after the content of a cell for alignment with the next column. |
| This is the character between the "<code>[ ]</code>" pair of brackets in the pattern given |
| to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method. |
| |
| <p>Subclasses will typically use this value in calls to <a href="TableAppender.html#nextColumn(char)"><code>TableAppender.nextColumn(char)</code></a>.</p></div> |
| </li> |
| </ul> |
| <a id="beforeFill"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeFill</h4> |
| <pre>protected <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> beforeFill</pre> |
| <div class="block">The string to write before the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none. |
| This is the sequence of characters before the "<code>[ ]</code>" pair of brackets in the |
| pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</div> |
| </li> |
| </ul> |
| <a id="omitTrailingNulls"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>omitTrailingNulls</h4> |
| <pre>protected boolean omitTrailingNulls</pre> |
| <div class="block"><code>true</code> if the trailing <code>null</code> values shall be omitted at formatting time. |
| This flag is controlled by the presence or absence of the <code>'?'</code> character at the |
| beginning of the pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</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>(java.util.Locale,java.util.TimeZone)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TabularFormat</h4> |
| <pre>public TabularFormat​(<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 tabular format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locale</code> - the locale to use for numbers, dates and angles formatting, |
| or <code>null</code> for the <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">root locale</a>.</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="getLineSeparator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLineSeparator</h4> |
| <pre class="methodSignature">public <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> getLineSeparator()</pre> |
| <div class="block">Returns the current line separator. The default value is system-dependent.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current line separator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLineSeparator(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLineSeparator</h4> |
| <pre class="methodSignature">public void setLineSeparator​(<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 line separator. Can not be a null or empty string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>separator</code> - the new line separator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getColumnSeparatorPattern()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnSeparatorPattern</h4> |
| <pre class="methodSignature">public <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> getColumnSeparatorPattern()</pre> |
| <div class="block">Returns the pattern of characters used in column separators. Those characters will be used |
| only if more than one column is formatted. See <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> |
| for a description of the pattern syntax.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pattern of the current column separator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setColumnSeparatorPattern(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumnSeparatorPattern</h4> |
| <pre class="methodSignature">public void setColumnSeparatorPattern​(<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> pattern) |
| 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">Sets the pattern of the characters to insert between the columns. The pattern shall contain |
| exactly one occurrence of the <code>"[ ]"</code> pair of bracket, with exactly one character |
| between them. This character will be repeated as many time as needed for columns alignment. |
| |
| <p>The formatting pattern can optionally be followed by a regular expression to be used at |
| parsing time. If omitted, the parsing pattern will be inferred from the formatting pattern. |
| If specified, then the <a href="CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)"><code>parse</code></a> method will invoke |
| the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html?is-external=true#find()" title="class or interface in java.util.regex" class="externalLink"><code>Matcher.find()</code></a> method for determining the column boundaries.</p> |
| |
| <p>The characters listed below have special meaning in the pattern. |
| Other characters are appended <cite>as-is</cite> between the columns.</p> |
| |
| <table class="sis"> |
| <caption>Reserved characters</caption> |
| <tr><th>Character(s)</th> <th>Meaning</th></tr> |
| <tr><td><code>'?'</code></td> <td>Omit the column separator for trailing null values.</td></tr> |
| <tr><td><code>"[ ]"</code></td><td>Repeat the character between bracket as needed.</td></tr> |
| <tr><td><code>'/'</code></td> <td>Separate the formatting pattern from the parsing pattern.</td></tr> |
| <tr><td><code>'\\'</code></td> <td>Escape any of the characters listed in this table.</td></tr> |
| </table> |
| |
| <div class="section">Restrictions</div> |
| <ul> |
| <li>If present, <code>'?'</code> shall be the first character in the pattern.</li> |
| <li>The repeated character (specified inside the pair of brackets) is mandatory.</li> |
| <li>In the current implementation, the repeated character must be in the |
| Basic Multilanguage Plane.</li> |
| <li>If <code>'/'</code> is present, anything on its right side shall be compliant |
| with the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex" class="externalLink"><code>Pattern</code></a> syntax.</li> |
| </ul> |
| |
| <div class="note"><b>Example:</b> |
| The <code>"?……[…] "</code> pattern means <cite>"If the next value is non-null, then insert the |
| <code>"……"</code> string, repeat the <code>'…'</code> character as many time as needed (may be zero), |
| then insert a space"</cite>. |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern of the new column separator.</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 the given pattern is illegal.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getColumnSeparatorMatcher(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnSeparatorMatcher</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html?is-external=true" title="class or interface in java.util.regex" class="externalLink">Matcher</a> getColumnSeparatorMatcher​(<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)</pre> |
| <div class="block">Returns a matcher for the column separators in the given text. |
| This method is invoked by subclasses in their <code>parse(…)</code> implementations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>text</code> - the text for which to get a matcher.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a matcher for the column separators in the given text.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="TabularFormat.html" title="type parameter in TabularFormat">T</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="CompoundFormat.html#clone()">clone</a></code> in class <code><a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="TabularFormat.html" title="type parameter in TabularFormat">T</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/TabularFormat.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><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> |
