org.primordion.xholon.base
Interface IXholonClass

All Superinterfaces:
IXholon
All Known Subinterfaces:
IBioXholonClass
All Known Implementing Classes:
BioXholonClass, XholonClass

public interface IXholonClass
extends IXholon

A XholonClass is a concrete subclass of TreeNode. A primary role of a XholonClass instance is to provide configuration instructions for Xholon instances of its type.

Since:
0.2 (Created on Oct 21, 2005)
Author:
Ken Webb

Field Summary
static int MTYPE_MASK
          Mask that can be used to convert Xholon Type into a Mechanism Type.
static int MtypeActivity
          Activity mechanism, implemented in Java by IActivity.
static int MtypeBraneCalcEntity
          Brane Calculus
static int MtypeComposition
          Composition mechanism, implemented in Java by IXholon and XholonWithPorts subclass.
static int MtypeConfigContainer
          an internal mechanism
static int MtypeCtrnnEntity
          Ctrnn mechanism.
static int MtypeGridEntity
          Grid
static int MtypeMemCompEntity
          Membrane Computing
static int MtypePort
          Port
static int MtypeStateMachineEntity
          State Machine mechanism.
static int XhtypeActivity
           
static int XhtypeBehFgsCon
          Active Object + Passive Object + Container.
static int XhtypeBehFgsxxx
          Active Object + Passive Object.
static int XhtypeBehxxxCon
          Active Object + Container.
static int XhtypeBehxxxxxx
          Pure Active Object.
static int XhtypeBraneCalcEntity
           
static int XhtypeBraneCalcEntityActive
           
static int XhtypeBraneCalcEntityPassive
           
static int XhtypeConfigContainer
           
static int XhtypeCtrnnEntity
           
static int XhtypeCtrnnEntityActive
           
static int XhtypeCtrnnEntityActivePassive
           
static int XhtypeGridEntity
           
static int XhtypeGridEntityActive
           
static int XhtypeGridEntityActivePassive
           
static int XhtypeMemCompEntity
           
static int XhtypeMemCompEntityActive
           
static int XhtypeMemCompEntityActiveContainer
           
static int XhtypeMemCompEntityPassive
           
static int XhtypeNone
           
static int XhtypePort
           
static int XhtypePureActiveObject
           
static int XhtypePureContainer
           
static int XhtypePurePassiveObject
           
static int XhtypeStateMachineEntity
           
static int XhtypeStateMachineEntityActive
           
static int XhtypexxxFgsCon
          Passive Object + Container.
static int XhtypexxxFgsxxx
          Pure Passive Object.
static int XhtypexxxxxxCon
          Pure Container.
static int Xhtypexxxxxxxxx
          Mechanism - Composite Structure.
 
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
 java.lang.String getConfigurationInstructions()
          Get configuration instructions.
 java.lang.String getImplName()
          Get the name of the Java class that implements this Xholon class.
 int getXhType()
          Get xholon type.
 boolean hasAncestor(java.lang.String tnName)
          Does this instance of XholonClass have the specified ancestor somewhere in its inheritance tree.
 void inOrderPrint(int level)
          In-order print.
 void postOrderPrint(int level)
          Post-order print.
 void preOrderPrint(int level)
          Pre-order print.
 void setImplName(java.lang.String implName)
          Set the name of the Java class that implements this Xholon class.
 void setName(java.lang.String className)
          Set name of this XholonClass.
 void setNavInfo(java.lang.String navInfo)
          Set navigation information.
 void setXhType(int xhType)
          Set xholon type.
 
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, handleNodeSelection, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initialize, initStatics, insertAfter, insertBefore, insertFirstChild, isActiveObject, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postReconfigure, preAct, preConfigure, 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

Xhtypexxxxxxxxx

public static final int Xhtypexxxxxxxxx
Mechanism - Composite Structure.

See Also:
Constant Field Values

XhtypexxxxxxCon

public static final int XhtypexxxxxxCon
Pure Container.

See Also:
Constant Field Values

XhtypexxxFgsxxx

public static final int XhtypexxxFgsxxx
Pure Passive Object.

See Also:
Constant Field Values

XhtypexxxFgsCon

public static final int XhtypexxxFgsCon
Passive Object + Container.

See Also:
Constant Field Values

XhtypeBehxxxxxx

public static final int XhtypeBehxxxxxx
Pure Active Object.

See Also:
Constant Field Values

XhtypeBehxxxCon

public static final int XhtypeBehxxxCon
Active Object + Container.

See Also:
Constant Field Values

XhtypeBehFgsxxx

public static final int XhtypeBehFgsxxx
Active Object + Passive Object.

See Also:
Constant Field Values

XhtypeBehFgsCon

public static final int XhtypeBehFgsCon
Active Object + Passive Object + Container.

See Also:
Constant Field Values

XhtypeNone

public static final int XhtypeNone
See Also:
Constant Field Values

XhtypePureContainer

public static final int XhtypePureContainer
See Also:
Constant Field Values

XhtypePurePassiveObject

public static final int XhtypePurePassiveObject
See Also:
Constant Field Values

XhtypePureActiveObject

public static final int XhtypePureActiveObject
See Also:
Constant Field Values

XhtypeActivity

public static final int XhtypeActivity
See Also:
Constant Field Values

XhtypeConfigContainer

public static final int XhtypeConfigContainer
See Also:
Constant Field Values

XhtypeStateMachineEntity

public static final int XhtypeStateMachineEntity
See Also:
Constant Field Values

XhtypeStateMachineEntityActive

public static final int XhtypeStateMachineEntityActive
See Also:
Constant Field Values

XhtypeCtrnnEntity

public static final int XhtypeCtrnnEntity
See Also:
Constant Field Values

XhtypeCtrnnEntityActive

public static final int XhtypeCtrnnEntityActive
See Also:
Constant Field Values

XhtypeCtrnnEntityActivePassive

public static final int XhtypeCtrnnEntityActivePassive
See Also:
Constant Field Values

XhtypeMemCompEntity

public static final int XhtypeMemCompEntity
See Also:
Constant Field Values

XhtypeMemCompEntityActive

public static final int XhtypeMemCompEntityActive
See Also:
Constant Field Values

XhtypeMemCompEntityPassive

public static final int XhtypeMemCompEntityPassive
See Also:
Constant Field Values

XhtypeMemCompEntityActiveContainer

public static final int XhtypeMemCompEntityActiveContainer
See Also:
Constant Field Values

XhtypeBraneCalcEntity

public static final int XhtypeBraneCalcEntity
See Also:
Constant Field Values

XhtypeBraneCalcEntityActive

public static final int XhtypeBraneCalcEntityActive
See Also:
Constant Field Values

XhtypeBraneCalcEntityPassive

public static final int XhtypeBraneCalcEntityPassive
See Also:
Constant Field Values

XhtypePort

public static final int XhtypePort
See Also:
Constant Field Values

XhtypeGridEntity

public static final int XhtypeGridEntity
See Also:
Constant Field Values

XhtypeGridEntityActive

public static final int XhtypeGridEntityActive
See Also:
Constant Field Values

XhtypeGridEntityActivePassive

public static final int XhtypeGridEntityActivePassive
See Also:
Constant Field Values

MtypeComposition

public static final int MtypeComposition
Composition mechanism, implemented in Java by IXholon and XholonWithPorts subclass.

See Also:
Constant Field Values

MtypeActivity

public static final int MtypeActivity
Activity mechanism, implemented in Java by IActivity.

See Also:
Constant Field Values

MtypeConfigContainer

public static final int MtypeConfigContainer
an internal mechanism

See Also:
Constant Field Values

MtypeStateMachineEntity

public static final int MtypeStateMachineEntity
State Machine mechanism.

See Also:
Constant Field Values

MtypeCtrnnEntity

public static final int MtypeCtrnnEntity
Ctrnn mechanism.

See Also:
Constant Field Values

MtypeMemCompEntity

public static final int MtypeMemCompEntity
Membrane Computing

See Also:
Constant Field Values

MtypeBraneCalcEntity

public static final int MtypeBraneCalcEntity
Brane Calculus

See Also:
Constant Field Values

MtypePort

public static final int MtypePort
Port

See Also:
Constant Field Values

MtypeGridEntity

public static final int MtypeGridEntity
Grid

See Also:
Constant Field Values

MTYPE_MASK

public static final int MTYPE_MASK
Mask that can be used to convert Xholon Type into a Mechanism Type. Convert lower order 3 bits to 000.

See Also:
Constant Field Values
Method Detail

setName

public void setName(java.lang.String className)
Set name of this XholonClass.

Parameters:
className - The new name.

setNavInfo

public void setNavInfo(java.lang.String navInfo)
Set navigation information.

Parameters:
navInfo - A configuration string describing ports, attributes and commands for this XholonClass and its Xholon instances.

getXhType

public int getXhType()
Get xholon type. (ex: XhtypePureContainer, XhtypePurePassiveObject, XhtypePureActiveObject)

Specified by:
getXhType in interface IXholon
Returns:
The Xholon type.

setXhType

public void setXhType(int xhType)
Set xholon type.

Parameters:
xhType - The new Xholon type. (ex: XhtypePureContainer, XhtypePurePassiveObject, XhtypePureActiveObject)

getImplName

public java.lang.String getImplName()
Get the name of the Java class that implements this Xholon class.

ex: org.primordion.user.app.APartOfTheSystem

Returns:
The full package name of a Java class, or null if the name is unknown.

setImplName

public void setImplName(java.lang.String implName)
Set the name of the Java class that implements this Xholon class.

ex: org.primordion.user.app.APartOfTheSystem

Parameters:
implName - The full package name of a Java class.

hasAncestor

public boolean hasAncestor(java.lang.String tnName)
Does this instance of XholonClass have the specified ancestor somewhere in its inheritance tree.

Specified by:
hasAncestor in interface IXholon
Parameters:
tnName - the searched-for ancestor
Returns:
true or false

getConfigurationInstructions

public java.lang.String getConfigurationInstructions()
Get configuration instructions.

Returns:
The instructions.

preOrderPrint

public void preOrderPrint(int level)
Description copied from interface: IXholon
Pre-order print. Print current node; then traverse children and siblings.

Specified by:
preOrderPrint in interface IXholon
Parameters:
level - Level in the tree, where the root node is level 0.

inOrderPrint

public void inOrderPrint(int level)
Description copied from interface: IXholon
In-order print. Traverse children; then print current node; then traverse siblings.

Specified by:
inOrderPrint in interface IXholon
Parameters:
level - Level in the tree, where the root node is level 0.

postOrderPrint

public void postOrderPrint(int level)
Description copied from interface: IXholon
Post-order print. Traverse children and siblings; then print current node.

Specified by:
postOrderPrint in interface IXholon
Parameters:
level - Level in the tree, where the root node is level 0.