org.primordion.xholon.base
Interface IContainmentHierarchy

All Superinterfaces:
IXholon
All Known Implementing Classes:
ContainmentHierarchy

public interface IContainmentHierarchy
extends IXholon

A ContainmentHierarchy represents a hierarchy (tree) of Xholon nodes contained within other Xholon nodes. This is called a Composite Structure in UML. It encapsulates the root node of a Xholon hierarchy (rootNode). A primary role of the ContainmentHierarchy is to read a Xholon hierarchy in from a file (ex: CompositeStructureHierarchy.xml), and store the nodes in a tree.

Since:
0.6 (Created on April 16, 2007)
Author:
Ken Webb

Field Summary
static char COMMENT_CHAR
           
 
Fields inherited from interface org.primordion.xholon.base.IXholon
DEFAULT_SIZE_MSG_Q, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx
 
Method Summary
 void deleteContainmentHierarchy()
          Delete the containment hierarchy.
 IXholon getTheRootNode()
          Get the root node of the containment (composite structure) hierarchy.
 void populateAllFromFile(java.lang.String fileName)
          Populate all instances of Xholon from a file.
 void printContainmentHierarchy()
          Print out the Xholon names, in tree order.
 void setInheritanceHierarchy(IInheritanceHierarchy ih)
          Set InheritanceHierarchy instance.
 void setTreeNodeFactory(ITreeNodeFactory f)
          Set singleton TreeNodeFactory instance.
 
Methods inherited from interface org.primordion.xholon.base.IXholon
act, appendChild, appendChild, appendChild, cleanup, configure, configure, createStructure, decVal, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPort, getPreviousSibling, getRoleName, getRootNode, getSiblings, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isActiveObject, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, reconfigure, remove, removeChild, sendMessage, sendMessage, sendMessage, setAttributeVal, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPorts, setRoleName, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, terminate, treeSize, writeXml
 

Field Detail

COMMENT_CHAR

public static final char COMMENT_CHAR
See Also:
Constant Field Values
Method Detail

deleteContainmentHierarchy

public void deleteContainmentHierarchy()
Delete the containment hierarchy.


setTreeNodeFactory

public void setTreeNodeFactory(ITreeNodeFactory f)
Set singleton TreeNodeFactory instance.

Parameters:
f - The TreeNodeFactory instance.

setInheritanceHierarchy

public void setInheritanceHierarchy(IInheritanceHierarchy ih)
Set InheritanceHierarchy instance.

Parameters:
ih - The InheritanceHierarchy instance.

getTheRootNode

public IXholon getTheRootNode()
Get the root node of the containment (composite structure) hierarchy.

Returns:
The root node.

populateAllFromFile

public void populateAllFromFile(java.lang.String fileName)
Populate all instances of Xholon from a file. The file must contain a composite structure hierarchy in XML format.

Parameters:
fileName - Name of the file. (ex: CompositeStructureHierarchy.xml)

printContainmentHierarchy

public void printContainmentHierarchy()
Print out the Xholon names, in tree order.