org.yawlfoundation.yawl.elements
Class YDecomposition

java.lang.Object
  extended by org.yawlfoundation.yawl.elements.YDecomposition
All Implemented Interfaces:
Cloneable, YVerifiable
Direct Known Subclasses:
YAWLServiceGateway, YNet

public abstract class YDecomposition
extends Object
implements Cloneable, YVerifiable

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

Field Summary
protected  String _codelet
           
protected  org.jdom.Document _data
           
protected  String _id
           
protected  boolean _manualInteraction
           
protected  YSpecification _specification
           
 
Constructor Summary
YDecomposition(String id, YSpecification specification)
           
 
Method Summary
protected  void addData(YPersistenceManager pmgr, org.jdom.Element element)
           
 void addInputParameter(YParameter parameter)
           
 void addOutputParameter(YParameter parameter)
           
 void assignData(YPersistenceManager pmgr, org.jdom.Element variable)
           
 Object clone()
           
 String getAttribute(String name)
           
 YAttributeMap getAttributes()
           
 String getCodelet()
           
 String getDocumentation()
           
 String getID()
           
 Set<String> getInputParameterNames()
           
 Map<String,YParameter> getInputParameters()
           
 org.jdom.Document getInternalDataDocument()
           
 YLogPredicate getLogPredicate()
           
 String getName()
           
 org.jdom.Document getNetDataDocument(String netData)
           
 org.jdom.Document getOutputData()
          This method returns the list of data from a decomposition.
 Set<String> getOutputParameterNames()
           
 Map<String,YParameter> getOutputParameters()
           
 Set<String> getOutputQueries()
           
 String getRootDataElementName()
           
 YSpecification getSpecification()
          Returns a link to the containing specification.
 Map<String,YParameter> getStateSpaceBypassParams()
          Gets those params that bypass the decomposition state space.
 org.jdom.Element getVariableDataByName(String name)
           
 void initialise(YPersistenceManager pmgr)
           
 void initializeDataStore(YPersistenceManager pmgr, YNetData casedata)
           
 boolean requiresResourcingDecisions()
           
 void restoreData(YNetData casedata)
           
 void setAttribute(String name, String value)
           
 void setAttributes(Map<String,String> attributes)
           
 void setCodelet(String codelet)
           
 void setDocumentation(String documentation)
           
 void setEnablementParameter(YParameter parameter)
           
 void setExternalInteraction(boolean interaction)
           
 void setLogPredicate(YLogPredicate predicate)
           
 void setName(String name)
           
 void setOutputExpression(String query)
           
 String toString()
           
 String toXML()
           
 List<YVerificationMessage> verify()
          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 String _id

_specification

protected YSpecification _specification

_data

protected org.jdom.Document _data

_manualInteraction

protected boolean _manualInteraction

_codelet

protected String _codelet
Constructor Detail

YDecomposition

public YDecomposition(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 org.jdom.Document getNetDataDocument(String netData)

getID

public String getID()

getAttributes

public YAttributeMap getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

getAttribute

public String getAttribute(String name)

setAttribute

public void setAttribute(String name,
                         String value)

getDocumentation

public String getDocumentation()

setDocumentation

public void setDocumentation(String documentation)

getName

public String getName()

setName

public void setName(String name)

getInputParameters

public Map<String,YParameter> getInputParameters()

getOutputParameters

public Map<String,YParameter> getOutputParameters()

addInputParameter

public void addInputParameter(YParameter parameter)

addOutputParameter

public void addOutputParameter(YParameter parameter)

setEnablementParameter

public void setEnablementParameter(YParameter parameter)

setOutputExpression

public void setOutputExpression(String query)

getOutputQueries

public Set<String> getOutputQueries()

setExternalInteraction

public void setExternalInteraction(boolean interaction)

requiresResourcingDecisions

public boolean requiresResourcingDecisions()

getCodelet

public String getCodelet()

setCodelet

public void setCodelet(String codelet)

getLogPredicate

public YLogPredicate getLogPredicate()

setLogPredicate

public void setLogPredicate(YLogPredicate predicate)

toXML

public String toXML()

verify

public List<YVerificationMessage> verify()
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
Returns:
a List of YVerificationMessage objects
See Also:
YVerificationMessage

getInputParameterNames

public Set<String> getInputParameterNames()

getOutputParameterNames

public Set<String> getOutputParameterNames()

getSpecification

public YSpecification getSpecification()
Returns a link to the containing specification.

Returns:
the specification containing this decomposition.

getStateSpaceBypassParams

public Map<String,YParameter> getStateSpaceBypassParams()
Gets those params that bypass the decomposition state space.

Returns:
a map of them.

toString

public String toString()
Overrides:
toString in class Object

clone

public Object clone()
             throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

getInternalDataDocument

public org.jdom.Document getInternalDataDocument()
Returns:
the document containing runtime variable values

getOutputData

public org.jdom.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 org.jdom.Element getVariableDataByName(String name)

assignData

public void assignData(YPersistenceManager pmgr,
                       org.jdom.Element variable)
                throws YPersistenceException
Throws:
YPersistenceException

addData

protected void addData(YPersistenceManager pmgr,
                       org.jdom.Element element)
                throws YPersistenceException
Throws:
YPersistenceException

initialise

public void initialise(YPersistenceManager pmgr)
                throws YPersistenceException
Throws:
YPersistenceException

getRootDataElementName

public String getRootDataElementName()


Copyright © 2004-2012 The YAWL Foundation.