public class XholonClass extends Xholon implements IXholonClass, IDecoration
URI_APPSPECIFIC_AUTH_DEFAULT, URI_APPSPECIFIC_DEFAULT, URI_APPSPECIFIC_PATH_DEFAULT, XhtypeActivity, XhtypeBehFgsCon, XhtypeBehFgsxxx, XhtypeBehxxxCon, XhtypeBehxxxxxx, XhtypeBraneCalcEntity, XhtypeBraneCalcEntityActive, XhtypeBraneCalcEntityPassive, XhtypeConfigContainer, XhtypeCtrnnEntity, XhtypeCtrnnEntityActive, XhtypeCtrnnEntityActivePassive, XhtypeGridEntity, XhtypeGridEntityActive, XhtypeGridEntityActivePassive, XhtypeMemCompEntity, XhtypeMemCompEntityActive, XhtypeMemCompEntityActiveContainer, XhtypeMemCompEntityPassive, XhtypeNone, XhtypePort, XhtypePureActiveObject, XhtypePureContainer, XhtypePurePassiveObject, XhtypeStateMachineEntity, XhtypeStateMachineEntityActive, XhtypexxxFgsCon, XhtypexxxFgsxxx, XhtypexxxxxxCon, Xhtypexxxxxxxxx
DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL
Constructor and Description |
---|
XholonClass()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(java.lang.Object o) |
void |
configure()
Perform some action, typically once at start up; MAY be overridden.
|
IApplication |
getApp()
Get the instance of Application that owns this Xholon instance and the model of which it is a part.
|
java.lang.String |
getChildSuperClass()
Get the optional child superClass.
|
java.lang.String |
getColor() |
java.lang.String |
getConfigurationInstructions()
Get configuration instructions.
|
IDecoration |
getDecoration()
Get the optional decoration object.
|
java.lang.String |
getDefaultContent() |
java.lang.String |
getFont() |
java.lang.String |
getFormat() |
java.lang.String |
getIcon() |
java.lang.String |
getImplName()
Get the name of the Java class that implements this Xholon class.
|
java.lang.String |
getLocalPart()
Get only the local part of the name of this IXholonClass, without the prefix.
|
IMechanism |
getMechanism()
Get the mechanism that this IXholonClass belongs to.
|
java.lang.String |
getName()
Get name, unique within this application, of this XholonClass instance.
|
java.lang.String |
getNavInfo()
Get navigation information.
|
java.util.List<PortInformation> |
getPortInformation()
TODO this method may not correctly handle all cases
field name index may be a number or a String (ex: 1 P_PARTNER)
|
java.lang.String |
getPrefix()
Get the XML namespace default prefix.
|
java.lang.String |
getPrefixedName()
Get the name of this IXholonClass in the format: prefix:name .
|
java.lang.Object |
getPrototype()
Get the value of the prototype object, which is a JavaScriptObject.
|
QName |
getQName()
Get the name of this IXholonClass as a QName.
|
java.lang.String |
getSourceCodeURLPrefix() |
java.lang.String |
getSourceCodeURLSuffix() |
java.lang.String |
getSymbol() |
java.lang.String |
getToolTip() |
java.lang.String |
getUri()
Get the Uniform Resource Identifier (URI) that identifies this Xholon node.
|
java.lang.String |
getXhcName()
Get the name of the IXholonClass to which this Xholon instance is a member.
|
int |
getXhType()
Get the Xholon type, as known to this Xholon's IXholonClass.
|
static int |
getXhType(java.lang.String token)
Get Xh type.
|
java.lang.String |
getXhTypeName()
Get the name of the xholon type.
|
static java.lang.String |
getXhTypeName(int xhType)
Get the name of this xh type.
|
IXml2Xholon |
getXml2Xholon()
Get a configured instance of Xml2Xholon.
|
boolean |
hasAncestor(int tnId)
Does this instance of XholonClass have the specified ancestor
somewhere in its inheritance tree.
|
boolean |
hasAncestor(java.lang.String tnName)
Does this instance of Xholon have the specified node as one of its
ancestors (parent, grandparent, etc.), within its containment tree.
|
boolean |
hasAnnotation()
Does this Xholon node have an annotation?
|
boolean |
hasConfigurationInstructions()
Does this instance of IXholonClass have configuration instructions?
|
void |
initialize()
Initialize the tree node.
|
void |
inOrderPrint(int level)
In-order print.
|
boolean |
isActiveObject()
Is this xholon or xholon class an Active Object?
|
boolean |
isContainer()
Is this xholon or xholon class a Container?
|
boolean |
isPassiveObject()
Is this xholon or xholon class a Passive Object?
|
boolean |
isPrefixed()
Get whether the XholonClass name must be prefixed.
|
boolean |
isShouldShowSourceCode() |
void |
postOrderPrint(int level)
Post-order print.
|
void |
preOrderPrint(int level)
Pre-order print.
|
void |
printNode(int level)
Called by the various xOrderPrint() routines.
|
java.lang.String |
prototype(java.lang.String jsCode)
If the JavaScript code starts with a constructor,
then create a protoype object,
and return a String that can be used to create an object that derives from that prototype.
|
java.util.List<IXholon> |
searchForReferencingNodes()
Search for instances of Xholon with ports that reference this instance.
|
void |
searchForReferencingNodesRecurse(Xholon node,
java.util.List<IXholon> reffingNodes)
Search for instances of Xholon with ports that reference this instance.
|
void |
setApp(IApplication app)
Set the instance of Application that owns this Xholon instance and the model of which it is a part.
|
void |
setChildSuperClass(java.lang.String childSuperClass)
Set the optional child superClass.
|
void |
setColor(java.lang.String color) |
void |
setDecoration(IDecoration decoration)
Set the optional decoration object.
|
void |
setDefaultContent(java.lang.String defaultContent) |
void |
setFont(java.lang.String font) |
void |
setFormat(java.lang.String format) |
void |
setIcon(java.lang.String icon) |
void |
setImplName(java.lang.String implName)
Set the name of the Java class that implements this Xholon class.
|
void |
setMechanism(IMechanism mechanism)
Set the mechanism that this IXholonClass belongs to.
|
void |
setMechanism(java.lang.String name,
java.lang.String namespaceUri,
java.lang.String defaultPrefix,
int rangeStart)
Set the mechanism that this IXholonClass belongs to.
|
void |
setName(java.lang.String className)
Hibernate requires a setter and getter for each property that it persists.
|
void |
setNavInfo(java.lang.String navInfo)
Set navigation information.
|
void |
setPortInformation(java.util.List portInformation)
Set the list of information about each potential port.
|
void |
setPrefixed(boolean prefixed)
Set whether the XholonClass name must be prefixed.
|
void |
setPrototype(java.lang.Object prototype) |
void |
setShouldShowSourceCode(boolean shouldShowSourceCode) |
void |
setSourceCodeURLPrefix(java.lang.String sourceCodeURLPrefix) |
void |
setSourceCodeURLSuffix(java.lang.String sourceCodeURLSuffix) |
void |
setSymbol(java.lang.String symbol) |
void |
setToolTip(java.lang.String toolTip) |
void |
setXhType(int xhType)
Set xholon type.
|
java.lang.String |
toString() |
void |
toXml(IXholon2Xml xholon2xml,
IXmlWriter xmlWriter)
Write self as XML.
|
void |
toXmlAttribute(IXholon2Xml xholon2xml,
IXmlWriter xmlWriter,
java.lang.String name,
java.lang.String value,
java.lang.Class clazz)
Write one attribute formatted as XML.
|
void |
toXmlAttributes(IXholon2Xml xholon2xml,
IXmlWriter xmlWriter)
Write a set of attributes formatted as XML.
|
act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, consoleLog, decVal, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXholon2Xml, getXPath, handleNodeSelection, handleNodeSelection, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initStatics, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isAttributeHandler, isBound, isExternal, isInternal, isLeaf, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postReconfigure, preAct, preConfigure, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXmlText, treeSize, visit
getClass, hashCode, notify, notifyAll, wait, wait, wait
act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, consoleLog, decVal, decVal, depth, doAction, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, 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, getXholon2Xml, handleNodeSelection, handleNodeSelection, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initStatics, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isAttributeHandler, isBound, isExternal, isInternal, isLeaf, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postReconfigure, preAct, preConfigure, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXmlText, treeSize, visit
public void initialize()
IXholon
initialize
in interface IXholon
initialize
in class Xholon
public java.lang.String getName()
public void setName(java.lang.String className)
IXholon
public QName getQName()
IXholonClass
getQName
in interface IXholonClass
public java.lang.String getPrefixedName()
IXholonClass
getPrefixedName
in interface IXholonClass
public java.lang.String getPrefix()
IXholonClass
getPrefix
in interface IXholonClass
public java.lang.String getLocalPart()
IXholonClass
getLocalPart
in interface IXholonClass
public void setPrefixed(boolean prefixed)
IXholonClass
setPrefixed
in interface IXholonClass
public boolean isPrefixed()
IXholonClass
isPrefixed
in interface IXholonClass
public java.lang.String getNavInfo()
IXholonClass
getNavInfo
in interface IXholonClass
public void setNavInfo(java.lang.String navInfo)
IXholonClass
setNavInfo
in interface IXholonClass
navInfo
- A configuration string describing ports, attributes
and commands for this XholonClass and its Xholon instances.public java.util.List<PortInformation> getPortInformation()
getPortInformation
in interface IXholonClass
IXholonClass.getPortInformation()
public void setPortInformation(java.util.List portInformation)
IXholonClass
setPortInformation
in interface IXholonClass
portInformation
- An array of PortInformation instances.public int getXhType()
IXholon
public void setXhType(int xhType)
IXholonClass
setXhType
in interface IXholonClass
xhType
- The new Xholon type.
(ex: XhtypePureContainer, XhtypePurePassiveObject, XhtypePureActiveObject)public java.lang.String getXhTypeName()
IXholonClass
getXhTypeName
in interface IXholonClass
public java.lang.String getXhcName()
IXholon
getXhcName
in interface IXholon
getXhcName
in class Xholon
public java.lang.String getUri()
IXholon
public IMechanism getMechanism()
IXholonClass
getMechanism
in interface IXholonClass
public void setMechanism(IMechanism mechanism)
IXholonClass
setMechanism
in interface IXholonClass
mechanism
- An instance of IMechanism.public void setMechanism(java.lang.String name, java.lang.String namespaceUri, java.lang.String defaultPrefix, int rangeStart)
IXholonClass
setMechanism
in interface IXholonClass
name
- The name/roleName of the mechanism.namespaceUri
- A namespace URI that uniquely identifies the mechanism.public boolean isContainer()
IXholon
isContainer
in interface IXholon
isContainer
in class Xholon
public boolean isActiveObject()
IXholon
isActiveObject
in interface IXholon
isActiveObject
in class Xholon
public boolean isPassiveObject()
IXholon
isPassiveObject
in interface IXholon
isPassiveObject
in class Xholon
public java.lang.String getImplName()
IXholonClass
ex: org.primordion.user.app.APartOfTheSystem
getImplName
in interface IXholonClass
public void setImplName(java.lang.String implName)
IXholonClass
ex: org.primordion.user.app.APartOfTheSystem
setImplName
in interface IXholonClass
implName
- The full package name of a Java class.public IApplication getApp()
IXholon
public void setApp(IApplication app)
IXholon
public static java.lang.String getXhTypeName(int xhType)
public boolean hasAncestor(java.lang.String tnName)
IXholon
hasAncestor
in interface IXholon
hasAncestor
in interface IXholonClass
hasAncestor
in class Xholon
tnName
- the searched-for ancestorpublic boolean hasAncestor(int tnId)
IXholonClass
hasAncestor
in interface IXholonClass
tnId
- the ID of the searched-for ancestorpublic void configure()
IXholon
public java.lang.String getConfigurationInstructions()
IXholonClass
getConfigurationInstructions
in interface IXholonClass
public boolean hasConfigurationInstructions()
IXholonClass
hasConfigurationInstructions
in interface IXholonClass
public java.lang.String getChildSuperClass()
IXholonClass
getChildSuperClass
in interface IXholonClass
public void setChildSuperClass(java.lang.String childSuperClass)
IXholonClass
setChildSuperClass
in interface IXholonClass
public boolean hasAnnotation()
IXholon
hasAnnotation
in interface IXholon
hasAnnotation
in class Xholon
Xholon.hasAnnotation()
public IXml2Xholon getXml2Xholon()
Xholon
getXml2Xholon
in interface IXholon
getXml2Xholon
in class Xholon
public static int getXhType(java.lang.String token)
token
- String representation of the Xh type.public void preOrderPrint(int level)
IXholon
preOrderPrint
in interface IXholon
preOrderPrint
in interface IXholonClass
preOrderPrint
in class Xholon
level
- Level in the tree, where the root node is level 0.public void inOrderPrint(int level)
IXholon
inOrderPrint
in interface IXholon
inOrderPrint
in interface IXholonClass
inOrderPrint
in class Xholon
level
- Level in the tree, where the root node is level 0.public void postOrderPrint(int level)
IXholon
postOrderPrint
in interface IXholon
postOrderPrint
in interface IXholonClass
postOrderPrint
in class Xholon
level
- Level in the tree, where the root node is level 0.public void printNode(int level)
level
- The current level in the composite structure hierarchy tree.public void toXml(IXholon2Xml xholon2xml, IXmlWriter xmlWriter)
IXholon
public void toXmlAttributes(IXholon2Xml xholon2xml, IXmlWriter xmlWriter)
IXholon
toXmlAttributes
in interface IXholon
toXmlAttributes
in class Xholon
xmlWriter
- The XML writer.public void toXmlAttribute(IXholon2Xml xholon2xml, IXmlWriter xmlWriter, java.lang.String name, java.lang.String value, java.lang.Class clazz)
IXholon
toXmlAttribute
in interface IXholon
toXmlAttribute
in class Xholon
xmlWriter
- The XML writer.name
- Name of the attribute.value
- Value of the attribute.public int compareTo(java.lang.Object o)
public IDecoration getDecoration()
IXholonClass
getDecoration
in interface IXholonClass
public void setDecoration(IDecoration decoration)
IXholonClass
setDecoration
in interface IXholonClass
public java.lang.String getColor()
getColor
in interface IDecoration
public void setColor(java.lang.String color)
setColor
in interface IDecoration
public java.lang.String getFont()
getFont
in interface IDecoration
public void setFont(java.lang.String font)
setFont
in interface IDecoration
public java.lang.String getIcon()
getIcon
in interface IDecoration
public void setIcon(java.lang.String icon)
setIcon
in interface IDecoration
public java.lang.String getToolTip()
getToolTip
in interface IDecoration
public void setToolTip(java.lang.String toolTip)
setToolTip
in interface IDecoration
public java.lang.String getSymbol()
getSymbol
in interface IDecoration
public void setSymbol(java.lang.String symbol)
setSymbol
in interface IDecoration
public java.lang.String getFormat()
getFormat
in interface IDecoration
public void setFormat(java.lang.String format)
setFormat
in interface IDecoration
public java.lang.String getDefaultContent()
getDefaultContent
in interface IXholonClass
public void setDefaultContent(java.lang.String defaultContent)
setDefaultContent
in interface IXholonClass
defaultContent
- The default content of instances of this Xholon class.public java.lang.Object getPrototype()
IXholonClass
getPrototype
in interface IXholonClass
public void setPrototype(java.lang.Object prototype)
setPrototype
in interface IXholonClass
public java.lang.String prototype(java.lang.String jsCode)
prototype
in interface IXholonClass
jsCode
- JavaScript code.public java.util.List<IXholon> searchForReferencingNodes()
IXholon
searchForReferencingNodes
in interface IXholon
searchForReferencingNodes
in class Xholon
public void searchForReferencingNodesRecurse(Xholon node, java.util.List<IXholon> reffingNodes)
Xholon
searchForReferencingNodesRecurse
in class Xholon
node
- The Xholon node that we're looking for references to.reffingNodes
- A list that is being filled with references.public java.lang.String getSourceCodeURLPrefix()
public void setSourceCodeURLPrefix(java.lang.String sourceCodeURLPrefix)
public java.lang.String getSourceCodeURLSuffix()
public void setSourceCodeURLSuffix(java.lang.String sourceCodeURLSuffix)
public boolean isShouldShowSourceCode()
public void setShouldShowSourceCode(boolean shouldShowSourceCode)