org.bimserver.charting.Containers

Class TreeNode

java.lang.Object

org.bimserver.charting.Containers.TreeNode

public class TreeNode
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
TreeNode[]	Children An array of all this node's child nodes.
String	Class A string representing the key of the ModelDimension that the data in Name came from.
TreeNode	CollapsesInto
ChartRow	Data A handle to the assigned object encapsulated by this node.
String	Name A string representation of the value of the data at the hierarchy location.
Double	Size Relative size of the node.

Constructor Summary

Constructors

Constructor and Description
TreeNode() Constructs a tree node object.
TreeNode(ChartRow userObject) Constructs a tree node object.

Method Summary

Modifier and Type	Method and Description
void	add(TreeNode child) Adds the child node to this container making this its parent.
void	add(TreeNode child, Integer index) Adds the child node to this container making this its parent.
TreeNode[]	children() Gets a list of all the child nodes of this node.
void	collapseAllNodesWithNullNames()
static TreeNode	Consume(ChartRows filteredData, ModelDimension hierarchy, ModelDimension size)
static TreeNode	Consume(ChartRows filteredData, ModelDimension hierarchy, ModelDimension size, Double minimumSize)
static TreeNode	ConsumeByGroup(ChartRows filteredData, ModelDimension group, ModelDimension size)
int	depth() Gets this node's depth in the tree.
TreeNode	get(Integer index)
TreeNode	get(String className)
TreeNode	get(String className, String name)
TreeNode	getByName(String name)
ChartRow	getData() Gets the object attached to this node.
int	getLeafNodeCount()
TreeNode	getMajorBranch()
TreeNode	getParent() Gets the parent node of this one.
String	getTooltip()
boolean	hasChildren() Returns if this node has children or if it is a leaf node.
Integer	index() Gets the position of this node in the list of siblings managed by the parent node.
boolean	isLeaf()
boolean	isParentRoot()
boolean	isRoot() Returns if this node is the root node in the tree or not.
Iterator<TreeNode>	iterateFromLeafNodesToRoot()
Iterator<TreeNode>	iterateFromRootToLeafNodes()
Iterator<TreeNode>	iterateLeafNodes()
boolean	leavesAreAtSameDepth()
int	maximumLeafDepth()
int	minimumLeafDepth()
void	padParentWithXNodesThatCollapseIntoThisNode(TreeNode thisNode, int delta)
void	padTreeSoThatLeafNodesAreAllTheSameDepth()
void	parseIntoPrefuseTree(prefuse.data.Tree tree)
TreeNode	remove(int index) Removes the child at position index from the tree.
boolean	removeFromParent() Removes this node from its parent.
void	setData(ChartRow userObject) Attaches an object to this node.
void	walkLeafNodes(ITreeNodeHandler callback)
void	walkNodesFromLeavesToRoot(ITreeNodeHandler callback)
void	walkNodesFromRootToLeaves(ITreeNodeHandler callback)

Methods inherited from class java.lang.Object

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

Field Detail

Children

public TreeNode[] Children

An array of all this node's child nodes.

Data

public ChartRow Data

A handle to the assigned object encapsulated by this node.

Name

public String Name

A string representation of the value of the data at the hierarchy location. Should not exist on leaf nodes. Leaf nodes are considered to be the value of the hierarchy at such a level.

Class

public String Class

A string representing the key of the ModelDimension that the data in Name came from. Should exist on all nodes.

Size

public Double Size

Relative size of the node. 1.0 is a pass-through.

CollapsesInto

public TreeNode CollapsesInto

Constructor Detail

TreeNode

public TreeNode()

Constructs a tree node object.

TreeNode

public TreeNode(ChartRow userObject)

Constructs a tree node object.

Parameters:

userObject -

Method Detail

getParent

public TreeNode getParent()

Gets the parent node of this one.

Returns:

getTooltip

public String getTooltip()

getData

public ChartRow getData()

Gets the object attached to this node. It must be cast back to what it was inserted as.

Returns:

setData

public void setData(ChartRow userObject)

Attaches an object to this node. Only one object can be attached to a node.

Parameters:

userObject -

add

public void add(TreeNode child)

Adds the child node to this container making this its parent. The child is appended to the list of children as the last child.

Parameters:

child -

add

public void add(TreeNode child,
                Integer index)

Adds the child node to this container making this its parent.

Parameters:

child -

index -

remove

public TreeNode remove(int index)

Removes the child at position index from the tree.

Parameters:

index -

Returns:

The removed child node.

removeFromParent

public boolean removeFromParent()

Removes this node from its parent. This node becomes the root of a subtree where all of its children become first level nodes.

isRoot

public boolean isRoot()

Returns if this node is the root node in the tree or not.

Returns:

isLeaf

public boolean isLeaf()

isParentRoot

public boolean isParentRoot()

getMajorBranch

public TreeNode getMajorBranch()

children

public TreeNode[] children()

Gets a list of all the child nodes of this node.

Returns:

hasChildren

public boolean hasChildren()

Returns if this node has children or if it is a leaf node.

Returns:

getLeafNodeCount

public int getLeafNodeCount()

get

public TreeNode get(Integer index)

get

public TreeNode get(String className)

get

public TreeNode get(String className,
                    String name)

getByName

public TreeNode getByName(String name)

index

public Integer index()

Gets the position of this node in the list of siblings managed by the parent node. This node can be obtained by this = parent.children[this.index()].

Returns:

The index of the child array of this node's parent. If this is the root node it will return null.

depth

public int depth()

Gets this node's depth in the tree. The root node will have a depth of 0, first-level nodes will have a depth of 1, and so on.

Returns:

The depth of this node in the tree.

maximumLeafDepth

public int maximumLeafDepth()

minimumLeafDepth

public int minimumLeafDepth()

leavesAreAtSameDepth

public boolean leavesAreAtSameDepth()

walkNodesFromRootToLeaves

public void walkNodesFromRootToLeaves(ITreeNodeHandler callback)

walkNodesFromLeavesToRoot

public void walkNodesFromLeavesToRoot(ITreeNodeHandler callback)

walkLeafNodes

public void walkLeafNodes(ITreeNodeHandler callback)

iterateFromRootToLeafNodes

public Iterator<TreeNode> iterateFromRootToLeafNodes()

iterateFromLeafNodesToRoot

public Iterator<TreeNode> iterateFromLeafNodesToRoot()

iterateLeafNodes

public Iterator<TreeNode> iterateLeafNodes()

Consume

public static TreeNode Consume(ChartRows filteredData,
                               ModelDimension hierarchy,
                               ModelDimension size)

Consume

public static TreeNode Consume(ChartRows filteredData,
                               ModelDimension hierarchy,
                               ModelDimension size,
                               Double minimumSize)

Parameters:

filteredData -

hierarchy -

size -

minimumSize -

Returns:

ConsumeByGroup

public static TreeNode ConsumeByGroup(ChartRows filteredData,
                                      ModelDimension group,
                                      ModelDimension size)

parseIntoPrefuseTree

public void parseIntoPrefuseTree(prefuse.data.Tree tree)

Parameters:

tree -

collapseAllNodesWithNullNames

public void collapseAllNodesWithNullNames()

padTreeSoThatLeafNodesAreAllTheSameDepth

public void padTreeSoThatLeafNodesAreAllTheSameDepth()

padParentWithXNodesThatCollapseIntoThisNode

public void padParentWithXNodesThatCollapseIntoThisNode(TreeNode thisNode,
                                                        int delta)

Parameters:

thisNode -

delta -