| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>TreeTable (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.util.collection, interface: TreeTable"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.collection.TreeTable interface"> |
| <meta name="keywords" content="getColumns()"> |
| <meta name="keywords" content="getRoot()"> |
| <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"> </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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/TreeTable.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>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.sis.util.collection</a></div> |
| <h1 title="Interface TreeTable" class="title">Interface TreeTable</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DefaultTreeTable.html" title="class in org.apache.sis.util.collection">DefaultTreeTable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TreeTable</span></div> |
| <div class="block">Defines the structure (list of columns) of a table and provides the root of the tree |
| containing the data. <code>TreeTable</code> can be seen as a table in which the first |
| column contains a tree. Every row in this table is a <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>TreeTable.Node</code></a> instance, and each |
| node can have an arbitrary number of <a href="TreeTable.Node.html#getChildren()">children</a> nodes. |
| |
| <p>Below is an example of what a two-columns <code>TreeTable</code> instance may look like |
| when <a href="TreeTableFormat.html" title="class in org.apache.sis.util.collection">formatted as a text</a>:</p> |
| |
| <blockquote><pre>Citation |
| ├─Title…………………………………………………………… Open Geospatial Consortium |
| ├─Presentation Forms………………………… document digital |
| ├─Cited Responsible Parties |
| │ ├─Organisation Name………………… Open Geospatial Consortium |
| │ ├─Role…………………………………………………… resource provider |
| │ └─Contact Info |
| │ └─Online Resource |
| │ ├─Linkage……………………… https://www.ogc.org/ |
| │ └─Function…………………… information |
| └─Identifiers |
| └─Code…………………………………………………… OGC</pre></blockquote> |
| |
| <p>In many cases, the columns are known in advance as hard-coded static constants. |
| Those column constants are typically documented close to the class producing the |
| <code>TreeTable</code> instance. Using directly those static constants provides type |
| safety, as in the following example:</p> |
| |
| <blockquote><pre>TreeTable table = ...; <i><font color="gray">// Put here a TreeTable instance.</font></i> |
| TreeTable.Node node = table.<b>getRoot</b>(); |
| CharSequence name = node.<b>getValue</b>(TableColumn.NAME); |
| Class<?> type = node.<b>getValue</b>(TableColumn.TYPE);</pre></blockquote> |
| |
| In the above example, the type of value returned by the <a href="TreeTable.Node.html#getValue(org.apache.sis.util.collection.TableColumn)"><code>TreeTable.Node.getValue(TableColumn)</code></a> |
| method is determined by the column constant. However, this approach is possible only when |
| the table structure is known in advance. If a method needs to work with arbitrary tables, |
| then that method can get the list of columns by a call to <a href="#getColumns()"><code>getColumns()</code></a>. However |
| this column list does not provide the above type-safety.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="TreeTable.Node.html" class="type-name-link" title="interface in org.apache.sis.util.collection">TreeTable.Node</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A node in a tree combined with a row in a table.</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a><?>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getColumns()" class="member-name-link">getColumns</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the table columns, in the order they shall be rendered by default.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRoot()" class="member-name-link">getRoot</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the root node of the tree.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getColumns()"> |
| <h3>getColumns</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a><?>></span> <span class="element-name">getColumns</span>()</div> |
| <div class="block">Returns the table columns, in the order they shall be rendered by default. |
| This method returns the union of all table columns in every nodes of this |
| tree. However, any <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>TreeTable.Node</code></a> instance can return <code>null</code> for a |
| particular column if the node doesn't have that column.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the union of all table columns in every tree node.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="TreeTable.Node.html#getValue(org.apache.sis.util.collection.TableColumn)"><code>TreeTable.Node.getValue(TableColumn)</code></a></li> |
| <li><a href="TreeTable.Node.html#setValue(org.apache.sis.util.collection.TableColumn,V)"><code>TreeTable.Node.setValue(TableColumn, Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoot()"> |
| <h3>getRoot</h3> |
| <div class="member-signature"><span class="return-type"><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a></span> <span class="element-name">getRoot</span>()</div> |
| <div class="block">Returns the root node of the tree.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the root node of the tree.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
