org.ginsim.core.graph.tree

Class TreeBuilder

java.lang.Object

org.ginsim.core.graph.tree.TreeBuilder

Direct Known Subclasses:

TreeBuilderFromCircuit, TreeBuilderFromMDD

public abstract class TreeBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	max_depth The level of the last depth (corresponding to the terminal node in widthPerDepth)
protected int	max_terminal Indicates the maximum count of terminal.
protected List<RegulatoryNode>	nodeOrder
static String	PARAM_NODEORDER
protected int[]	realDetph As the omdd diagram could not contain all the levels (some could be skipped...), we try to reduce the tree width, by assigning a depth to each __used__ level.
protected int	total_levels The total number of levels that are not skipped
protected Tree	tree
protected int[]	widthPerDepth Indicates for each depth, the sub-total (width) of children or 0 if the depth is not skipped (realDepth == -1).
protected int[]	widthPerDepth_acc Indicates for each depth, the total (width) of children or 0 if the depth is not skipped (realDepth == -1).

Constructor Summary

Constructors

Constructor and Description
TreeBuilder()

Method Summary

Modifier and Type	Method and Description
protected List<TreeNode>	addChildren(int j, int mult, List<TreeNode> parents, int childIndex, int[] currentWidthPerDepth, EdgeAttributesReader ereader)
void	clearTree() Remove all the vertices from the tree
protected void	computeWidthPerDepthFromRegGraph()
int	getMaxDepth()
int	getMaxTerminal()
protected abstract String	getNodeName(int level) Return the name of the node at level
Object	getParameter(String key)
protected int	getRealDepth(TreeNode node)
int[]	getRealDetph()
int	getTerminalWidth()
int	getTotalLevels()
int[]	getWidthPerDepth_acc()
protected int	getWidthPerDepth_acc(TreeNode node)
int[]	getWidthPerDepth()
abstract void	init() This method is called before parsing the tree.
protected int	jump(int lastLevel, int maxLevel, int[] currentWidthPerDepth) Try to jump over the skipped nodes between lastLevel and maxLevel and fill currentWidthPerDepth accordingly.
protected void	linkNode(TreeNode source, TreeNode target, int colorIndex) Create an edge from source to target Also set the right color according to colorIndex, and the dashed line if the target is a leaf.
abstract void	parseOmdd()
void	run(int treeMode) Run the parser on the OMDDNode root, and fill the tree.
void	setParameter(String key, Object value)
void	setTree(Tree tree)
protected String	tab(int tabs) Little helper function to write a tree in stdout
protected void	updateLayout(NodeAttributesReader vreader, TreeNode vertex)
void	updateNodeLayout() Compute the layout for each node in this tree

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NODEORDER

public static final String PARAM_NODEORDER

See Also:

Constant Field Values

tree

protected Tree tree

nodeOrder

protected List<RegulatoryNode> nodeOrder

max_terminal

protected int max_terminal

Indicates the maximum count of terminal.

widthPerDepth

protected int[] widthPerDepth

Indicates for each depth, the sub-total (width) of children or 0 if the depth is not skipped (realDepth == -1).

widthPerDepth_acc

protected int[] widthPerDepth_acc

Indicates for each depth, the total (width) of children or 0 if the depth is not skipped (realDepth == -1).

realDetph

protected int[] realDetph

As the omdd diagram could not contain all the levels (some could be skipped...), we try to reduce the tree width, by assigning a depth to each __used__ level. This can be achieved in two ways, * by a first pass on the omdd (good for diagram) * by computing the incoming vertices from the regulatoryGraph (good for tree) A value of -2, indicates the depth correspond to a skipped level.

total_levels

protected int total_levels

The total number of levels that are not skipped

max_depth

protected int max_depth

The level of the last depth (corresponding to the terminal node in widthPerDepth)

Constructor Detail

TreeBuilder

public TreeBuilder()

Method Detail

run

public void run(int treeMode)

Run the parser on the OMDDNode root, and fill the tree.

Parameters:

treeMode - the kind of tree to parse (tree, diagram or diagramWithAllleafs)

setTree

public void setTree(Tree tree)

init

public abstract void init()

This method is called before parsing the tree. Should initialize all the side variables.

parseOmdd

public abstract void parseOmdd()

getNodeName

protected abstract String getNodeName(int level)

Return the name of the node at level

Parameters:

level - the level of the node

Returns:

the name

updateNodeLayout

public void updateNodeLayout()

Compute the layout for each node in this tree

updateLayout

protected void updateLayout(NodeAttributesReader vreader,
                            TreeNode vertex)

computeWidthPerDepthFromRegGraph

protected void computeWidthPerDepthFromRegGraph()

clearTree

public void clearTree()

Remove all the vertices from the tree

getParameter

public Object getParameter(String key)

setParameter

public void setParameter(String key,
                         Object value)

tab

protected String tab(int tabs)

Little helper function to write a tree in stdout

Parameters:

tabs - the count of tab to output

Returns:

a string with tab tabs

addChildren

protected List<TreeNode> addChildren(int j,
                                     int mult,
                                     List<TreeNode> parents,
                                     int childIndex,
                                     int[] currentWidthPerDepth,
                                     EdgeAttributesReader ereader)

jump

protected int jump(int lastLevel,
                   int maxLevel,
                   int[] currentWidthPerDepth)

Try to jump over the skipped nodes between lastLevel and maxLevel and fill currentWidthPerDepth accordingly.

Parameters:

lastLevel -

maxLevel -

currentWidthPerDepth -

Returns:

the max width of skipped nodes

linkNode

protected void linkNode(TreeNode source,
                        TreeNode target,
                        int colorIndex)

Create an edge from source to target Also set the right color according to colorIndex, and the dashed line if the target is a leaf.

Parameters:

source -

target -

colorIndex -

getWidthPerDepth

public int[] getWidthPerDepth()

getWidthPerDepth_acc

public int[] getWidthPerDepth_acc()

getMaxTerminal

public int getMaxTerminal()

getMaxDepth

public int getMaxDepth()

getRealDetph

public int[] getRealDetph()

getTerminalWidth

public int getTerminalWidth()

getTotalLevels

public int getTotalLevels()

getRealDepth

protected int getRealDepth(TreeNode node)

getWidthPerDepth_acc

protected int getWidthPerDepth_acc(TreeNode node)