org.yawlfoundation.yawl.elements

Class YDecomposition

java.lang.Object

org.yawlfoundation.yawl.elements.YDecomposition

All Implemented Interfaces:

java.lang.Cloneable, YVerifiable

Direct Known Subclasses:

YAWLServiceGateway, YNet

public abstract class YDecomposition
extends java.lang.Object
implements java.lang.Cloneable, YVerifiable

Author:

Lachlan Aldred Date: 25/09/2003 Time: 16:04:21 Refactored for 2.0 by Michael Adams

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_codelet
protected Document	_data
protected java.lang.String	_id
protected boolean	_manualInteraction
protected YSpecification	_specification

Constructor Summary

Constructors

Constructor and Description
YDecomposition(java.lang.String id, YSpecification specification)

Method Summary

Modifier and Type	Method and Description
protected void	addData(YPersistenceManager pmgr, Element element)
void	addInputParameter(YParameter parameter)
void	addOutputParameter(YParameter parameter)
void	assignData(YPersistenceManager pmgr, Element variable)
java.lang.Object	clone()
java.lang.String	getAttribute(java.lang.String name)
YAttributeMap	getAttributes()
java.lang.String	getCodelet()
java.lang.String	getDocumentation()
java.lang.String	getID()
java.util.Set<java.lang.String>	getInputParameterNames()
java.util.Map<java.lang.String,YParameter>	getInputParameters()
Document	getInternalDataDocument()
YLogPredicate	getLogPredicate()
java.lang.String	getName()
Document	getNetDataDocument(java.lang.String netData)
Document	getOutputData() This method returns the list of data from a decomposition.
java.util.Set<java.lang.String>	getOutputParameterNames()
java.util.Map<java.lang.String,YParameter>	getOutputParameters()
java.util.Set<java.lang.String>	getOutputQueries()
java.lang.String	getRootDataElementName()
YSpecification	getSpecification() Returns a link to the containing specification.
java.util.Map<java.lang.String,YParameter>	getStateSpaceBypassParams() Gets those params that bypass the decomposition state space.
Element	getVariableDataByName(java.lang.String name)
void	initialise(YPersistenceManager pmgr)
void	initializeDataStore(YPersistenceManager pmgr, YNetData casedata)
YParameter	removeInputParameter(java.lang.String name)
YParameter	removeInputParameter(YParameter parameter)
YParameter	removeOutputParameter(java.lang.String name)
YParameter	removeOutputParameter(YParameter parameter)
boolean	requiresResourcingDecisions()
void	restoreData(YNetData casedata)
void	setAttribute(java.lang.String name, DynamicValue value)
void	setAttribute(java.lang.String name, java.lang.String value)
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	setCodelet(java.lang.String codelet)
void	setDocumentation(java.lang.String documentation)
void	setEnablementParameter(YParameter parameter)
void	setExternalInteraction(boolean interaction)
void	setID(java.lang.String id)
void	setLogPredicate(YLogPredicate predicate)
void	setName(java.lang.String name)
void	setOutputExpression(java.lang.String query)
void	setSpecification(YSpecification specification)
java.lang.String	toString()
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 java.lang.Object

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

Field Detail

_id

protected java.lang.String _id

_specification

protected YSpecification _specification

_data

protected Document _data

_manualInteraction

protected boolean _manualInteraction

_codelet

protected java.lang.String _codelet

Constructor Detail

YDecomposition

public YDecomposition(java.lang.String id,
                      YSpecification specification)

Method Detail

initializeDataStore

public void initializeDataStore(YPersistenceManager pmgr,
                                YNetData casedata)
                         throws YPersistenceException

Throws:

YPersistenceException

restoreData

public void restoreData(YNetData casedata)

getNetDataDocument

public Document getNetDataDocument(java.lang.String netData)

getID

public java.lang.String getID()

setID

public void setID(java.lang.String id)

getAttributes

public YAttributeMap getAttributes()

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

getAttribute

public java.lang.String getAttribute(java.lang.String name)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

setAttribute

public void setAttribute(java.lang.String name,
                         DynamicValue value)

getDocumentation

public java.lang.String getDocumentation()

setDocumentation

public void setDocumentation(java.lang.String documentation)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getInputParameters

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

getOutputParameters

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

addInputParameter

public void addInputParameter(YParameter parameter)

removeInputParameter

public YParameter removeInputParameter(YParameter parameter)

removeInputParameter

public YParameter removeInputParameter(java.lang.String name)

addOutputParameter

public void addOutputParameter(YParameter parameter)

removeOutputParameter

public YParameter removeOutputParameter(YParameter parameter)

removeOutputParameter

public YParameter removeOutputParameter(java.lang.String name)

setEnablementParameter

public void setEnablementParameter(YParameter parameter)

setOutputExpression

public void setOutputExpression(java.lang.String query)

getOutputQueries

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

setExternalInteraction

public void setExternalInteraction(boolean interaction)

requiresResourcingDecisions

public boolean requiresResourcingDecisions()

getCodelet

public java.lang.String getCodelet()

setCodelet

public void setCodelet(java.lang.String codelet)

getLogPredicate

public YLogPredicate getLogPredicate()

setLogPredicate

public void setLogPredicate(YLogPredicate predicate)

toXML

public java.lang.String toXML()

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

See Also:

YVerificationMessage

getInputParameterNames

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

getOutputParameterNames

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

getSpecification

public YSpecification getSpecification()

Returns a link to the containing specification.

Returns:

the specification containing this decomposition.

setSpecification

public void setSpecification(YSpecification specification)

getStateSpaceBypassParams

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

Gets those params that bypass the decomposition state space.

Returns:

a map of them.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

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

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getInternalDataDocument

public Document getInternalDataDocument()

Returns:

the document containing runtime variable values

getOutputData

public Document getOutputData()

This method returns the list of data from a decomposition. According to its declared output parameters. Only useful for Beta 4 and above. The data inside this decomposition is groomed so to speak so that the output data is returned in sequence. Furthermore no internal variables, \ or input only parameters are returned.

Returns:

a JDom Document of the output data.

getVariableDataByName

public Element getVariableDataByName(java.lang.String name)

assignData

public void assignData(YPersistenceManager pmgr,
                       Element variable)
                throws YPersistenceException

Throws:

YPersistenceException

addData

protected void addData(YPersistenceManager pmgr,
                       Element element)
                throws YPersistenceException

Throws:

YPersistenceException

initialise

public void initialise(YPersistenceManager pmgr)
                throws YPersistenceException

Throws:

YPersistenceException

getRootDataElementName

public java.lang.String getRootDataElementName()