| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>DefaultTreeTable (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, class: DefaultTreeTable"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.collection.DefaultTreeTable class"> |
| <meta name="keywords" content="getColumns()"> |
| <meta name="keywords" content="getRoot()"> |
| <meta name="keywords" content="setRoot()"> |
| <meta name="keywords" content="initialize()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <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"> |
| <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/DefaultTreeTable.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><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>Field | </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="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util.collection</a></div> |
| <h1 title="Class DefaultTreeTable" class="title">Class DefaultTreeTable</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">DefaultTreeTable</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="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultTreeTable</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a>, <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>, <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></span></div> |
| <div class="block">A <a href="TreeTable.html" title="interface in org.apache.sis.util.collection"><code>TreeTable</code></a> implementation with a <a href="#getColumns()">list of columns</a> given at |
| construction time. The list of columns is unmodifiable, but the <a href="#getRoot()">root node</a> |
| can be modified. |
| |
| Example: |
| |
| <blockquote><pre><font color="green">public</font> <font color="green">class</font> CityLocation { |
| <font color="green">public</font> <font color="green">static</font> <font color="green">final</font> TableColumn<String> CITY_NAME = <font color="green">new</font> TableColumn<>(String.<font color="green">class</font>, <font color="orangered">"City name"</font>); |
| <font color="green">public</font> <font color="green">static</font> <font color="green">final</font> TableColumn<Float> LATITUDE = <font color="green">new</font> TableColumn<>(Float.<font color="green">class</font>, <font color="orangered">"Latitude"</font>); |
| <font color="green">public</font> <font color="green">static</font> <font color="green">final</font> TableColumn<Float> LONGTITUDE = <font color="green">new</font> TableColumn<>(Float.<font color="green">class</font>, <font color="orangered">"Longitude"</font>); |
| |
| <font color="green">public</font> TreeTable <b>createTable</b>() { |
| DefaultTreeTable table = <font color="green">new</font> <b>DefaultTreeTable</b>(CITY_NAME, LATITUDE, LONGITUDE); |
| TreeTable.Node city = table.<b>getRoot</b>(); |
| city.<b>setValue</b>(CITY_NAME, <font color="orangered">"Rimouski"</font>); |
| city.<b>setValue</b>(LATITUDE, 48.470417); |
| city.<b>setValue</b>(LONGITUDE, -68.521385); |
| <font color="green">return</font> table; |
| } |
| }</pre></blockquote> |
| |
| The <code>setRoot(…)</code> method accepts arbitrary <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>TreeTable.Node</code></a> implementations. |
| However, it is likely to be safer and more memory efficient when used together with the |
| implementation provided in the <a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection"><code>DefaultTreeTable.Node</code></a> inner class.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection"><code>DefaultTreeTable.Node</code></a></li> |
| <li><a href="TableColumn.html" title="class in org.apache.sis.util.collection"><code>TableColumn</code></a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.util.collection.DefaultTreeTable">Serialized Form</a></li> |
| </ul> |
| </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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="DefaultTreeTable.Node.html" class="type-name-link" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>TreeTable.Node</code></a> implementation which can store values for a predefined list of columns.</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 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(org.apache.sis.util.collection.DefaultTreeTable.Node)" class="member-name-link">DefaultTreeTable</a><wbr>(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a> root)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new tree table initialized to the given root.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.util.collection.TableColumn...)" class="member-name-link">DefaultTreeTable</a><wbr>(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a><?>... columns)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new tree table with the given columns.</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="DefaultTreeTable.html" title="class in org.apache.sis.util.collection">DefaultTreeTable</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 table.</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="#equals(java.lang.Object)" class="member-name-link">equals</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> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares the given object with this tree table for equality.</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/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-tab4"><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-tab4"> |
| <div class="block">Returns the table columns given at construction time.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><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-tab4"> |
| <div class="block">Returns the root node.</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="#hashCode()" class="member-name-link">hashCode</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 hash code value for this table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize(org.apache.sis.util.collection.TreeTable.Node)" class="member-name-link">initialize</a><wbr>(<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a> root)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked when <a href="#getRoot()"><code>getRoot()</code></a> is invoked for the first time and no root had been specified to the constructor.</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="#setRoot(org.apache.sis.util.collection.TreeTable.Node)" class="member-name-link">setRoot</a><wbr>(<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a> root)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the root to the given node.</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/String.html" title="class or interface in java.lang" class="external-link">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="#toString()" class="member-name-link">toString</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 a string representation of this tree table.</div> |
| </div> |
| </div> |
| </div> |
| </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/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#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">getClass</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">notifyAll</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="<init>(org.apache.sis.util.collection.TableColumn...)"> |
| <h3>DefaultTreeTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultTreeTable</span><wbr><span class="parameters">(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a><?>... columns)</span></div> |
| <div class="block">Creates a new tree table with the given columns. The given array shall not be null or |
| empty, and shall not contain null or duplicated elements.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>columns</code> - the list of table columns.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.util.collection.DefaultTreeTable.Node)"> |
| <h3>DefaultTreeTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultTreeTable</span><wbr><span class="parameters">(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a> root)</span></div> |
| <div class="block">Creates a new tree table initialized to the given root. |
| The <a href="#getColumns()">list of columns</a> is inferred from the given node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>root</code> - the tree table root (cannot be null).</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="getColumns()"> |
| <h3>getColumns</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <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 given at construction time. |
| The returned list is never null neither empty.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="TreeTable.html#getColumns()">getColumns</a></code> in interface <code><a href="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a></code></dd> |
| <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="DefaultTreeTable.Node.html#getValue(org.apache.sis.util.collection.TableColumn)"><code>DefaultTreeTable.Node.getValue(TableColumn)</code></a></li> |
| <li><a href="DefaultTreeTable.Node.html#setValue(org.apache.sis.util.collection.TableColumn,V)"><code>DefaultTreeTable.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="modifiers">public</span> <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. This method returns the node specified at |
| <a href="#%3Cinit%3E(org.apache.sis.util.collection.DefaultTreeTable.Node)">construction time</a> or to the |
| last call of the <a href="#setRoot(org.apache.sis.util.collection.TreeTable.Node)"><code>setRoot(TreeTable.Node)</code></a> method.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="TreeTable.html#getRoot()">getRoot</a></code> in interface <code><a href="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the root node of the tree.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRoot(org.apache.sis.util.collection.TreeTable.Node)"> |
| <h3>setRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRoot</span><wbr><span class="parameters">(<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a> root)</span></div> |
| <div class="block">Sets the root to the given node. If a root already existed prior this method call, |
| then the previous root node will be discarded.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>root</code> - the new root node (cannot be null).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the table columns in the given node are inconsistent |
| with the table columns in this <code>DefaultTreeTable</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initialize(org.apache.sis.util.collection.TreeTable.Node)"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">initialize</span><wbr><span class="parameters">(<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a> root)</span></div> |
| <div class="block">Invoked when <a href="#getRoot()"><code>getRoot()</code></a> is invoked for the first time and no root had been specified to the constructor. |
| The <code>root</code> argument is a newly created empty node to be returned by <a href="#getRoot()"><code>getRoot()</code></a>. |
| The default implementation does nothing. |
| Subclasses can override for lazy initialization of tree table content.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>root</code> - a newly created tree table root.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</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="DefaultTreeTable.html" title="class in org.apache.sis.util.collection">DefaultTreeTable</a></span> <span class="element-name">clone</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CloneNotSupportedException.html" title="class or interface in java.lang" class="external-link">CloneNotSupportedException</a></span></div> |
| <div class="block">Returns a clone of this table. This method clones the <a href="#getRoot()">root</a> node. |
| If the root is an instance of <a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection"><code>DefaultTreeTable.Node</code></a>, then cloning the root will recursively clone |
| all its <a href="DefaultTreeTable.Node.html#getChildren()">children</a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <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></dd> |
| <dt>Returns:</dt> |
| <dd>a clone of this table.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CloneNotSupportedException.html" title="class or interface in java.lang" class="external-link">CloneNotSupportedException</a></code> - if this table, the root node or one of its children |
| cannot be cloned.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="DefaultTreeTable.Node.html#clone()"><code>DefaultTreeTable.Node.clone()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</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> other)</span></div> |
| <div class="block">Compares the given object with this tree table for equality. This method compares the |
| <a href="#getColumns()">columns</a> and the <a href="#getRoot()">root node</a>. If the |
| later is an instance of the <a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection"><code>DefaultTreeTable.Node</code></a> inner class, then all node values and children |
| will be compared recursively.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><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></code> in class <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - the object to compare with this table.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the two objects are equal.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultTreeTable.Node.html#equals(java.lang.Object)"><code>DefaultTreeTable.Node.equals(Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Returns a hash code value for this table. |
| This method is defined for consistency with <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> contract.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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">hashCode</a></code> in class <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></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultTreeTable.Node.html#hashCode()"><code>DefaultTreeTable.Node.hashCode()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns a string representation of this tree table. |
| The current implementation uses a shared instance of <a href="TreeTableFormat.html" title="class in org.apache.sis.util.collection"><code>TreeTableFormat</code></a>. |
| This is okay for debugging or occasional usages. However for more extensive usages, |
| developers are encouraged to create and configure their own <a href="TreeTableFormat.html" title="class in org.apache.sis.util.collection"><code>TreeTableFormat</code></a> |
| instance.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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">toString</a></code> in class <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></dd> |
| <dt>Returns:</dt> |
| <dd>a string representation of this tree table.</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> |