org.primordion.xholon.service.creation

Interface ITreeNodeFactory

All Superinterfaces:

IXholon, XholonMarker

All Known Implementing Classes:

TreeNodeFactoryNew

public interface ITreeNodeFactory
extends IXholon

A tree node factory creates and manages Xholon tree nodes.

Since:

0.3 (Created on Feb 15, 2006)

See Also:

Xholon Project website

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INSTANCE_METHOD_NAME The default name of a static method that can be called on a class to return an instance of that class.

Fields inherited from interface org.primordion.xholon.base.IXholon

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

Method Summary

Methods

Modifier and Type	Method and Description
IXholon	getNode(java.lang.Class xholonSubclass) Get a node instance of the specified Java class.
IXholon	getNode(int xhType) Get a node instance of the specified Xholon Type.
IXholon	getNonXholonNode(java.lang.Class clazz) Get a Xholon instance of a Java class that is not a Xholon, that is that doesn't implement IXholon.
int	getNumAvailNodes(int resourceType) Get number of treeNodes available for use.
IXholonClass	getXholonClassNode() Get a XholonClass instance from the factory.
IXholon	getXholonNode() Get a Xholon instance from the factory.
IXholon	getXholonNode(java.lang.String implName) Get a Xholon instance from the factory, based on its full package name.
IXholon	getXholonNode(java.lang.String implName, java.lang.String methodName) Get a Xholon instance from the factory, based on its full package name.
IXholon	getXholonScriptNode(java.lang.String implName) Get a Xholon instance created in a scripting language, rather than Java.
boolean	isClassFindable(java.lang.String implName) Is a Java class with the specified name findable? Could it be loaded by the class loader?
void	returnTreeNode(IXholon node) Return a TreeNode to the factory.

Methods inherited from interface org.primordion.xholon.base.IXholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, configure, consoleLog, decVal, decVal, depth, doAction, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, 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, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Field Detail

INSTANCE_METHOD_NAME

static final java.lang.String INSTANCE_METHOD_NAME

The default name of a static method that can be called on a class to return an instance of that class. ex: MyClass anInstance = MyClass.instance();

See Also:

Constant Field Values

Method Detail

getNumAvailNodes

int getNumAvailNodes(int resourceType)

Get number of treeNodes available for use.

Parameters:

resourceType - The type of node: Xholon, XholonClass, StateMachineEntity, or Activity.

Returns:

Number of available nodes.

getNode

IXholon getNode(java.lang.Class xholonSubclass)
                throws XholonConfigurationException

Get a node instance of the specified Java class.

Parameters:

xholonSubclass -

Returns:

An IXholon instance.

Throws:

XholonConfigurationException

getNode

IXholon getNode(int xhType)
                throws XholonConfigurationException

Get a node instance of the specified Xholon Type.

Parameters:

xhType -

Returns:

An IXholon instance.

Throws:

XholonConfigurationException

getXholonNode

IXholon getXholonNode()
                      throws XholonConfigurationException

Get a Xholon instance from the factory.

Returns:

The next available instance, or null. TODO Need to handle null (Q_EMPTY) condition gracefully.

Throws:

XholonConfigurationException

getXholonNode

IXholon getXholonNode(java.lang.String implName)
                      throws XholonConfigurationException

Get a Xholon instance from the factory, based on its full package name.

Parameters:

implName - The name of a Java class.

Returns:

An instance of that class, or null.

Throws:

XholonConfigurationException

getXholonNode

IXholon getXholonNode(java.lang.String implName,
                    java.lang.String methodName)
                      throws XholonConfigurationException

Get a Xholon instance from the factory, based on its full package name. This method is intended to return singleton instances.

Parameters:

implName - The name of a Java class.

methodName - The name of a static method that will return an instance of the class. The default name of the method is INSTANCE_METHOD_NAME = "instance".

Returns:

An instance of that class, or null.

Throws:

XholonConfigurationException

getXholonScriptNode

IXholon getXholonScriptNode(java.lang.String implName)
                            throws XholonConfigurationException

Get a Xholon instance created in a scripting language, rather than Java.

Parameters:

implName - The name of a script or class in some scripting language, for example:

lang:groovy:/Xholon/script/groovy/Test2.groovy

lang:groovy:inline

Returns:

An instance of IXholon, or null.

Throws:

XholonConfigurationException

getNonXholonNode

IXholon getNonXholonNode(java.lang.Class clazz)
                         throws XholonConfigurationException

Get a Xholon instance of a Java class that is not a Xholon, that is that doesn't implement IXholon.

Parameters:

clazz - A Class object for the non-Xholon class.

Returns:

An instance of XholonProxy, or null. The proxy will wrap the non-Xholon onject.

Throws:

XholonConfigurationException

getXholonClassNode

IXholonClass getXholonClassNode()
                                throws XholonConfigurationException

Get a XholonClass instance from the factory.

Returns:

The next available instance, or null.

Throws:

XholonConfigurationException

isClassFindable

boolean isClassFindable(java.lang.String implName)

Is a Java class with the specified name findable? Could it be loaded by the class loader?

Parameters:

implName - The full path name of a Java class.

Returns:

true or false

returnTreeNode

void returnTreeNode(IXholon node)

Return a TreeNode to the factory.

Parameters:

node - The TreeNode being returned.