Class NaryTreeNode<D,N extends NaryTreeNode<D,N>>
- java.lang.Object
-
- org.arakhne.afc.math.tree.node.AbstractParentlessTreeNode<D,N>
-
- org.arakhne.afc.math.tree.node.AbstractTreeNode<D,N>
-
- org.arakhne.afc.math.tree.node.NaryTreeNode<D,N>
-
- Type Parameters:
D
- is the type of the data inside the treeN
- is the type of the tree nodes.
- All Implemented Interfaces:
Serializable
,Comparable<N>
,IterableNode<N>
,TreeNode<D,N>
,JsonableObject
- Direct Known Subclasses:
NaryTreeNode.DefaultNaryTreeNode
public abstract class NaryTreeNode<D,N extends NaryTreeNode<D,N>> extends AbstractTreeNode<D,N>
This is the generic implementation of a n-ary tree. This node has not a constant count of children. Indeed when a child node was removed, the count of children is also changed. It also means that a child node is nevernull
. If you want a generic implementation of a tree node which has always the same count of children, please seeConstantNaryTreeNode
.moveTo
According to its definition inTreeNode.moveTo(TreeNode, int)
, the binary tree node implementation ofmoveTo
does not replace any existing node at the position given as parameter ofmoveTo
. In placemoveTo
insert the moving node in the new parent.- Since:
- 13.0
- Version:
- 17.0 2020-01-04 14:41:41
- Author:
- Stéphane GALLAND
- See Also:
ConstantNaryTreeNode
, Serialized Form- Maven Group Id:
- org.arakhne.afc.core
- Maven Artifact Id:
- mathtree
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NaryTreeNode.DefaultNaryTreeNode<D>
This is the generic implementation of a n-ary tree.
-
Field Summary
-
Fields inherited from class org.arakhne.afc.math.tree.node.AbstractParentlessTreeNode
DEFAULT_COPY_USER_DATA, DEFAULT_LINK_LIST_USE, nodeListeners, notNullChildCount
-
-
Constructor Summary
Constructors Constructor Description NaryTreeNode()
Empty node.NaryTreeNode(boolean useLinkedList)
Constructor.NaryTreeNode(boolean useLinkedList, boolean copyDataCollection, List<D> data)
Constructor.NaryTreeNode(boolean useLinkedList, D data)
Constructor.NaryTreeNode(D data)
Constructor.NaryTreeNode(Collection<D> data)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addChild(int index, N newChild)
Add a child node at the specified index.boolean
addChild(N child)
Add a child node at the end of the children list.void
clear()
Clear the tree.N
getChildAt(int index)
Replies the n-th child in this node.int
getChildCount()
Replies count of children in this node.void
getChildren(Object[] array)
Replies the child nodes of this node.protected void
getHeights(int currentHeight, List<Integer> heights)
Replies the heights of all the leaf nodes.int
getMaxHeight()
Replies the maximal height of the tree.int
getMinHeight()
Replies the minimal height of the tree.int
getNotNullChildCount()
Replies count of not-null children in this node.Class<? extends Enum<?>>
getPartitionEnumeration()
Replies the enumeration type that is defining the children of the nodes.int
indexOf(N child)
Replies the index of the specified child.boolean
isLeaf()
Replies if this node is a leaf.boolean
moveTo(N newParent)
Move this node in the given new parent node.boolean
moveTo(N newParent, int index)
Move this node in the given new node.boolean
removeChild(N child)
Remove the specified node from this node if it is a child.boolean
setChildAt(int index, N newChild)
Set the n-th child in this node.protected void
setChildAtWithoutEventFiring(int index, N newChild)
Invoked by the inner classes to set the child at the given index without firing the events.-
Methods inherited from class org.arakhne.afc.math.tree.node.AbstractTreeNode
children, firePropertyChildAdded, firePropertyChildAdded, firePropertyChildRemoved, firePropertyChildRemoved, firePropertyParentChanged, firePropertyParentChanged, firePropertyParentChanged, getChildren, getDepth, getParentNode, isRoot, moveTo, removeDeeplyFromParent, removeFromParent, setParentNodeReference
-
Methods inherited from class org.arakhne.afc.math.tree.node.AbstractParentlessTreeNode
addTreeNodeListener, addUserData, addUserData, addUserData, addUserData, compareTo, firePropertyDataChanged, firePropertyDataChanged, firePropertyDataChanged, getAllUserData, getAllUserData, getDeepNodeCount, getDeepUserDataCount, getHeights, getInternalDataStructureForUserData, getUserData, getUserDataAt, getUserDataCount, isEmpty, isValid, removeAllUserData, removeTreeNodeListener, removeUserData, removeUserData, removeUserData, setUserData, setUserData, setUserDataAt, toJson, toN, toString
-
-
-
-
Constructor Detail
-
NaryTreeNode
public NaryTreeNode()
Empty node.
-
NaryTreeNode
public NaryTreeNode(Collection<D> data)
Constructor.- Parameters:
data
- are the initial user data.
-
NaryTreeNode
public NaryTreeNode(D data)
Constructor.- Parameters:
data
- are the initial user data.
-
NaryTreeNode
public NaryTreeNode(boolean useLinkedList)
Constructor.- Parameters:
useLinkedList
- indicates if a linked list must be used to store the data. Iffalse
, an ArrayList will be used.
-
NaryTreeNode
public NaryTreeNode(boolean useLinkedList, boolean copyDataCollection, List<D> data)
Constructor.- Parameters:
useLinkedList
- indicates if a linked list must be used to store the data. Iffalse
, an ArrayList will be used.copyDataCollection
- indicates if the given data collection is copied iftrue
or the inner data collection will be the given collection itself iffalse
.data
- are the initial user data
-
NaryTreeNode
public NaryTreeNode(boolean useLinkedList, D data)
Constructor.- Parameters:
useLinkedList
- indicates if a linked list must be used to store the data. Iffalse
, an ArrayList will be used.data
- are the initial user data
-
-
Method Detail
-
getPartitionEnumeration
@Pure public Class<? extends Enum<?>> getPartitionEnumeration()
Description copied from interface:TreeNode
Replies the enumeration type that is defining the children of the nodes.- Returns:
- the enumeration type of the child partition,
or
null
if no such enumeration type is defined.
-
clear
public void clear()
Clear the tree.Caution: this method also destroyes the links between the child nodes inside the tree. If you want to unlink the first-level child node with this node but leave the rest of the tree unchanged, please call
setChildAt(i,null)
.
-
getChildCount
@Pure public final int getChildCount()
Description copied from interface:IterableNode
Replies count of children in this node.The number of children is greater or equal to the value replied by
IterableNode.getNotNullChildCount()
.- Returns:
- the count of children.
- See Also:
IterableNode.getNotNullChildCount()
-
getNotNullChildCount
@Pure public int getNotNullChildCount()
Description copied from interface:IterableNode
Replies count of not-null children in this node.The number of not-null children is lower or equal to the value replied by
IterableNode.getChildCount()
.- Returns:
- the count of not-null children.
- See Also:
IterableNode.getChildCount()
-
indexOf
@Pure public final int indexOf(N child)
Description copied from interface:TreeNode
Replies the index of the specified child.- Parameters:
child
- is the node to search for.- Returns:
- the index or
-1
.
-
getChildAt
@Pure public final N getChildAt(int index) throws IndexOutOfBoundsException
Description copied from interface:IterableNode
Replies the n-th child in this node.- Parameters:
index
- is the index of the child to reply- Returns:
- the child node.
- Throws:
IndexOutOfBoundsException
- if the given index was invalid
-
moveTo
public boolean moveTo(N newParent)
Move this node in the given new parent node.This function adds this node at the end of the list of the children of the new parent node.
This function is preferred to a sequence of calls to
AbstractTreeNode.removeFromParent()
andsetChildAt(int, NaryTreeNode)
because it fires a limited set of events dedicated to the move the node.- Parameters:
newParent
- is the new parent for this node.- Returns:
true
on success, otherwisefalse
.
-
moveTo
public boolean moveTo(N newParent, int index)
Description copied from interface:TreeNode
Move this node in the given new node.If any child node is already present at the given position in the new parent node, the tree node may replace the existing node or insert the moving node according to its implementation.
This function is preferred to a sequence of calls to
IterableNode.removeFromParent()
andTreeNode.setChildAt(int, TreeNode)
because it fires a limited set of events dedicated to the move the node.- Parameters:
newParent
- is the new parent for this node.index
- is the position of this node in the new parent.- Returns:
true
on success, otherwisefalse
.
-
setChildAt
public boolean setChildAt(int index, N newChild) throws IndexOutOfBoundsException
Description copied from interface:TreeNode
Set the n-th child in this node.- Specified by:
setChildAt
in interfaceTreeNode<D,N extends NaryTreeNode<D,N>>
- Specified by:
setChildAt
in classAbstractTreeNode<D,N extends NaryTreeNode<D,N>>
- Parameters:
index
- is the index of the child to replynewChild
- is the new child node.- Returns:
true
if it was set, otherwisefalse
- Throws:
IndexOutOfBoundsException
- if the given index was invalid
-
setChildAtWithoutEventFiring
protected void setChildAtWithoutEventFiring(int index, N newChild) throws IndexOutOfBoundsException
Description copied from class:AbstractTreeNode
Invoked by the inner classes to set the child at the given index without firing the events. This function should never invokeAbstractTreeNode.setParentNodeReference(AbstractTreeNode, boolean)
.- Specified by:
setChildAtWithoutEventFiring
in classAbstractTreeNode<D,N extends NaryTreeNode<D,N>>
- Parameters:
index
- is the position of the new child.newChild
- is the new child- Throws:
IndexOutOfBoundsException
- if the index is invalid.
-
removeChild
public final boolean removeChild(N child)
Description copied from interface:TreeNode
Remove the specified node from this node if it is a child.- Parameters:
child
- is the child to remove.- Returns:
true
if the node was removed, otherwisefalse
-
addChild
public final boolean addChild(N child)
Add a child node at the end of the children list.- Parameters:
child
- is the new child to insert.- Returns:
true
on success, otherwisefalse
-
addChild
public final boolean addChild(int index, N newChild)
Add a child node at the specified index.- Parameters:
index
- is the insertion index.newChild
- is the new child to insert.- Returns:
true
on success, otherwisefalse
-
isLeaf
@Pure public final boolean isLeaf()
Description copied from interface:IterableNode
Replies if this node is a leaf.- Returns:
true
is this node is a leaf, otherwisefalse
-
getChildren
public void getChildren(Object[] array)
Description copied from interface:TreeNode
Replies the child nodes of this node.This function may put
null
in the array cells if the current tree node has not a child at the corresponding index.- Parameters:
array
- is the array to fill.- See Also:
TreeNode.getChildren(Class)
,TreeNode.children()
-
getMinHeight
@Pure public int getMinHeight()
Description copied from interface:TreeNode
Replies the minimal height of the tree.- Returns:
- the height of the uppest leaf in the tree.
-
getMaxHeight
@Pure public int getMaxHeight()
Description copied from interface:TreeNode
Replies the maximal height of the tree.- Returns:
- the height of the lowest leaf in the tree.
-
getHeights
protected void getHeights(int currentHeight, List<Integer> heights)
Description copied from class:AbstractParentlessTreeNode
Replies the heights of all the leaf nodes. The order of the heights is given by a depth-first iteration.- Specified by:
getHeights
in classAbstractParentlessTreeNode<D,N extends NaryTreeNode<D,N>>
- Parameters:
currentHeight
- is the current height of this node.heights
- is the list of heights to fill
-
-