blob: 545992c7f259615612892b9e82934bb925f257fe [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>TableColumn (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.util.collection, class: TableColumn">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.util.collection.TableColumn class">
<meta name="keywords" content="NAME">
<meta name="keywords" content="IDENTIFIER">
<meta name="keywords" content="INDEX">
<meta name="keywords" content="TYPE">
<meta name="keywords" content="VALUE">
<meta name="keywords" content="VALUE_AS_TEXT">
<meta name="keywords" content="VALUE_AS_NUMBER">
<meta name="keywords" content="REMARKS">
<meta name="keywords" content="getHeader()">
<meta name="keywords" content="getElementType()">
<meta name="keywords" content="toString()">
<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">&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="../../../../../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>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<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>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&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><a href="#field-detail">Field</a>&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="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.sis.util</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.util.collection</a></div>
<h1 title="Class TableColumn" class="title">Class TableColumn&lt;V&gt;</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">TableColumn&lt;V&gt;</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>V</code> - base type of all values in the column identified by this instance.</dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="CheckedContainer.html" title="interface in org.apache.sis.util.collection">Checked­Container</a>&lt;V&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TableColumn&lt;V&gt;</span>
<span class="extends-implements">extends <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>
implements <a href="CheckedContainer.html" title="interface in org.apache.sis.util.collection">CheckedContainer</a>&lt;V&gt;</span></div>
<div class="block">Identifies a column in <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>Tree­Table​.Node</code></a> instances.
Each <code>Table­Column</code> instance contains the column header and the type of values
for a particular column. <code>Table­Column</code>s are used for fetching values from nodes
as in the following example:
<div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../../copy.svg" alt="Copy snippet"></button>
<pre class="snippet"><code class="language-java">public class CityLocation {
public static final ColumnTable&lt;String&gt; CITY_NAME = new ColumnTable&lt;&gt;(String.class, "City name");
public static final ColumnTable&lt;Float&gt; LATITUDE = new ColumnTable&lt;&gt;(Float.class, "Latitude");
public static final ColumnTable&lt;Float&gt; LONGITUDE = new ColumnTable&lt;&gt;(Float.class, "Longitude");
private String name;
private float latitude;
private float longitude;
CityLocation(TreeTable.Node myNode) {
name = myNode.getValue(CITY_NAME);
latitude = myNode.getValue(LATITUDE);
longitude = myNode.getValue(LONGITUDE);
}
}
</code></pre>
</div>
<h2 id="identity-comparisons-and-serialization-heading">Identity comparisons and serialization</h2>
This base class relies on <cite>identity comparisons</cite> instead of defining the
<code>equals(Object)</code> method, because the <a href="#getElementType()">element type</a>
is not a sufficient criterion for differentiating the columns (many columns have values
of the same type) and the <a href="#getHeader()">header</a> is arbitrary. Consequently
developers who create their own instances are encouraged to declare them as static final
constants as in the above example, and use those constants consistently.
<p>This base class is not serializable because the default deserialization mechanism does
not resolve automatically the deserialized instances to the above-cited singleton instances.
Developers who need serialization support for their own instances have to resolve them in
their own subclass. The following example is one possible way to achieve that goal:</p>
<div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../../copy.svg" alt="Copy snippet"></button>
<pre class="snippet"><code class="language-java">public class CityLocation {
public static final ColumnTable&lt;String&gt; CITY_NAME = new Column&lt;&gt;("CITY_NAME", String.class, "City name");
public static final ColumnTable&lt;Float&gt; LATITUDE = new Column&lt;&gt;("LATITUDE", Float.class, "Latitude");
public static final ColumnTable&lt;Float&gt; LONGITUDE = new Column&lt;&gt;("LONGITUDE", Float.class, "Longitude");
private static final class Column&lt;V&gt; extends TableColumn&lt;V&gt; implements Serializable {
private final String field;
private Column(String field, Class&lt;V&gt; type, CharSequence header) {
super(type, header);
this.field = field;
}
private Object readResolve() throws ObjectStreamException {
try {
return CityLocation.class.getField(field).get(null);
} catch (Exception cause) { // Many exceptions, including unchecked ones.
throw new InvalidObjectException(cause.toString());
}
}
}
}
</code></pre>
</div>
The constants defined in this class use a similar approach for providing serialization support.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#IDENTIFIER" class="member-name-link">IDENTIFIER</a></code></div>
<div class="col-last even-row-color">
<div class="block">Frequently-used constant for a column of object identifiers.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#INDEX" class="member-name-link">INDEX</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Frequently-used constant for a column of index values.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<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">Char­Sequence</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#NAME" class="member-name-link">NAME</a></code></div>
<div class="col-last even-row-color">
<div class="block">Frequently-used constant for a column of object names.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<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">Char­Sequence</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#REMARKS" class="member-name-link">REMARKS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Frequently-used constant for a column of remarks.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<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>&lt;?&gt;&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#TYPE" class="member-name-link">TYPE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Frequently-used constant for a column of object types.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<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>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#VALUE" class="member-name-link">VALUE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Frequently-used constant for a column of object values.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#VALUE_AS_NUMBER" class="member-name-link">VALUE_AS_NUMBER</a></code></div>
<div class="col-last even-row-color">
<div class="block">Frequently-used constant for a column of object numerical values.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TableColumn.html" title="class in org.apache.sis.util.collection">Table­Column</a><wbr>&lt;<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">Char­Sequence</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#VALUE_AS_TEXT" class="member-name-link">VALUE_AS_TEXT</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Frequently-used constant for a column of object textual values.</div>
</div>
</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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Table­Column</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Invoked on deserialization for creating an initially empty instance.</div>
</div>
<div class="col-first odd-row-color"><code>&nbsp;</code></div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.Class,java.lang.CharSequence)" class="member-name-link">Table­Column</a><wbr>(<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>&lt;<a href="TableColumn.html" title="type parameter in TableColumn">V</a>&gt;&nbsp;type,
<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">Char­Sequence</a>&nbsp;header)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new instance for the given type of values.</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>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>&lt;<a href="TableColumn.html" title="type parameter in TableColumn">V</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="#getElementType()" class="member-name-link">get­Element­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 base type of all values in any column identified by this <code>Table­Column</code> instance.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">International­String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeader()" class="member-name-link">get­Header</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 the text to display as column header.</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/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">to­String</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 string representation of this table column.</div>
</div>
</div>
</div>
</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/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#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <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">get­Class</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">hash­Code</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">notify­All</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">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="NAME">
<h3>NAME</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">NAME</span></div>
<div class="block">Frequently-used constant for a column of object names.
The column <a href="#getHeader()">header</a> is <cite>"Name"</cite> (eventually localized) and
the column elements are typically instances of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>International­String</code></a>,
depending on whether the data provide localization support or not.</div>
</section>
</li>
<li>
<section class="detail" id="IDENTIFIER">
<h3>IDENTIFIER</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">IDENTIFIER</span></div>
<div class="block">Frequently-used constant for a column of object identifiers.
The column <a href="#getHeader()">header</a> is <cite>"Identifier"</cite> (eventually localized)
and the column elements are instances of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="INDEX">
<h3>INDEX</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</span>&nbsp;<span class="element-name">INDEX</span></div>
<div class="block">Frequently-used constant for a column of index values.
The column <a href="#getHeader()">header</a> is <cite>"Index"</cite> (eventually localized)
and the column elements are instances of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="TYPE">
<h3>TYPE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<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>&lt;?&gt;&gt;</span>&nbsp;<span class="element-name">TYPE</span></div>
<div class="block">Frequently-used constant for a column of object types.
The column <a href="#getHeader()">header</a> is <cite>"Type"</cite> (eventually localized).</div>
</section>
</li>
<li>
<section class="detail" id="VALUE">
<h3>VALUE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">VALUE</span></div>
<div class="block">Frequently-used constant for a column of object values.
The column <a href="#getHeader()">header</a> is <cite>"Value"</cite> (eventually localized) and
the column elements can be instance of any kind of objects.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#VALUE_AS_TEXT"><code>VALUE_AS_TEXT</code></a></li>
<li><a href="#VALUE_AS_NUMBER"><code>VALUE_AS_NUMBER</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="VALUE_AS_TEXT">
<h3>VALUE_AS_TEXT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">VALUE_AS_TEXT</span></div>
<div class="block">Frequently-used constant for a column of object textual values.
The column <a href="#getHeader()">header</a> is <cite>"Value"</cite> (eventually localized) and
the column elements are typically instances of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>International­String</code></a>,
depending on whether the data provide localization support or not.</div>
</section>
</li>
<li>
<section class="detail" id="VALUE_AS_NUMBER">
<h3>VALUE_AS_NUMBER</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&gt;</span>&nbsp;<span class="element-name">VALUE_AS_NUMBER</span></div>
<div class="block">Frequently-used constant for a column of object numerical values.
The column <a href="#getHeader()">header</a> is <cite>"Value"</cite> (eventually localized).</div>
</section>
</li>
<li>
<section class="detail" id="REMARKS">
<h3>REMARKS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">REMARKS</span></div>
<div class="block">Frequently-used constant for a column of remarks.
The column <a href="#getHeader()">header</a> is <cite>"Remarks"</cite> (eventually localized) and
the column elements are typically instances of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>International­String</code></a>,
depending on whether the data provide localization support or not.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.0</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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>TableColumn</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">TableColumn</span>()</div>
<div class="block">Invoked on deserialization for creating an initially empty instance.
This constructor has <code>protected</code> visibility only because the Java deserialization
mechanism requires so; this constructor shall not be invoked in any other context.
See the <cite>Identity comparisons and serialization</cite> section in the class
javadoc for more information.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.Class,java.lang.CharSequence)">
<h3>TableColumn</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TableColumn</span><wbr><span class="parameters">(<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>&lt;<a href="TableColumn.html" title="type parameter in TableColumn">V</a>&gt;&nbsp;type,
<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>&nbsp;header)</span></div>
<div class="block">Creates a new instance for the given type of values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - base type of all values in the column identified by this instance.</dd>
<dd><code>header</code> - the text to display as column header.</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="getHeader()">
<h3>getHeader</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></span>&nbsp;<span class="element-name">getHeader</span>()</div>
<div class="block">Returns the text to display as column header.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the text to display as column header.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getElementType()">
<h3>getElementType</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/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="TableColumn.html" title="type parameter in TableColumn">V</a>&gt;</span>&nbsp;<span class="element-name">getElementType</span>()</div>
<div class="block">Returns the base type of all values in any column identified by this <code>Table­Column</code> instance.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="CheckedContainer.html#getElementType()">get­Element­Type</a></code>&nbsp;in interface&nbsp;<code><a href="CheckedContainer.html" title="interface in org.apache.sis.util.collection">Checked­Container</a>&lt;<a href="TableColumn.html" title="type parameter in TableColumn">V</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>the element type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block">Returns a string representation of this table column.
The default implementation returns the <a href="#getHeader()">header</a> in its default locale.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><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">to­String</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>