Object
Node
- All Implemented Interfaces:
Serializable,Cloneable,TreeTable.Node
- Enclosing class:
DefaultTreeTable
public static class DefaultTreeTable.Node
extends Object
implements TreeTable.Node, Cloneable, Serializable
A
TreeTable.Node implementation which can store values for a predefined list of columns.
The list of columns is specified by a TreeTable, or inherited from a parent node.
Note on the parent node
The value returned by thegetParent() method is updated automatically when this node
is added to or removed from the list of children
of another Node instance - there is no setParent(Node) method. Since the parent
is inferred rather than user-specified, it is ignored by the clone(),
equals(Object) and hashCode() methods.- Since:
- 0.3
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionNode(CharSequence name) Creates a node with a single column for object names (convenience constructor).Node(DefaultTreeTable.Node parent) Creates a new node with the given parent.Node(DefaultTreeTable.Node parent, int index) Creates a new node with the given parent.Node(TreeTable table) Creates a new node for the given table. -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a clone of this node without parent.booleanfinal List<TreeTable.Node> Returns the children of this node.final TreeTable.NodeReturns the parent of this node.Returns the user object associated to this node.<V> VgetValue(TableColumn<V> column) Returns the value in the given column, ornullif none.intbooleanisEditable(TableColumn<?> column) Determines whether the value in the specified column is editable.booleanisLeaf()Returnstrueif this node cannot have any children.Adds a new child in the children list.<V> voidsetValue(TableColumn<V> column, V value) Sets the value for the given column.Returns a string representation of this node for identification in error message or in debugger.
-
Constructor Details
-
Node
Creates a new node for the given table. The new node will be able to store a value for each columns defined in the given table.This method does not set the new node as the root of the given table. If desired, it is the caller responsibility to set the table root node.
- Parameters:
table- the table for which this node is created.
-
Node
Creates a new node with the given parent. The new node is added at the end of the parent list of children. The new node will be able to store values for the same columns than the parent node.- Parameters:
parent- the parent of the new node.
-
Node
Creates a new node with the given parent. The new node is added to the parent list of children at the given index. The new node will be able to store values for the same columns than the parent node.- Parameters:
parent- the parent of the new node.index- the index where to add the new node in the parent list of children.
-
Node
Creates a node with a single column for object names (convenience constructor). The node will have the following columns:Node columns Header Type Initial value "Name" CharSequencename- Parameters:
name- the initial value for the "Name" column (can benull).
-
-
Method Details
-
getParent
Returns the parent of this node. OnNodecreation, this value may be initiallynull. It will be automatically set to a non-null value when this node will be added as a child of anotherNodeinstance.Note that the parent is intentionally ignored by the
clone(),equals(Object)andhashCode()methods.- Specified by:
getParentin interfaceTreeTable.Node- Returns:
- the parent, or
nullif none.
-
isLeaf
public boolean isLeaf()Returnstrueif this node cannot have any children. The default implementation unconditionally returnsfalseeven if the list of children is empty, because the list is allowed to grow at any time.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 cannot alternate between leaf and non-leaf state). However, this restriction may be relaxed in a future SIS version.
- Specified by:
isLeafin interfaceTreeTable.Node- Returns:
trueif this node cannot have any children.
-
getChildren
Returns the children of this node. For non-leaf nodes, the list is modifiable and will automatically updates the parent reference of anyNodeinstance added to or removed from the list.For leaf nodes, this method returns an unmodifiable empty list.
- Specified by:
getChildrenin interfaceTreeTable.Node- Returns:
- the children, or an empty collection if none.
-
newChild
Adds a new child in the children list. The default implementation first checks that this node is not a leaf, then delegates to theNode(Node)constructor. That constructor call has the following implications:- The new node inherits the columns of this node, on the assumption that they are the same set of columns than other children nodes.
- The new node is appended at the end of the children list.
- Specified by:
newChildin interfaceTreeTable.Node- Returns:
- the new child.
- Throws:
UnsupportedOperationException- if this node is a leaf.
-
getValue
Returns the value in the given column, ornullif none.- Specified by:
getValuein interfaceTreeTable.Node- Type Parameters:
V- the base type of values in the given column.- Parameters:
column- identifier of the column from which to get the value.- Returns:
- the value in the given column, or
nullif none. - See Also:
-
setValue
Sets the value for the given column. TheisEditable(TableColumn)method can be invoked before this setter method for determining if the given column is modifiable.- Specified by:
setValuein interfaceTreeTable.Node- Type Parameters:
V- the base type of values in the given column.- Parameters:
column- identifier of the column into which to set the value.value- the value to set.- Throws:
IllegalArgumentException- if the given column is not a legal column for this node.- See Also:
-
isEditable
Determines whether the value in the specified column is editable. If the given column is not a legal column for thisNodeinstance, then this method returnsfalse.- Specified by:
isEditablein interfaceTreeTable.Node- Parameters:
column- the column to query.- Returns:
trueif the given column is a legal column for thisNodeimplementation and the corresponding value is editable, orfalseotherwise.
-
getUserObject
Returns the user object associated to this node. The default implementation returnsnull.- Specified by:
getUserObjectin interfaceTreeTable.Node- Returns:
- any object stored at this node by the user, or
nullif none.
-
clone
Returns a clone of this node without parent. This method recursively clones all children, but does not clone the column values. The parent of the cloned node is set tonull.- Overrides:
clonein classObject- Returns:
- a clone of this node without parent.
- Throws:
CloneNotSupportedException- if this node or one of its children cannot be cloned.
-
equals
Compares the given object with this node for values and children equality, ignoring the parent. This method can be used for determining if two branches of a same tree or of two different trees are identical.Implementation note
This method ignores the parent because:- When comparing the children recursively, comparing the parents would cause infinite recursivity.
- For consistency with the
clone()method, which cannot clone the parent. - For making possible to compare branches instead of only whole trees.
- Specified by:
equalsin interfaceTreeTable.Node- Overrides:
equalsin classObject- Parameters:
other- the object to compare with this node.- Returns:
trueif the two objects are equal, ignoring the parent node.
-
hashCode
public int hashCode()Returns a hash-code value computed from the values and children, ignoring the parent. This method is defined for consistency withequals(Object)contract.- Specified by:
hashCodein interfaceTreeTable.Node- Overrides:
hashCodein classObject- Returns:
- a hash code for this node, potentially based on values and children but ignoring parent.
-
toString
Returns a string representation of this node for identification in error message or in debugger. The default implementation returns thetoString()value of the first non-emptyCharSequencefound in the values, if any. If no such value is found, then this method returns "Node-i" where Node is the simple classname and i is the index of this node in the parent node.
-