| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>StatisticsFormat (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.util, package: org.apache.sis.math, class: StatisticsFormat"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.math.StatisticsFormat class"> |
| <meta name="keywords" content="getInstance()"> |
| <meta name="keywords" content="getLocale()"> |
| <meta name="keywords" content="getValueType()"> |
| <meta name="keywords" content="isForAllPopulation()"> |
| <meta name="keywords" content="setForAllPopulation()"> |
| <meta name="keywords" content="getBorderWidth()"> |
| <meta name="keywords" content="setBorderWidth()"> |
| <meta name="keywords" content="parse()"> |
| <meta name="keywords" content="format()"> |
| <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="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><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> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.math</a></div> |
| <h1 title="Class StatisticsFormat" class="title">Class StatisticsFormat</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link">Format</a> |
| <div class="inheritance"><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>> |
| <div class="inheritance"><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>> |
| <div class="inheritance">StatisticsFormat</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StatisticsFormat</span> |
| <span class="extends-implements">extends <a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></span></div> |
| <div class="block">Formats a <a href="Statistics.html" title="class in org.apache.sis.math"><code>Statistics</code></a> object. |
| By default, newly created <code>StatisticsFormat</code> instances will format statistical values |
| in a tabular format using spaces as the column separator. |
| |
| <h2 id="example-heading">Example</h2> |
| <pre class="text"> |
| Number of values: 8726 |
| Minimum value: 6.853 |
| Maximum value: 8.259 |
| Mean value: 7.421 |
| Root Mean Square: 7.846 |
| Standard deviation: 6.489</pre> |
| |
| <h2 id="limitations-heading">Limitations</h2> |
| <ul> |
| <li>The current implementation can only format features — parsing is not yet implemented.</li> |
| <li><code>StatisticsFormat</code>, like most <code>java.text.Format</code> subclasses, is not thread-safe.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="Statistics.html#toString()"><code>Statistics.toString()</code></a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.math.StatisticsFormat">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.text.Format">Nested classes/interfaces inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link">Format</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.Field.html" title="class or interface in java.text" class="external-link">Format.Field</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-TabularFormat">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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Locale,java.util.Locale,java.util.TimeZone)" class="member-name-link">StatisticsFormat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> headerLocale, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timezone)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new format for the given numeric and header locales.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a clone of this format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> toAppendTo, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/FieldPosition.html" title="class or interface in java.text" class="external-link">FieldPosition</a> pos)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the given statistics.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(org.apache.sis.math.Statistics%5B%5D,java.lang.Appendable)" class="member-name-link">format</a><wbr>(<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>[] stats, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> toAppendTo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the given statistics in a tabular format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(org.apache.sis.math.Statistics,java.lang.Appendable)" class="member-name-link">format</a><wbr>(<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a> stats, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> toAppendTo)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a localized string representation of the given statistics.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBorderWidth()" class="member-name-link">getBorderWidth</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the "width" of the border to drawn around the table, in number of lines.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an instance for the current system default locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.util.Locale)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an instance for the given locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale(java.util.Locale.Category)" class="member-name-link">getLocale</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.Category.html" title="class or interface in java.util" class="external-link">Locale.Category</a> category)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the locale for the given category.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueType()" class="member-name-link">getValueType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the type of objects formatted by this class.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isForAllPopulation()" class="member-name-link">isForAllPopulation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if this formatter shall consider that the statistics where computed |
| using the totality of the populations under study.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parse(java.lang.CharSequence,java.text.ParsePosition)" class="member-name-link">parse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> text, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/ParsePosition.html" title="class or interface in java.text" class="external-link">ParsePosition</a> pos)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Not yet supported.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBorderWidth(int)" class="member-name-link">setBorderWidth</a><wbr>(int borderWidth)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the "width" of the border to drawn around the table, in number of lines.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setForAllPopulation(boolean)" class="member-name-link">setForAllPopulation</a><wbr>(boolean allPopulation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets whether this formatter shall consider that the statistics where computed using |
| the totality of the populations under study.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-TabularFormat">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-CompoundFormat">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#createFormat(java.lang.Class)">createFormat</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#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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Format">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link">Format</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.html#format(java.lang.Object)" title="class or interface in java.text" class="external-link">format</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/Format.html#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="external-link">formatToCharacterIterator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Locale,java.util.Locale,java.util.TimeZone)"> |
| <h3>StatisticsFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StatisticsFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> headerLocale, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timezone)</span></div> |
| <div class="block">Constructs a new format for the given numeric and header locales. |
| The timezone is used only if the values added to the <a href="Statistics.html" title="class in org.apache.sis.math"><code>Statistics</code></a> are dates.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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/en/java/javase/11/docs/api/java.base/java/util/Locale.html#ROOT" title="class or interface in java.util" class="external-link">root locale</a>.</dd> |
| <dd><code>headerLocale</code> - the locale for row and column headers. Usually same as <code>locale</code>.</dd> |
| <dd><code>timezone</code> - the timezone, or <code>null</code> for UTC.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getInstance()"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></span> <span class="element-name">getInstance</span>()</div> |
| <div class="block">Returns an instance for the current system default locale.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a statistics format instance for the current default locale.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(java.util.Locale)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block">Returns an instance for the given locale.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - the locale for which to get a <code>StatisticsFormat</code> instance.</dd> |
| <dt>Returns:</dt> |
| <dd>a statistics format instance for the given locale.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocale(java.util.Locale.Category)"> |
| <h3>getLocale</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span> <span class="element-name">getLocale</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.Category.html" title="class or interface in java.util" class="external-link">Locale.Category</a> category)</span></div> |
| <div class="block">Returns the locale for the given category. This method implements the following mapping: |
| |
| <ul> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.Category.html#DISPLAY" title="class or interface in java.util" class="external-link"><code>Locale.Category.DISPLAY</code></a> — the <code>headerLocale</code> given at construction time.</li> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.Category.html#FORMAT" title="class or interface in java.util" class="external-link"><code>Locale.Category.FORMAT</code></a> — the <code>locale</code> given at construction time, |
| used for all values below the header row.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../io/CompoundFormat.html#getLocale(java.util.Locale.Category)">getLocale</a></code> in class <code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>category</code> - the category for which a locale is desired.</dd> |
| <dt>Returns:</dt> |
| <dd>the locale for the given category (never <code>null</code>).</dd> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueType()"> |
| <h3>getValueType</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></span> <span class="element-name">getValueType</span>()</div> |
| <div class="block">Returns the type of objects formatted by this class.</div> |
| <dl class="notes"> |
| <dt>Specified by:</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="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>Statistics.class</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isForAllPopulation()"> |
| <h3>isForAllPopulation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isForAllPopulation</span>()</div> |
| <div class="block">Returns <code>true</code> if this formatter shall consider that the statistics where computed |
| using the totality of the populations under study. This information impacts the standard |
| deviation values to be formatted.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the statistics to format where computed using the totality of |
| the populations under study.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="Statistics.html#standardDeviation(boolean)"><code>Statistics.standardDeviation(boolean)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForAllPopulation(boolean)"> |
| <h3>setForAllPopulation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForAllPopulation</span><wbr><span class="parameters">(boolean allPopulation)</span></div> |
| <div class="block">Sets whether this formatter shall consider that the statistics where computed using |
| the totality of the populations under study. The default value is <code>false</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>allPopulation</code> - <code>true</code> if the statistics to format where computed using |
| the totality of the populations under study.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="Statistics.html#standardDeviation(boolean)"><code>Statistics.standardDeviation(boolean)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBorderWidth()"> |
| <h3>getBorderWidth</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBorderWidth</span>()</div> |
| <div class="block">Returns the "width" of the border to drawn around the table, in number of lines. |
| The default width is 0, which stands for no border.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the border "width" in number of lines.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBorderWidth(int)"> |
| <h3>setBorderWidth</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBorderWidth</span><wbr><span class="parameters">(int borderWidth)</span></div> |
| <div class="block">Sets the "width" of the border to drawn around the table, in number of lines. |
| The value can be any of the following: |
| |
| <ul> |
| <li>0 (the default) for no border</li> |
| <li>1 for single line (<code>│</code>,<code>─</code>)</li> |
| <li>2 for double lines (<code>║</code>,<code>═</code>)</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>borderWidth</code> - the border width, in number of lines.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parse(java.lang.CharSequence,java.text.ParsePosition)"> |
| <h3>parse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a></span> <span class="element-name">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> text, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/ParsePosition.html" title="class or interface in java.text" class="external-link">ParsePosition</a> pos)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/ParseException.html" title="class or interface in java.text" class="external-link">ParseException</a></span></div> |
| <div class="block">Not yet supported.</div> |
| <dl class="notes"> |
| <dt>Specified by:</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="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>text</code> - the character sequence for the object to parse.</dd> |
| <dd><code>pos</code> - the position where to start the parsing. |
| On return, the position where the parsing stopped or where an error occurred.</dd> |
| <dt>Returns:</dt> |
| <dd>currently never return.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/ParseException.html" title="class or interface in java.text" class="external-link">ParseException</a></code> - currently always thrown.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a></span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> toAppendTo, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/FieldPosition.html" title="class or interface in java.text" class="external-link">FieldPosition</a> pos)</span></div> |
| <div class="block">Formats the given statistics. This method will delegates to one of the following methods, |
| depending on the type of the given object: |
| |
| <ul> |
| <li><a href="#format(org.apache.sis.math.Statistics,java.lang.Appendable)"><code>format(Statistics, Appendable)</code></a></li> |
| <li><a href="#format(org.apache.sis.math.Statistics%5B%5D,java.lang.Appendable)"><code>format(Statistics[], Appendable)</code></a></li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../io/CompoundFormat.html#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)">format</a></code> in class <code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to format.</dd> |
| <dd><code>toAppendTo</code> - where to format the object.</dd> |
| <dd><code>pos</code> - ignored in current implementation.</dd> |
| <dt>Returns:</dt> |
| <dd>the given buffer, returned for convenience.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(org.apache.sis.math.Statistics,java.lang.Appendable)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a> stats, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> toAppendTo)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Formats a localized string representation of the given statistics. |
| If statistics on <a href="Statistics.html#differences()">differences</a> |
| are associated to the given object, they will be formatted too.</div> |
| <dl class="notes"> |
| <dt>Specified by:</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="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stats</code> - the statistics to format.</dd> |
| <dd><code>toAppendTo</code> - where to format the statistics.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurred while writing to the given appendable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(org.apache.sis.math.Statistics[],java.lang.Appendable)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a>[] stats, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> toAppendTo)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Formats the given statistics in a tabular format. This method does not check |
| for the statistics on <a href="Statistics.html#differences()">differences</a> - if |
| such statistics are wanted, they must be included in the given array.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stats</code> - the statistics to format.</dd> |
| <dd><code>toAppendTo</code> - where to format the statistics.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurred while writing to the given appendable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></span> <span class="element-name">clone</span>()</div> |
| <div class="block">Returns a clone of this format.</div> |
| <dl class="notes"> |
| <dt>Overrides:</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="Statistics.html" title="class in org.apache.sis.math">Statistics</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>a clone of this format.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
