org.yawlfoundation.yawl.elements

Class YTask

java.lang.Object

org.yawlfoundation.yawl.elements.YNetElement

org.yawlfoundation.yawl.elements.YExternalNetElement

org.yawlfoundation.yawl.elements.YTask

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, YVerifiable

Direct Known Subclasses:

YAtomicTask, YCompositeTask

public abstract class YTask
extends YExternalNetElement

A superclass of any type of task in the YAWL language.

Author:

Lachlan Aldred, Michael Adams (v2.0 and later)

Field Summary

Fields

Modifier and Type	Field and Description
static int	_AND
protected java.util.Map<java.lang.String,java.lang.String>	_dataMappingsForTaskEnablement
protected java.util.Map<java.lang.String,java.lang.String>	_dataMappingsForTaskStarting
protected YDecomposition	_decompositionPrototype
protected YIdentifier	_i
protected YInternalCondition	_mi_active
protected YInternalCondition	_mi_complete
protected YInternalCondition	_mi_entered
protected YInternalCondition	_mi_executing
protected YMultiInstanceAttributes	_multiInstAttr
static int	_OR
static int	_XOR

Fields inherited from class org.yawlfoundation.yawl.elements.YExternalNetElement

_documentation, _name, _net

Constructor Summary

Constructors

Constructor and Description
YTask(java.lang.String id, int joinType, int splitType, YNet container) Constructor

Method Summary

Modifier and Type	Method and Description
void	addRemovesTokensFrom(java.util.List<YExternalNetElement> removeSet)
void	cancel(YPersistenceManager pmgr)
protected void	checkExternalMapping(java.lang.String query, YVerificationHandler handler)
protected void	checkXQuery(java.lang.String xQuery, java.lang.String param, YVerificationHandler handler)
java.lang.Object	clone()
protected YIdentifier	createFiredIdentifier(YPersistenceManager pmgr)
protected Element	evaluateTreeQuery(java.lang.String query, Document document)
YLogDataItemList	get_inputLogDataItems()
YLogDataItemList	get_outputLogDataItems()
java.util.List<YInternalCondition>	getAllInternalConditions()
java.lang.String	getConfiguration()
Element	getConfigurationElement()
java.net.URL	getCustomFormURL()
Element	getData(YIdentifier childInstanceID)
java.lang.String	getDataBindingForEnablementParam(java.lang.String paramName) Returns the query to a decomposition enablement parameter.
java.lang.String	getDataBindingForInputParam(java.lang.String paramName) Returns the query to a decomposition input parameter.
java.lang.String	getDataBindingForOutputParam(java.lang.String paramName) Returns the query to a decomposition output parameter.
java.util.Map<java.lang.String,java.lang.String>	getDataMappingsForTaskCompletion()
java.util.Map<java.lang.String,java.lang.String>	getDataMappingsForTaskStarting()
YDecomposition	getDecompositionPrototype()
java.lang.String	getDefaultConfiguration()
Element	getDefaultConfigurationElement()
java.lang.String	getInformation()
int	getJoinType()
YInternalCondition	getMIActive()
YInternalCondition	getMIComplete()
YInternalCondition	getMIEntered()
YInternalCondition	getMIExecuting()
java.lang.String	getMIOutputAssignmentVar(java.lang.String query)
YMultiInstanceAttributes	getMultiInstanceAttributes()
protected YNetRunnerRepository	getNetRunnerRepository()
java.util.Collection<java.lang.String>	getParamNamesForTaskCompletion()
protected java.util.Set<java.lang.String>	getParamNamesForTaskEnablement()
protected java.util.Set<java.lang.String>	getParamNamesForTaskStarting()
java.lang.String	getPredicate(YExternalNetElement netElement)
java.lang.String	getPreSplittingMIQuery()
java.util.Set<YExternalNetElement>	getRemoveSet()
E2WFOJNet	getResetNet()
Element	getResourcingSpecs()
java.lang.String	getResourcingXML()
java.lang.String	getSpecVersion() Gets the version of the specification.
int	getSplitType()
Element	getStartingDataSnapshot()
YTimerParameters	getTimerParameters()
YTimerVariable	getTimerVariable()
protected YWorkItemRepository	getWorkItemRepository()
boolean	isMultiInstance()
protected boolean	isPopulatedEmptyTypeFlag(java.lang.String expression)
protected Element	performDataExtraction(java.lang.String expression, YParameter inputParam)
protected Element	performExternalDataExtraction(java.lang.String expression, YParameter inputParam)
protected void	performSchemaValidationOverExtractionResult(java.lang.String expression, YParameter param, Element result)
void	prepareDataDocsForTaskOutput()
void	prepareDataForInstanceStarting(YIdentifier childInstanceID)
protected Element	produceDataRootElement()
void	removeFromRemoveSet(YExternalNetElement e)
void	rollbackFired(YIdentifier childID, YPersistenceManager pmgr)
void	set_inputLogDataItems(YLogDataItemList _inputLogDataItems)
void	set_outputLogDataItems(YLogDataItemList _outputLogDataItems)
void	setConfiguration(java.lang.String config)
void	setConfigurationElement(Element configElement)
void	setCustomFormURI(java.net.URL formURL)
void	setDataBindingForEnablementParam(java.lang.String query, java.lang.String paramName) Connects the query to a decomposition enablement parameter.
void	setDataBindingForInputParam(java.lang.String query, java.lang.String paramName) Connects the query to a decomposition parameter.
void	setDataBindingForOutputExpression(java.lang.String query, java.lang.String netVarName) Binds an output expression of a decomposition to a net variable.
void	setDataMappingsForTaskCompletion(java.util.Map<java.lang.String,java.lang.String> map) The input must be map of [key="expression", value="variableName"]
void	setDataMappingsForTaskStarting(java.util.Map<java.lang.String,java.lang.String> map) The input must be map of [key="variableName", value="expression"]
void	setDecompositionPrototype(YDecomposition decomposition)
void	setDefaultConfiguration(java.lang.String defaultConfig)
void	setDefaultConfigurationElement(Element defaultConfigElement)
void	setI(YIdentifier i)
void	setJoinType(int joinType)
void	setMultiInstanceInputDataMappings(java.lang.String remoteVariableName, java.lang.String inputProcessingExpression)
void	setMultiInstanceOutputDataMappings(java.lang.String remoteOutputQuery, java.lang.String aggregationQuery)
void	setResetNet(E2WFOJNet net)
void	setResourcingSpecs(Element resSpec)
void	setResourcingXML(java.lang.String xml)
void	setSplitType(int splitType)
void	setTimerParameters(YTimerParameters timerParameters) TIMER SETTINGS **
void	setUpMultipleInstanceAttributes(java.lang.String minInstanceQuery, java.lang.String maxInstanceQuery, java.lang.String thresholdQuery, java.lang.String creationMode)
protected boolean	skipOutboundSchemaChecks() Indicates if schema validation is to be performed when starting the task.
protected abstract void	startOne(YPersistenceManager pmgr, YIdentifier id)
YIdentifier	t_add(YPersistenceManager pmgr, YIdentifier siblingWithPermission, Element newInstanceData)
boolean	t_addEnabled(YIdentifier identifier)
boolean	t_complete(YPersistenceManager pmgr, YIdentifier childID, Document decompositionOutputData)
boolean	t_enabled(YIdentifier id)
java.util.List<YIdentifier>	t_fire(YPersistenceManager pmgr)
boolean	t_isBusy()
boolean	t_isExitEnabled()
void	t_start(YPersistenceManager pmgr, YIdentifier child)
java.lang.String	toXML()
void	verify(YVerificationHandler handler) Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Methods inherited from class org.yawlfoundation.yawl.elements.YExternalNetElement

addPostset, addPreset, addToCancelledBySet, addToYawlMappings, addToYawlMappings, getCancelledBySet, getDocumentation, getDocumentationPreParsed, getName, getNet, getPostsetElement, getPostsetElements, getPostsetFlow, getPostsetFlows, getPresetElement, getPresetElements, getPresetFlow, getPresetFlows, getProperID, getYawlMappings, removeFromCancelledBySet, removePostsetFlow, removePresetFlow, setDocumentation, setID, setName, verifyPostsetFlows, verifyPresetFlows

Methods inherited from class org.yawlfoundation.yawl.elements.YNetElement

compareTo, getID, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_AND

public static final int _AND

See Also:

Constant Field Values

_OR

public static final int _OR

See Also:

Constant Field Values

_XOR

public static final int _XOR

See Also:

Constant Field Values

_i

protected YIdentifier _i

_mi_active

protected YInternalCondition _mi_active

_mi_entered

protected YInternalCondition _mi_entered

_mi_complete

protected YInternalCondition _mi_complete

_mi_executing

protected YInternalCondition _mi_executing

_multiInstAttr

protected YMultiInstanceAttributes _multiInstAttr

_dataMappingsForTaskStarting

protected final java.util.Map<java.lang.String,java.lang.String> _dataMappingsForTaskStarting

_dataMappingsForTaskEnablement

protected final java.util.Map<java.lang.String,java.lang.String> _dataMappingsForTaskEnablement

_decompositionPrototype

protected YDecomposition _decompositionPrototype

Constructor Detail

YTask

public YTask(java.lang.String id,
             int joinType,
             int splitType,
             YNet container)

Constructor

Parameters:

id -

splitType -

joinType -

container -

Method Detail

setI

public void setI(YIdentifier i)

getResetNet

public E2WFOJNet getResetNet()

setResetNet

public void setResetNet(E2WFOJNet net)

getSplitType

public int getSplitType()

getJoinType

public int getJoinType()

setSplitType

public void setSplitType(int splitType)

setJoinType

public void setJoinType(int joinType)

isMultiInstance

public boolean isMultiInstance()

getPredicate

public java.lang.String getPredicate(YExternalNetElement netElement)

getMultiInstanceAttributes

public YMultiInstanceAttributes getMultiInstanceAttributes()

setUpMultipleInstanceAttributes

public void setUpMultipleInstanceAttributes(java.lang.String minInstanceQuery,
                                            java.lang.String maxInstanceQuery,
                                            java.lang.String thresholdQuery,
                                            java.lang.String creationMode)

setMultiInstanceInputDataMappings

public void setMultiInstanceInputDataMappings(java.lang.String remoteVariableName,
                                              java.lang.String inputProcessingExpression)

setMultiInstanceOutputDataMappings

public void setMultiInstanceOutputDataMappings(java.lang.String remoteOutputQuery,
                                               java.lang.String aggregationQuery)

getParamNamesForTaskCompletion

public java.util.Collection<java.lang.String> getParamNamesForTaskCompletion()

checkXQuery

protected void checkXQuery(java.lang.String xQuery,
                           java.lang.String param,
                           YVerificationHandler handler)

checkExternalMapping

protected void checkExternalMapping(java.lang.String query,
                                    YVerificationHandler handler)

getParamNamesForTaskEnablement

protected java.util.Set<java.lang.String> getParamNamesForTaskEnablement()

getParamNamesForTaskStarting

protected java.util.Set<java.lang.String> getParamNamesForTaskStarting()

getDataMappingsForTaskStarting

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

getDataMappingsForTaskCompletion

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

getRemoveSet

public java.util.Set<YExternalNetElement> getRemoveSet()

addRemovesTokensFrom

public void addRemovesTokensFrom(java.util.List<YExternalNetElement> removeSet)

removeFromRemoveSet

public void removeFromRemoveSet(YExternalNetElement e)

t_fire

public java.util.List<YIdentifier> t_fire(YPersistenceManager pmgr)
                                   throws YStateException,
                                          YDataStateException,
                                          YQueryException,
                                          YPersistenceException

Throws:

YStateException

YDataStateException

YQueryException

YPersistenceException

prepareDataDocsForTaskOutput

public void prepareDataDocsForTaskOutput()

t_add

public YIdentifier t_add(YPersistenceManager pmgr,
                         YIdentifier siblingWithPermission,
                         Element newInstanceData)
                  throws YDataStateException,
                         YStateException,
                         YQueryException,
                         YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

t_addEnabled

public boolean t_addEnabled(YIdentifier identifier)

getPreSplittingMIQuery

public java.lang.String getPreSplittingMIQuery()

t_isExitEnabled

public boolean t_isExitEnabled()

t_complete

public boolean t_complete(YPersistenceManager pmgr,
                          YIdentifier childID,
                          Document decompositionOutputData)
                   throws YDataStateException,
                          YStateException,
                          YQueryException,
                          YPersistenceException

Throws:

YDataStateException

YStateException

YQueryException

YPersistenceException

getMIOutputAssignmentVar

public java.lang.String getMIOutputAssignmentVar(java.lang.String query)

t_start

public void t_start(YPersistenceManager pmgr,
                    YIdentifier child)
             throws YDataStateException,
                    YPersistenceException,
                    YQueryException,
                    YStateException

Throws:

YDataStateException

YPersistenceException

YQueryException

YStateException

getNetRunnerRepository

protected YNetRunnerRepository getNetRunnerRepository()

getWorkItemRepository

protected YWorkItemRepository getWorkItemRepository()

t_enabled

public boolean t_enabled(YIdentifier id)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class YExternalNetElement

Throws:

java.lang.CloneNotSupportedException

startOne

protected abstract void startOne(YPersistenceManager pmgr,
                                 YIdentifier id)
                          throws YDataStateException,
                                 YPersistenceException,
                                 YQueryException,
                                 YStateException

Throws:

YDataStateException

YPersistenceException

YQueryException

YStateException

createFiredIdentifier

protected YIdentifier createFiredIdentifier(YPersistenceManager pmgr)
                                     throws YPersistenceException

Throws:

YPersistenceException

prepareDataForInstanceStarting

public void prepareDataForInstanceStarting(YIdentifier childInstanceID)
                                    throws YDataStateException,
                                           YStateException,
                                           YQueryException

Throws:

YDataStateException

YStateException

YQueryException

getStartingDataSnapshot

public Element getStartingDataSnapshot()
                                throws YDataStateException,
                                       YStateException,
                                       YQueryException

Throws:

YDataStateException

YStateException

YQueryException

performDataExtraction

protected Element performDataExtraction(java.lang.String expression,
                                        YParameter inputParam)
                                 throws YDataStateException,
                                        YQueryException

Throws:

YDataStateException

YQueryException

isPopulatedEmptyTypeFlag

protected boolean isPopulatedEmptyTypeFlag(java.lang.String expression)

performExternalDataExtraction

protected Element performExternalDataExtraction(java.lang.String expression,
                                                YParameter inputParam)
                                         throws YStateException,
                                                YDataStateException

Throws:

YStateException

YDataStateException

performSchemaValidationOverExtractionResult

protected void performSchemaValidationOverExtractionResult(java.lang.String expression,
                                                           YParameter param,
                                                           Element result)
                                                    throws YDataStateException

Throws:

YDataStateException

produceDataRootElement

protected Element produceDataRootElement()

evaluateTreeQuery

protected Element evaluateTreeQuery(java.lang.String query,
                                    Document document)
                             throws YQueryException

Throws:

YQueryException

getData

public Element getData(YIdentifier childInstanceID)

t_isBusy

public boolean t_isBusy()

cancel

public void cancel(YPersistenceManager pmgr)
            throws YPersistenceException

Throws:

YPersistenceException

rollbackFired

public void rollbackFired(YIdentifier childID,
                          YPersistenceManager pmgr)
                   throws YPersistenceException

Throws:

YPersistenceException

getMIActive

public YInternalCondition getMIActive()

getMIEntered

public YInternalCondition getMIEntered()

getMIComplete

public YInternalCondition getMIComplete()

getMIExecuting

public YInternalCondition getMIExecuting()

getAllInternalConditions

public java.util.List<YInternalCondition> getAllInternalConditions()

setDataMappingsForTaskStarting

public void setDataMappingsForTaskStarting(java.util.Map<java.lang.String,java.lang.String> map)

The input must be map of [key="variableName", value="expression"]

Parameters:

map -

setDataMappingsForTaskCompletion

public void setDataMappingsForTaskCompletion(java.util.Map<java.lang.String,java.lang.String> map)

The input must be map of [key="expression", value="variableName"]

Parameters:

map -

toXML

public java.lang.String toXML()

Overrides:

toXML in class YExternalNetElement

getDecompositionPrototype

public YDecomposition getDecompositionPrototype()

setDecompositionPrototype

public void setDecompositionPrototype(YDecomposition decomposition)

setDataBindingForEnablementParam

public void setDataBindingForEnablementParam(java.lang.String query,
                                             java.lang.String paramName)

Connects the query to a decomposition enablement parameter.

Parameters:

query - a query applied to the net enablement variable in the net containing this task.

paramName - the enablement decomposition parameter to which to apply the result.

getDataBindingForEnablementParam

public java.lang.String getDataBindingForEnablementParam(java.lang.String paramName)

Returns the query to a decomposition enablement parameter.

Parameters:

paramName - the decomposition enablement variable.

Returns:

the data binding query for that parameter.

setDataBindingForInputParam

public void setDataBindingForInputParam(java.lang.String query,
                                        java.lang.String paramName)

Connects the query to a decomposition parameter.

Parameters:

query - a query applied to the net variables in the net containing this task.

paramName - the decomposition parameter to which to apply the result.

getDataBindingForInputParam

public java.lang.String getDataBindingForInputParam(java.lang.String paramName)

Returns the query to a decomposition input parameter.

Parameters:

paramName - the decomposition input parameter.

Returns:

the data binding query for that parameter.

setDataBindingForOutputExpression

public void setDataBindingForOutputExpression(java.lang.String query,
                                              java.lang.String netVarName)

Binds an output expression of a decomposition to a net variable.

Parameters:

query - the ouptut expression belonging to the tasks decomposition

netVarName - the net scope variable to which to apply the result.

getDataBindingForOutputParam

public java.lang.String getDataBindingForOutputParam(java.lang.String paramName)

Returns the query to a decomposition output parameter.

Parameters:

paramName - the decomposition output parameter.

Returns:

the data binding query for that parameter.

getInformation

public java.lang.String getInformation()

getSpecVersion

public java.lang.String getSpecVersion()

Gets the version of the specification.

Returns:

the specification version.

get_inputLogDataItems

public YLogDataItemList get_inputLogDataItems()

set_inputLogDataItems

public void set_inputLogDataItems(YLogDataItemList _inputLogDataItems)

get_outputLogDataItems

public YLogDataItemList get_outputLogDataItems()

set_outputLogDataItems

public void set_outputLogDataItems(YLogDataItemList _outputLogDataItems)

verify

public void verify(YVerificationHandler handler)

Description copied from interface: YVerifiable

Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Specified by:

verify in interface YVerifiable

Overrides:

verify in class YExternalNetElement

See Also:

YVerificationMessage

skipOutboundSchemaChecks

protected boolean skipOutboundSchemaChecks()

Indicates if schema validation is to be performed when starting the task.

Returns:

whether or not to skip validation on task starting.

getResourcingXML

public java.lang.String getResourcingXML()

setResourcingXML

public void setResourcingXML(java.lang.String xml)

getResourcingSpecs

public Element getResourcingSpecs()

setResourcingSpecs

public void setResourcingSpecs(Element resSpec)

setCustomFormURI

public void setCustomFormURI(java.net.URL formURL)

getCustomFormURL

public java.net.URL getCustomFormURL()

setTimerParameters

public void setTimerParameters(YTimerParameters timerParameters)

TIMER SETTINGS **

getTimerVariable

public YTimerVariable getTimerVariable()

getTimerParameters

public YTimerParameters getTimerParameters()

getConfiguration

public java.lang.String getConfiguration()

setConfiguration

public void setConfiguration(java.lang.String config)

getDefaultConfiguration

public java.lang.String getDefaultConfiguration()

setDefaultConfiguration

public void setDefaultConfiguration(java.lang.String defaultConfig)

getConfigurationElement

public Element getConfigurationElement()

setConfigurationElement

public void setConfigurationElement(Element configElement)

getDefaultConfigurationElement

public Element getDefaultConfigurationElement()

setDefaultConfigurationElement

public void setDefaultConfigurationElement(Element defaultConfigElement)