blob: f5c7f93625ebba20b86a2963ea772df42e0f19a7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>FeatureFormat (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.feature, class: FeatureFormat">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.feature.FeatureFormat class">
<meta name="keywords" content="getValueType()">
<meta name="keywords" content="getLocale()">
<meta name="keywords" content="getAllowedColumns()">
<meta name="keywords" content="setAllowedColumns()">
<meta name="keywords" content="format()">
<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="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/FeatureFormat.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#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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.feature</a></div>
<h1 title="Class FeatureFormat" class="title">Class FeatureFormat</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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/16/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>&lt;T&gt;
<div class="inheritance"><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;
<div class="inheritance">FeatureFormat</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/16/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/16/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">FeatureFormat</span>
<span class="extends-implements">extends <a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span></div>
<div class="block">Formats <a href="AbstractFeature.html" title="class in org.apache.sis.feature">features</a> or <a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">feature types</a> 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> a feature named “City” and containing 3 properties (“name”, “population” and
“twin town”) may be formatted like below. The two first properties are <a href="AbstractAttribute.html" title="class in org.apache.sis.feature">attributes</a>
while the last property is an <a href="AbstractAssociation.html" title="class in org.apache.sis.feature">association</a> to another feature.
<blockquote><pre>City
┌────────────┬─────────┬──────────────┬───────────┐
│ Name │ Type │ Multiplicity │ Value │
├────────────┼─────────┼──────────────┼───────────┤
│ name │ String │ [1 … 1] │ Paderborn │
│ population │ Integer │ [1 … 1] │ 143,174 │
│ twin town │ City │ [0 … ∞] │ Le Mans │
└────────────┴─────────┴──────────────┴───────────┘</pre></blockquote></div>
<h2>Limitations</h2>
<ul>
<li>The current implementation can only format features — parsing is not yet implemented.</li>
<li><code>Feature­Format</code>, like most <code>java​.text​.Format</code> subclasses, is not thread-safe.</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.5</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../serialized-form.html#org.apache.sis.feature.FeatureFormat">Serialized Form</a></li>
</ul>
</dd>
<p><font size="-1">Defined in the <code>sis-feature</code> module</font></p>
</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="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="FeatureFormat.Column.html" class="type-name-link" title="enum class in org.apache.sis.feature">Feature­Format​.Column</a></code></div>
<div class="col-last even-row-color">
<div class="block">Identifies the columns to include in the table formatted by <code>Feature­Format</code>.</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-java.text.Format">Nested classes/interfaces inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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&nbsp;<a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a></h3>
<code><a href="../io/TabularFormat.html#beforeFill">before­Fill</a>, <a href="../io/TabularFormat.html#columnSeparator">column­Separator</a>, <a href="../io/TabularFormat.html#fillCharacter">fill­Character</a>, <a href="../io/TabularFormat.html#lineSeparator">line­Separator</a>, <a href="../io/TabularFormat.html#omitTrailingNulls">omit­Trailing­Nulls</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()" class="member-name-link">Feature­Format</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new formatter for the default locale and timezone.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Locale,java.util.TimeZone)" class="member-name-link">Feature­Format</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">Time­Zone</a>&nbsp;timezone)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new formatter for the given locale and timezone.</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-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="FeatureFormat.html" title="class in org.apache.sis.feature">Feature­Format</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>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(java.lang.Object,java.lang.Appendable)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>&nbsp;to­Append­To)</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 object to the given stream of buffer.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FeatureFormat.Column.html" title="enum class in org.apache.sis.feature">Feature­Format​.Column</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllowedColumns()" class="member-name-link">get­Allowed­Columns</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 all columns that may be shown in the tables to 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/16/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">get­Locale</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.Category.html" title="class or interface in java.util" class="external-link">Locale​.Category</a>&nbsp;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/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</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">get­Value­Type</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><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-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/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>&nbsp;text,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/ParsePosition.html" title="class or interface in java.text" class="external-link">Parse­Position</a>&nbsp;pos)</code></div>
<div class="col-last odd-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 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="#setAllowedColumns(java.util.Set)" class="member-name-link">set­Allowed­Columns</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FeatureFormat.Column.html" title="enum class in org.apache.sis.feature">Feature­Format​.Column</a>&gt;&nbsp;inclusion)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets all columns that may be shown in the tables to format.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-TabularFormat">Methods inherited from class&nbsp;<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)">get­Column­Separator­Matcher</a>, <a href="../io/TabularFormat.html#getColumnSeparatorPattern()">get­Column­Separator­Pattern</a>, <a href="../io/TabularFormat.html#getLineSeparator()">get­Line­Separator</a>, <a href="../io/TabularFormat.html#setColumnSeparatorPattern(java.lang.String)">set­Column­Separator­Pattern</a>, <a href="../io/TabularFormat.html#setLineSeparator(java.lang.String)">set­Line­Separator</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-CompoundFormat">Methods inherited from class&nbsp;<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)">create­Format</a>, <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)">get­Format</a>, <a href="../io/CompoundFormat.html#getLocale()">get­Locale</a>, <a href="../io/CompoundFormat.html#getTimeZone()">get­Time­Zone</a>, <a href="../io/CompoundFormat.html#parseObject(java.lang.String)">parse­Object</a>, <a href="../io/CompoundFormat.html#parseObject(java.lang.String,java.text.ParsePosition)">parse­Object</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Format">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/docs/api/java.base/java/text/Format.html#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="external-link">format­To­Character­Iterator</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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="&lt;init&gt;()">
<h3>FeatureFormat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FeatureFormat</span>()</div>
<div class="block">Creates a new formatter for the default locale and timezone.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.Locale,java.util.TimeZone)">
<h3>FeatureFormat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FeatureFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a>&nbsp;timezone)</span></div>
<div class="block">Creates a new formatter for the given locale and timezone.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>locale</code> - the locale, or <code>null</code> for <code>Locale​.ROOT</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="getValueType()">
<h3>getValueType</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name">getValueType</span>()</div>
<div class="block">Returns the type of objects formatted by this class. This method has to return <code>Object​.class</code>
since it is the only common parent to <code>Feature</code> and <code>Feature­Type</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../io/CompoundFormat.html#getValueType()">get­Value­Type</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd><code>Object​.class</code></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>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">getLocale</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.Category.html" title="class or interface in java.util" class="external-link">Locale.Category</a>&nbsp;category)</span></div>
<div class="block">Returns the locale for the given category.
<ul>
<li><a href="https://docs.oracle.com/en/java/javase/16/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> specifies the locale to use for values.</li>
<li><a href="https://docs.oracle.com/en/java/javase/16/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> specifies the locale to use for labels.</li>
</ul></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../io/CompoundFormat.html#getLocale(java.util.Locale.Category)">get­Locale</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</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>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAllowedColumns()">
<h3>getAllowedColumns</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FeatureFormat.Column.html" title="enum class in org.apache.sis.feature">FeatureFormat.Column</a>&gt;</span>&nbsp;<span class="element-name">getAllowedColumns</span>()</div>
<div class="block">Returns all columns that may be shown in the tables to format.
The columns included in the set may be shown, but not necessarily;
some columns will still be omitted if they are completely empty.
However, columns <em>not</em> included in the set are guaranteed to be omitted.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>all columns that may be shown in the tables to format.</dd>
<dt>Since:</dt>
<dd>0.8</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAllowedColumns(java.util.Set)">
<h3>setAllowedColumns</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAllowedColumns</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FeatureFormat.Column.html" title="enum class in org.apache.sis.feature">FeatureFormat.Column</a>&gt;&nbsp;inclusion)</span></div>
<div class="block">Sets all columns that may be shown in the tables to format.
Note that the columns specified to this method are not guaranteed to be shown;
some columns will still be omitted if they are completely empty.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>inclusion</code> - all columns that may be shown in the tables to format.</dd>
<dt>Since:</dt>
<dd>0.8</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="format(java.lang.Object,java.lang.Appendable)">
<h3>format</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>&nbsp;toAppendTo)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/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 object to the given stream of buffer.
The object may be an instance of any of the following types:
<ul>
<li><code>Feature</code></li>
<li><code>Feature­Type</code></li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../io/CompoundFormat.html#format(T,java.lang.Appendable)">format</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>object</code> - the object to format.</dd>
<dd><code>to­Append­To</code> - where to format the object.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/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="parse(java.lang.CharSequence,java.text.ParsePosition)">
<h3>parse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;text,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/ParsePosition.html" title="class or interface in java.text" class="external-link">ParsePosition</a>&nbsp;pos)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/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>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</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/16/docs/api/java.base/java/text/ParseException.html" title="class or interface in java.text" class="external-link">Parse­Exception</a></code> - currently always thrown.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="FeatureFormat.html" title="class in org.apache.sis.feature">FeatureFormat</a></span>&nbsp;<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>&nbsp;in class&nbsp;<code><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">Tabular­Format</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</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>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>