blob: 22a174092f7a721a2914f3ca613579e972ab17df [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>DefaultTreeTable.Node (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.util.collection.DefaultTreeTable.Node class">
<meta name="keywords" content="getParent()">
<meta name="keywords" content="isLeaf()">
<meta name="keywords" content="getChildren()">
<meta name="keywords" content="newChild()">
<meta name="keywords" content="getValue()">
<meta name="keywords" content="setValue()">
<meta name="keywords" content="isEditable()">
<meta name="keywords" content="getUserObject()">
<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="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultTreeTable.Node (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultTreeTable.Node.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.util.collection</a></div>
<h2 title="Class DefaultTreeTable.Node" class="title">Class DefaultTreeTable.Node</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li>Node</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="DefaultTreeTable.html" title="class in org.apache.sis.util.collection">DefaultTreeTable</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">DefaultTreeTable.Node</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre>
<div class="block">A <a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection"><code>Tree­Table​.Node</code></a> implementation which can store values for a pre-defined list of columns.
The list of columns is specified by a <a href="TreeTable.html" title="interface in org.apache.sis.util.collection"><code>Tree­Table</code></a>, or inherited from a parent node.
<div class="section">Note on the parent node</div>
The value returned by the <a href="#getParent()"><code>get­Parent()</code></a> method is updated automatically when this node
is <em>added to</em> or <em>removed from</em> the <a href="#getChildren()">list of children</a>
of another <code>Node</code> instance - there is no <code>set­Parent(Node)</code> method. Since the parent
is inferred rather than user-specified, it is ignored by the <a href="#clone()"><code>clone()</code></a>,
<a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> and <a href="#hashCode()"><code>hash­Code()</code></a> methods.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultTreeTable.html" title="class in org.apache.sis.util.collection"><code>Default­Tree­Table</code></a>,
<a href="TableColumn.html" title="class in org.apache.sis.util.collection"><code>Table­Column</code></a>,
<a href="../../../../../serialized-form.html#org.apache.sis.util.collection.DefaultTreeTable.Node">Serialized Form</a></dd>
<p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.CharSequence)">Node</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Creates a node with a single column for object names (<cite>convenience constructor</cite>).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.util.collection.DefaultTreeTable.Node)">Node</a></span>&#8203;(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;parent)</code></th>
<td class="colLast">
<div class="block">Creates a new node with the given parent.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.util.collection.DefaultTreeTable.Node,int)">Node</a></span>&#8203;(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;parent,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Creates a new node with the given parent.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.util.collection.TreeTable)">Node</a></span>&#8203;(<a href="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a>&nbsp;table)</code></th>
<td class="colLast">
<div class="block">Creates a new node for the given table.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a clone of this node without parent.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares the given object with this node for <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>
and <a href="#getChildren()">children</a> equality, ignoring the <a href="#getParent()">parent</a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildren()">getChildren</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the children of this node.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parent of this node.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserObject()">getUserObject</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the user object associated to this node.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;V</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(org.apache.sis.util.collection.TableColumn)">getValue</a></span>&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;V&gt;&nbsp;column)</code></th>
<td class="colLast">
<div class="block">Returns the value in the given column, or <code>null</code> if none.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a hash-code value computed from the <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>
and <a href="#getChildren()">children</a>, ignoring the <a href="#getParent()">parent</a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEditable(org.apache.sis.util.collection.TableColumn)">isEditable</a></span>&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;?&gt;&nbsp;column)</code></th>
<td class="colLast">
<div class="block">Determines whether the value in the specified column is editable.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLeaf()">isLeaf</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this node can not have any children.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newChild()">newChild</a></span>()</code></th>
<td class="colLast">
<div class="block">Adds a new child in the <a href="#getChildren()">children list</a>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(org.apache.sis.util.collection.TableColumn,V)">setValue</a></span>&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;V&gt;&nbsp;column,
V&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Sets the value for the given column.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a string representation of this node for identification in error message or in debugger.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.sis.util.collection.TreeTable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Node</h4>
<pre>public&nbsp;Node&#8203;(<a href="TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a>&nbsp;table)</pre>
<div class="block">Creates a new node for the given table. The new node will be able to store a value
for each <a href="TreeTable.html#getColumns()">columns</a> defined in the given table.
<p>This method does not set the new node as the root of the given table. If desired, it
is the caller responsibility to <a href="DefaultTreeTable.html#setRoot(org.apache.sis.util.collection.TreeTable.Node)">set the table root
node</a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - the table for which this node is created.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sis.util.collection.DefaultTreeTable.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Node</h4>
<pre>public&nbsp;Node&#8203;(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;parent)</pre>
<div class="block">Creates a new node with the given parent. The new node is added at the end of the parent
<a href="#getChildren()">list of children</a>. The new node will be able to store values
for the same columns than the parent node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent of the new node.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sis.util.collection.DefaultTreeTable.Node,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Node</h4>
<pre>public&nbsp;Node&#8203;(<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;parent,
int&nbsp;index)</pre>
<div class="block">Creates a new node with the given parent. The new node is added to the parent
<a href="#getChildren()">list of children</a> at the given index. The new node
will be able to store values for the same columns than the parent node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent of the new node.</dd>
<dd><code>index</code> - the index where to add the new node in the parent list of children.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Node</h4>
<pre>public&nbsp;Node&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;name)</pre>
<div class="block">Creates a node with a single column for object names (<cite>convenience constructor</cite>).
The node will have the following columns:
<table class="sis">
<caption>Node columns</caption>
<tr><th>Header</th> <th>Type</th> <th>Initial value</th></tr>
<tr><td>"Name"</td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>CharSequence</code></a></td> <td><code>name</code></td></tr>
</table></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the initial value for the "Name" column (can be <code>null</code>).</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre class="methodSignature">public final&nbsp;<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a>&nbsp;getParent()</pre>
<div class="block">Returns the parent of this node. On <code>Node</code> creation, this value may be initially
<code>null</code>. It will be automatically set to a non-null value when this node will be
added as a child of another <code>Node</code> instance.
<p>Note that the parent is intentionally ignored by the <a href="#clone()"><code>clone()</code></a>,
<a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> and <a href="#hashCode()"><code>hash­Code()</code></a> methods.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#getParent()">get­Parent</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parent, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="isLeaf()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLeaf</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isLeaf()</pre>
<div class="block">Returns <code>true</code> if this node can not have any children. The default implementation
unconditionally returns <code>false</code> even if the list of children is empty, because the
list is allowed to grow at any time.
<p>Subclasses can override this method if they can determine which nodes are leaves.
In the current implementation, the return value shall be stable (i.e. a node can not
alternate between leaf and non-leaf state). However this restriction may be relaxed
in a future SIS version.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#isLeaf()">is­Leaf</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this node can not have any children.</dd>
</dl>
</li>
</ul>
<a id="getChildren()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre class="methodSignature">public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">TreeTable.Node</a>&gt;&nbsp;getChildren()</pre>
<div class="block">Returns the children of this node. For non-leaf nodes, the list is modifiable and will
automatically updates the <a href="#getParent()">parent</a> reference of any <code>Node</code>
instance added to or removed from the list.
<p>For leaf nodes, this method returns an unmodifiable
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collections.html?is-external=true#emptyList()" title="class or interface in java.util" class="externalLink">empty list</a>.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#getChildren()">get­Children</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the children, or an empty collection if none.</dd>
</dl>
</li>
</ul>
<a id="newChild()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newChild</h4>
<pre class="methodSignature">public&nbsp;<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;newChild()</pre>
<div class="block">Adds a new child in the <a href="#getChildren()">children list</a>.
The default implementation first checks that this node is not a leaf,
then delegates to the <code>Node(Node)</code> constructor.
That constructor call has the following implications:
<ul>
<li>The new node inherits the columns of this node, on the assumption that
they are the same set of columns than other children nodes.</li>
<li>The new node is appended at the end of the children list.</li>
</ul>
Subclasses may override this method with different behavior.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#newChild()">new­Child</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new child.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Unsupported­Operation­Exception</a></code> - if this node <a href="#isLeaf()">is a leaf</a>.</dd>
</dl>
</li>
</ul>
<a id="getValue(org.apache.sis.util.collection.TableColumn)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature">public&nbsp;&lt;V&gt;&nbsp;V&nbsp;getValue&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;V&gt;&nbsp;column)</pre>
<div class="block">Returns the value in the given column, or <code>null</code> if none.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#getValue(org.apache.sis.util.collection.TableColumn)">get­Value</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - the base type of values in the given column.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - identifier of the column from which to get the value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value in the given column, or <code>null</code> if none.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="TreeTable.html#getColumns()"><code>Tree­Table​.get­Columns()</code></a></dd>
</dl>
</li>
</ul>
<a id="setValue(org.apache.sis.util.collection.TableColumn,java.lang.Object)">
<!-- -->
</a><a id="setValue(org.apache.sis.util.collection.TableColumn,V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre class="methodSignature">public&nbsp;&lt;V&gt;&nbsp;void&nbsp;setValue&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;V&gt;&nbsp;column,
V&nbsp;value)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre>
<div class="block">Sets the value for the given column.
The <a href="#isEditable(org.apache.sis.util.collection.TableColumn)"><code>is­Editable(Table­Column)</code></a> method can be invoked before this setter method
for determining if the given column is modifiable.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#setValue(org.apache.sis.util.collection.TableColumn,V)">set­Value</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - the base type of values in the given column.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - identifier of the column into which to set the value.</dd>
<dd><code>value</code> - the value to set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­Argument­Exception</a></code> - if the given column is not a legal column for this node.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#isEditable(org.apache.sis.util.collection.TableColumn)"><code>is­Editable(Table­Column)</code></a></dd>
</dl>
</li>
</ul>
<a id="isEditable(org.apache.sis.util.collection.TableColumn)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEditable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEditable&#8203;(<a href="TableColumn.html" title="class in org.apache.sis.util.collection">TableColumn</a>&lt;?&gt;&nbsp;column)</pre>
<div class="block">Determines whether the value in the specified column is editable. If the given
column is not a legal column for this <code>Node</code> instance, then this method
returns <code>false</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#isEditable(org.apache.sis.util.collection.TableColumn)">is­Editable</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - the column to query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the given column is a legal column for this <code>Node</code>
implementation and the corresponding value is editable, or <code>false</code>
otherwise.</dd>
</dl>
</li>
</ul>
<a id="getUserObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserObject</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getUserObject()</pre>
<div class="block">Returns the user object associated to this node.
The default implementation returns <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#getUserObject()">get­User­Object</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>any object stored at this node by the user, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="DefaultTreeTable.Node.html" title="class in org.apache.sis.util.collection">DefaultTreeTable.Node</a>&nbsp;clone()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">CloneNotSupportedException</a></pre>
<div class="block">Returns a clone of this node without parent.
This method recursively clones all <a href="#getChildren()">children</a>,
but does not clone the column <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>.
The parent of the cloned node is set to <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a clone of this node without parent.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Clone­Not­Supported­Exception</a></code> - if this node or one of its children can not be cloned.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;other)</pre>
<div class="block">Compares the given object with this node for <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>
and <a href="#getChildren()">children</a> equality, ignoring the <a href="#getParent()">parent</a>. This method can be used for determining if two branches of a same tree or of two
different trees are identical.
<div class="note"><b>Implementation note:</b> This method ignores the parent because:
<ul>
<li>When comparing the children recursively, comparing the parents would cause infinite recursivity.</li>
<li>For consistency with the <a href="#clone()"><code>clone()</code></a> method, which can not clone the parent.</li>
<li>For making possible to compare branches instead than only whole trees.</li>
</ul></div></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#equals(java.lang.Object)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the object to compare with this node.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the two objects are equal, ignoring the parent node.</dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash-code value computed from the <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>
and <a href="#getChildren()">children</a>, ignoring the <a href="#getParent()">parent</a>.
This method is defined for consistency with <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> contract.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TreeTable.Node.html#hashCode()">hash­Code</a></code>&nbsp;in interface&nbsp;<code><a href="TreeTable.Node.html" title="interface in org.apache.sis.util.collection">Tree­Table​.Node</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hash­Code</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code for this node, potentially based on values and children but ignoring parent.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<div class="block">Returns a string representation of this node for identification in error message or in debugger.
The default implementation returns the <code>to­String()</code> value of the first non-empty
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Char­Sequence</code></a> found in the <a href="#getValue(org.apache.sis.util.collection.TableColumn)">values</a>, if any.
If no such value is found, then this method returns "<var>Node</var>-<var>i</var>"
where <var>Node</var> is the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink">simple classname</a>
and <var>i</var> is the index of this node in the parent node.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">to­String</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this node.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultTreeTable.Node.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>