Class EntityManager

Object
   |
   +--EntityNode
         |
         +--EntityManager

class EntityManager
extends EntityNode

This class implements the entity/identity hierarchy tree used by the SVGController to determine the entity/identity SVG elements to create.


Constructor Summary
EntityManager ()
           
 
Method Summary
 function getCollapsed()
           Returns an array containing all the entities that reside underneath collapsed parts of the entity/identity tree.
 function getHidden()
           Returns all the leaf nodes that have the visible flag set false
 function getNode(branch_id)
           Returns the entity/identity node using the specified branch id.
 function getVisibles()
           Returns all the entity/identity nodes visible to the user.
 
Methods inherited from class EntityNode
appendChild, hasChild, getLeafs
 

Constructor Detail

EntityManager

function EntityManager()

Method Detail

getCollapsed

function getCollapsed()
Returns an array containing all the entities that reside underneath collapsed parts of the entity/identity tree. For every array item the following format is used to present the information:
<entity key>:<entityNode.type>_<entityNode.value>
The first part identifies the entity that is underneath a collapsed part of the entity/identity tree. The second part identifies the node that is collapsed. If for example two entities with id=4 and id=8 are underneath the collapsed CCM_DOMAIN node with name 'lucent.com' then the array content would look like follows (pseudo code):
array = {4:CCM_DOMAIN_lucent.com, 8:CCM_DOMAIN_lucent.com}
The information is used by the tracing server to identify the operations that have there begin and endpoint lying on the same entity/identity line (operation to self) so that they can be filtered out if requested.

Returns:
The leafs that reside underneath collapsed parts of the entity/identity tree.

getHidden

function getHidden()
Returns all the leaf nodes that have the visible flag set false

Returns:
Array containing the hidden leaf nodes.

getNode

function getNode(branch_id)
Returns the entity/identity node using the specified branch id. The branch id represents the node position within the tree. For a tree with three child nodes this will be for example:
first child of root (N1):   id = 1
second child of root (N2):  id = 2
first child of N2:          id = 2_1

Parameters:
branch_id - Branch id of the node to retrieve.

Returns:
The node specified by the branch id.

getVisibles

function getVisibles()
Returns all the entity/identity nodes visible to the user. Visible in this context means that a node must be either collapsed or expanded in which case to node should have no children (leaf). For nodes that comply to the previous requirements the visible flag must also be set (true). Note that children of collapsed nodes are filtered out. Whether a node is collapsed/expanded and visible or not, is under control of the user by means of a HTML tree (Entity Control). This class reflects the HTML tree state.

Returns:
An array containing all visible entity/identity nodes.