org.primordion.user.app.Turnstile

Class XhTurnstile

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.xholon.base.XholonWithPorts

org.primordion.user.app.Turnstile.XhTurnstile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, CeTurnstile, IXholon, XholonMarker

public class XhTurnstile
extends XholonWithPorts
implements CeTurnstile

Turnstile FSM.

Since:

0.9.1 (Created on March 5, 2014)

See Also:

Xholon Project website, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	coin1
static java.lang.String	colorActiveState
static java.lang.String	colorInactiveState
static int	P_PARTNER
static int	push2
java.lang.String	roleName
static boolean	testing

Fields inherited from class org.primordion.xholon.base.XholonWithPorts

port

Fields inherited from interface org.primordion.user.app.Turnstile.CeTurnstile

DepositCoinEventCE, EventCE, EventsCE, PersonCE, PushThroughEventCE, TurnstileCE, TurnstileSystemCE, XholonClassCE

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

Constructor Summary

Constructors

Constructor and Description
XhTurnstile() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	act() Do some action during this time step.
java.lang.String	getRoleName() Get name of the role played by this Xholon within a specific context.
java.lang.Object	handleNodeSelection() Handle selection of a tree node by a user, as when a person clicks on a JTree node in the default viewer.
void	initialize() Initialize the tree node.
void	performActivity(int activityId, IMessage msg) Do the UML2 Activity identified by the activityId.
boolean	performGuard(int activityId, IMessage msg) Do the UML2 Activity identified by the activityId.
void	processReceivedMessage(IMessage msg) Process a received message taken from the message queue.
void	setRoleName(java.lang.String roleName) Set name of the role played by this Xholon within a specific context.
java.lang.String	toString() Search for instances of Xholon with ports that reference this instance.

Methods inherited from class org.primordion.xholon.base.XholonWithPorts

configure, configurePorts, getPort, getPort, isActiveObject, isBound, isContainer, isPassiveObject, postConfigure, setPort, setPort, setPorts, terminate

Methods inherited from class org.primordion.xholon.base.Xholon

actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, consoleLog, decVal, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPreviousSibling, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, 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, getXPath, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isAttributeHandler, isExternal, isInternal, isLeaf, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performVoidActivity, postAct, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, searchForReferencingNodesRecurse, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, 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, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

colorActiveState

public static final java.lang.String colorActiveState

See Also:

Constant Field Values

colorInactiveState

public static final java.lang.String colorInactiveState

See Also:

Constant Field Values

P_PARTNER

public static final int P_PARTNER

See Also:

Constant Field Values

coin1

public static final int coin1

See Also:

Constant Field Values

push2

public static final int push2

See Also:

Constant Field Values

testing

public static boolean testing

roleName

public java.lang.String roleName

Constructor Detail

XhTurnstile

public XhTurnstile()

Constructor.

Method Detail

initialize

public void initialize()

Description copied from interface: IXholon

Initialize the tree node. Typically this is only used to re-initialize a node, such as when it is reused through the TreeNodeFactoryStatic.

Specified by:

initialize in interface IXholon

Overrides:

initialize in class XholonWithPorts

setRoleName

public void setRoleName(java.lang.String roleName)

Description copied from interface: IXholon

Set name of the role played by this Xholon within a specific context.

Specified by:

setRoleName in interface IXholon

Overrides:

setRoleName in class Xholon

Parameters:

roleName - An optional name that identifies the role.

getRoleName

public java.lang.String getRoleName()

Description copied from interface: IXholon

Get name of the role played by this Xholon within a specific context.

Specified by:

getRoleName in interface IXholon

Overrides:

getRoleName in class Xholon

Returns:

A name that identifies the role, or null.

act

public void act()

Description copied from interface: IXholon

Do some action during this time step. Typically all nodes in the tree will do their pre-actions (optional), then all will do their actions, and then all will do their post-actions (optional).

Specified by:

act in interface IXholon

Overrides:

act in class Xholon

processReceivedMessage

public void processReceivedMessage(IMessage msg)

Description copied from interface: IXholon

Process a received message taken from the message queue. All sent messages are placed in queues before they are processed.

Specified by:

processReceivedMessage in interface IXholon

Overrides:

processReceivedMessage in class Xholon

Parameters:

msg - The message that was received.

performActivity

public void performActivity(int activityId,
                   IMessage msg)

Description copied from interface: IXholon

Do the UML2 Activity identified by the activityId. This is code called during a state Transition, or while entering, exiting, or within a State.

Specified by:

performActivity in interface IXholon

Overrides:

performActivity in class Xholon

Parameters:

activityId - An ID that uniquely identifies an activity to invoke.

msg - The message that triggered this Transition.

performGuard

public boolean performGuard(int activityId,
                   IMessage msg)

Description copied from interface: IXholon

Do the UML2 Activity identified by the activityId. This is code called before a Transition from a State or Choice, to check the Guard conditions.

Specified by:

performGuard in interface IXholon

Overrides:

performGuard in class Xholon

Parameters:

activityId - An ID that uniquely identifies an activity to invoke.

Returns:

true or false

handleNodeSelection

public java.lang.Object handleNodeSelection()

Description copied from interface: IXholon

Handle selection of a tree node by a user, as when a person clicks on a JTree node in the default viewer. Any action performed here should be minimal. Ideally there should be no side effects. WARNING: There may be thread issues.

Specified by:

handleNodeSelection in interface IXholon

Overrides:

handleNodeSelection in class Xholon

Returns:

An Object with information about that node, that could for example be displayed.

toString

public java.lang.String toString()

Description copied from class: XholonWithPorts

Search for instances of Xholon with ports that reference this instance.

Overrides:

toString in class XholonWithPorts