com.exasol.util

Class AbstractTreeNode

java.lang.Object

com.exasol.util.AbstractTreeNode

All Implemented Interfaces:

TreeNode

Direct Known Subclasses:

AbstractFunction, BinaryArithmeticExpression

public abstract class AbstractTreeNode
extends Object
implements TreeNode

This is an abstract base class for nodes in a tree structure.

Constructor Summary

Constructors

Constructor and Description
AbstractTreeNode() Create a new instance of a AbstractTreeNode that serves as root for a tree.

Method Summary

Modifier and Type	Method and Description
void	addChild(TreeNode child) Add a child node below this node.
TreeNode	getChild(int index) Get child node by position in the list of siblings.
List<TreeNode>	getChildren() Get all child nodes of this node
TreeNode	getParent() Get the parent of this node
TreeNode	getRoot() Get the root of the tree
boolean	isChild() Check whether this node is a child node
boolean	isFirstSibling() Check whether a child is the first in the list of siblings
boolean	isRoot() Check whether this node is the root of the tree.
boolean	isSibling(TreeNode node) Check whether this node is a sibling of the second node.
void	setParent(TreeNode parent) Link to a parent node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTreeNode

public AbstractTreeNode()

Create a new instance of a AbstractTreeNode that serves as root for a tree.

Method Detail

setParent

public void setParent(TreeNode parent)

Link to a parent node

Specified by:

setParent in interface TreeNode

Parameters:

parent - the parent to which this node will be linked as a child

Throws:

IllegalArgumentException - if parent is null or parent and child are identical

getRoot

public TreeNode getRoot()

Description copied from interface: TreeNode

Get the root of the tree

Specified by:

getRoot in interface TreeNode

Returns:

root node

getParent

public TreeNode getParent()

Description copied from interface: TreeNode

Get the parent of this node

Specified by:

getParent in interface TreeNode

Returns:

parent node

addChild

public void addChild(TreeNode child)

Description copied from interface: TreeNode

Add a child node below this node. Children are registered in the order in which they are added.

Important: this also automatically creates a link in the opposite direction. All implementations must adhere to this rule.

Specified by:

addChild in interface TreeNode

Parameters:

child - child node

getChildren

public List<TreeNode> getChildren()

Description copied from interface: TreeNode

Get all child nodes of this node

Specified by:

getChildren in interface TreeNode

Returns:

child nodes

getChild

public TreeNode getChild(int index)

Description copied from interface: TreeNode

Get child node by position in the list of siblings. The position depends on the order in which the children were added.

Specified by:

getChild in interface TreeNode

Parameters:

index - position in the list of siblings

Returns:

child node at position

isRoot

public boolean isRoot()

Description copied from interface: TreeNode

Check whether this node is the root of the tree.

Specified by:

isRoot in interface TreeNode

Returns:

true if this node is the root

isChild

public boolean isChild()

Description copied from interface: TreeNode

Check whether this node is a child node

Specified by:

isChild in interface TreeNode

Returns:

true if the node is a child of another node

isFirstSibling

public boolean isFirstSibling()

Description copied from interface: TreeNode

Check whether a child is the first in the list of siblings

Specified by:

isFirstSibling in interface TreeNode

Returns:

true if the child is the first in the list of siblings

isSibling

public boolean isSibling(TreeNode node)

Description copied from interface: TreeNode

Check whether this node is a sibling of the second node.

Specified by:

isSibling in interface TreeNode

Parameters:

node - second node

Returns:

true if two nodes are siblings