org.yawlfoundation.yawl.engine

Class YNetRunner

java.lang.Object

org.yawlfoundation.yawl.engine.YNetRunner

public class YNetRunner
extends java.lang.Object

Author:

Lachlan Aldred Date: 16/04/2003 Time: 16:08:01, Michael Adams (for v2)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YNetRunner.ExecutionStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected YNet	_net

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YNetRunner()
	YNetRunner(YPersistenceManager pmgr, YNet netPrototype, Element paramsData, java.lang.String caseID)
	YNetRunner(YPersistenceManager pmgr, YNet netPrototype, YCompositeTask container, YIdentifier caseIDForNet, Element incomingData) Constructor called by a composite task (creating a sub-net runner)

Method Summary

Modifier and Type	Method and Description
void	addBusyTask(YTask ext)
void	addEnabledTask(YTask ext)
YIdentifier	addNewInstance(YPersistenceManager pmgr, java.lang.String taskID, YIdentifier aSiblingInstance, Element newInstanceData)
java.util.List<YIdentifier>	attemptToFireAtomicTask(YPersistenceManager pmgr, java.lang.String taskID)
void	cancel(YPersistenceManager pmgr)
void	cancelTask(YPersistenceManager pmgr, java.lang.String taskID) cancels the specified task
boolean	completeWorkItemInTask(YPersistenceManager pmgr, YWorkItem workItem, Document outputData)
boolean	completeWorkItemInTask(YPersistenceManager pmgr, YWorkItem workItem, YIdentifier caseID, java.lang.String taskID, Document outputData)
boolean	continueIfPossible(YPersistenceManager pmgr)
void	dump()
boolean	endOfNetReached()
boolean	equals(java.lang.Object other)
boolean	evaluateTimerPredicate(java.lang.String predicate)
java.lang.String	get_caseID()
YIdentifier	get_caseIDForNet()
protected java.lang.String	get_caseObserverStr() these two methods are here to support persistence of the IB Observer
java.util.Map<java.lang.String,java.lang.String>	get_timerStates()
protected java.util.Set<YTask>	getActiveTasks()
java.util.Set<java.lang.String>	getBusyTaskNames()
protected java.util.Set<YTask>	getBusyTasks()
YIdentifier	getCaseID()
java.lang.String	getContainingTaskID()
java.util.Set<java.lang.String>	getEnabledTaskNames()
protected java.util.Set<YTask>	getEnabledTasks()
java.lang.String	getExecutionStatus()
YNet	getNet()
YNetData	getNetData()
YExternalNetElement	getNetElement(java.lang.String id)
YSpecificationID	getSpecificationID()
long	getStartTime()
java.util.List<java.lang.String>	getTimeOutTaskSet(YWorkItem item) returns a list of all workitems executing in parallel to the time-out workitem passed (the list includes the time-out task)
protected boolean	hasActiveTasks()
int	hashCode()
boolean	hasNormalState()
void	initTimerStates()
boolean	isAddEnabled(java.lang.String taskID, YIdentifier childID)
boolean	isAlive()
boolean	isCompleted()
boolean	isEmpty()
boolean	isInSuspense()
boolean	isResuming()
boolean	isSuspended()
boolean	isSuspending()
boolean	isTimeServiceTask(YWorkItem item) returns true if the specified workitem is registered with the Time Service
void	kick(YPersistenceManager pmgr) Assumption: this will only get called AFTER a workitem has been progressed? Because if it is called any other time then it will cause the case to stop.
protected void	processEmptyTask(YAtomicTask task, YPersistenceManager pmgr)
java.util.Set<YAnnouncement>	refreshAnnouncements()
void	removeActiveTask(YPersistenceManager pmgr, YTask task)
void	removeFromPersistence(YPersistenceManager pmgr)
void	restoreObservers() restores the IB and IX observers on session startup (via persistence)
void	restoreTimerStates()
boolean	rollbackWorkItem(YPersistenceManager pmgr, YIdentifier caseID, java.lang.String taskID)
void	set_caseID(java.lang.String ID)
void	set_caseIDForNet(YIdentifier id)
protected void	set_caseObserverStr(java.lang.String obStr)
void	set_timerStates(java.util.Map<java.lang.String,java.lang.String> states)
protected void	setBusyTaskNames(java.util.Set<java.lang.String> names)
void	setContainingTask(YCompositeTask task)
void	setContainingTaskID(java.lang.String taskid)
protected void	setEnabledTaskNames(java.util.Set<java.lang.String> names)
void	setEngine(YEngine engine)
void	setExecutionStatus(java.lang.String status)
void	setNet(YNet net)
void	setNetData(YNetData data)
void	setObserver(YAWLServiceReference observer)
void	setSpecificationID(YSpecificationID id)
void	setStartTime(long time)
void	setStateNormal()
void	setStateResuming()
void	setStateSuspended()
void	setStateSuspending()
void	start(YPersistenceManager pmgr)
void	startWorkItemInTask(YPersistenceManager pmgr, YIdentifier caseID, java.lang.String taskID)
void	startWorkItemInTask(YPersistenceManager pmgr, YWorkItem workItem)
java.lang.String	toString()
void	updateTimerState(YTask task, YWorkItemTimer.State state)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_net

protected YNet _net

Constructor Detail

YNetRunner

protected YNetRunner()

YNetRunner

public YNetRunner(YPersistenceManager pmgr,
                  YNet netPrototype,
                  Element paramsData,
                  java.lang.String caseID)
           throws YStateException,
                  YDataStateException,
                  YPersistenceException

Throws:

YStateException

YDataStateException

YPersistenceException

YNetRunner

public YNetRunner(YPersistenceManager pmgr,
                  YNet netPrototype,
                  YCompositeTask container,
                  YIdentifier caseIDForNet,
                  Element incomingData)
           throws YDataStateException,
                  YPersistenceException

Constructor called by a composite task (creating a sub-net runner)

Parameters:

pmgr -

netPrototype -

container -

caseIDForNet -

incomingData -

Throws:

YDataStateException

YPersistenceException

Method Detail

refreshAnnouncements

public java.util.Set<YAnnouncement> refreshAnnouncements()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setContainingTask

public void setContainingTask(YCompositeTask task)

getContainingTaskID

public java.lang.String getContainingTaskID()

setContainingTaskID

public void setContainingTaskID(java.lang.String taskid)

setNet

public void setNet(YNet net)

getNet

public YNet getNet()

setEngine

public void setEngine(YEngine engine)

getSpecificationID

public YSpecificationID getSpecificationID()

setSpecificationID

public void setSpecificationID(YSpecificationID id)

getNetData

public YNetData getNetData()

setNetData

public void setNetData(YNetData data)

get_caseIDForNet

public YIdentifier get_caseIDForNet()

set_caseIDForNet

public void set_caseIDForNet(YIdentifier id)

addBusyTask

public void addBusyTask(YTask ext)

addEnabledTask

public void addEnabledTask(YTask ext)

removeActiveTask

public void removeActiveTask(YPersistenceManager pmgr,
                             YTask task)
                      throws YPersistenceException

Throws:

YPersistenceException

get_caseID

public java.lang.String get_caseID()

set_caseID

public void set_caseID(java.lang.String ID)

getEnabledTaskNames

public java.util.Set<java.lang.String> getEnabledTaskNames()

getBusyTaskNames

public java.util.Set<java.lang.String> getBusyTaskNames()

setEnabledTaskNames

protected void setEnabledTaskNames(java.util.Set<java.lang.String> names)

setBusyTaskNames

protected void setBusyTaskNames(java.util.Set<java.lang.String> names)

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long time)

start

public void start(YPersistenceManager pmgr)
           throws YPersistenceException,
                  YDataStateException,
                  YQueryException,
                  YStateException

Throws:

YPersistenceException

YDataStateException

YQueryException

YStateException

isAlive

public boolean isAlive()

kick

public void kick(YPersistenceManager pmgr)
          throws YPersistenceException,
                 YDataStateException,
                 YQueryException,
                 YStateException

Assumption: this will only get called AFTER a workitem has been progressed? Because if it is called any other time then it will cause the case to stop.

Parameters:

pmgr -

Throws:

YPersistenceException

YDataStateException

YQueryException

YStateException

attemptToFireAtomicTask

public java.util.List<YIdentifier> attemptToFireAtomicTask(YPersistenceManager pmgr,
                                                           java.lang.String taskID)
                                                    throws YDataStateException,
                                                           YStateException,
                                                           YQueryException,
                                                           YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

addNewInstance

public YIdentifier addNewInstance(YPersistenceManager pmgr,
                                  java.lang.String taskID,
                                  YIdentifier aSiblingInstance,
                                  Element newInstanceData)
                           throws YDataStateException,
                                  YStateException,
                                  YQueryException,
                                  YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

startWorkItemInTask

public void startWorkItemInTask(YPersistenceManager pmgr,
                                YWorkItem workItem)
                         throws YDataStateException,
                                YPersistenceException,
                                YQueryException,
                                YStateException

Throws:

YDataStateException

YPersistenceException

YQueryException

YStateException

startWorkItemInTask

public void startWorkItemInTask(YPersistenceManager pmgr,
                                YIdentifier caseID,
                                java.lang.String taskID)
                         throws YDataStateException,
                                YPersistenceException,
                                YQueryException,
                                YStateException

Throws:

YDataStateException

YPersistenceException

YQueryException

YStateException

completeWorkItemInTask

public boolean completeWorkItemInTask(YPersistenceManager pmgr,
                                      YWorkItem workItem,
                                      Document outputData)
                               throws YDataStateException,
                                      YStateException,
                                      YQueryException,
                                      YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

completeWorkItemInTask

public boolean completeWorkItemInTask(YPersistenceManager pmgr,
                                      YWorkItem workItem,
                                      YIdentifier caseID,
                                      java.lang.String taskID,
                                      Document outputData)
                               throws YDataStateException,
                                      YStateException,
                                      YQueryException,
                                      YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

continueIfPossible

public boolean continueIfPossible(YPersistenceManager pmgr)
                           throws YDataStateException,
                                  YStateException,
                                  YQueryException,
                                  YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

processEmptyTask

protected void processEmptyTask(YAtomicTask task,
                                YPersistenceManager pmgr)
                         throws YDataStateException,
                                YStateException,
                                YQueryException,
                                YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

cancel

public void cancel(YPersistenceManager pmgr)
            throws YPersistenceException

Throws:

YPersistenceException

removeFromPersistence

public void removeFromPersistence(YPersistenceManager pmgr)
                           throws YPersistenceException

Throws:

YPersistenceException

rollbackWorkItem

public boolean rollbackWorkItem(YPersistenceManager pmgr,
                                YIdentifier caseID,
                                java.lang.String taskID)
                         throws YPersistenceException

Throws:

YPersistenceException

getNetElement

public YExternalNetElement getNetElement(java.lang.String id)

getCaseID

public YIdentifier getCaseID()

isCompleted

public boolean isCompleted()

endOfNetReached

public boolean endOfNetReached()

isEmpty

public boolean isEmpty()

getBusyTasks

protected java.util.Set<YTask> getBusyTasks()

getEnabledTasks

protected java.util.Set<YTask> getEnabledTasks()

getActiveTasks

protected java.util.Set<YTask> getActiveTasks()

hasActiveTasks

protected boolean hasActiveTasks()

isAddEnabled

public boolean isAddEnabled(java.lang.String taskID,
                            YIdentifier childID)

setObserver

public void setObserver(YAWLServiceReference observer)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dump

public void dump()

restoreObservers

public void restoreObservers()

restores the IB and IX observers on session startup (via persistence)

get_caseObserverStr

protected java.lang.String get_caseObserverStr()

these two methods are here to support persistence of the IB Observer

set_caseObserverStr

protected void set_caseObserverStr(java.lang.String obStr)

cancelTask

public void cancelTask(YPersistenceManager pmgr,
                       java.lang.String taskID)

cancels the specified task

isTimeServiceTask

public boolean isTimeServiceTask(YWorkItem item)

returns true if the specified workitem is registered with the Time Service

getTimeOutTaskSet

public java.util.List<java.lang.String> getTimeOutTaskSet(YWorkItem item)

returns a list of all workitems executing in parallel to the time-out workitem passed (the list includes the time-out task)

initTimerStates

public void initTimerStates()

restoreTimerStates

public void restoreTimerStates()

updateTimerState

public void updateTimerState(YTask task,
                             YWorkItemTimer.State state)

get_timerStates

public java.util.Map<java.lang.String,java.lang.String> get_timerStates()

set_timerStates

public void set_timerStates(java.util.Map<java.lang.String,java.lang.String> states)

evaluateTimerPredicate

public boolean evaluateTimerPredicate(java.lang.String predicate)
                               throws YQueryException

Throws:

YQueryException

isSuspending

public boolean isSuspending()

isSuspended

public boolean isSuspended()

isResuming

public boolean isResuming()

isInSuspense

public boolean isInSuspense()

hasNormalState

public boolean hasNormalState()

setStateSuspending

public void setStateSuspending()

setStateSuspended

public void setStateSuspended()

setStateResuming

public void setStateResuming()

setStateNormal

public void setStateNormal()

setExecutionStatus

public void setExecutionStatus(java.lang.String status)

getExecutionStatus

public java.lang.String getExecutionStatus()