org.yawlfoundation.yawl.elements
Class YExternalNetElement

java.lang.Object
  extended by org.yawlfoundation.yawl.elements.YNetElement
      extended by org.yawlfoundation.yawl.elements.YExternalNetElement
All Implemented Interfaces:
Cloneable, Comparable, YVerifiable
Direct Known Subclasses:
YCondition, YTask

public abstract class YExternalNetElement
extends YNetElement
implements YVerifiable

A superclass for any type of task or condition in the YAWL paper.

Author:
Lachlan Aldred, Michael Adams (updated/refactored for v2 2009)

Field Summary
protected  String _documentation
           
protected  String _name
           
 YNet _net
           
 
Constructor Summary
YExternalNetElement(String id, YNet container)
           
 
Method Summary
 void addPostset(YFlow flow)
          adds a flow to the set of outgoing flows for this element
 void addPreset(YFlow flow)
          adds a flow to the set of incoming flows for this element
 void addToCancelledBySet(YTask t)
           
 void addToYawlMappings(Set<YExternalNetElement> elements)
           
 void addToYawlMappings(YExternalNetElement e)
           
 Object clone()
           
 Set<YExternalNetElement> getCancelledBySet()
           
 String getDocumentation()
           
 String getDocumentationPreParsed()
           
 String getName()
           
 YNet getNet()
          Gets the net that contains this atomic task.
 YExternalNetElement getPostsetElement(String id)
          gets an element on an outgoing flow from this element
 Set<YExternalNetElement> getPostsetElements()
          gets the set of elements that succeed this element directly via flows between them
 YFlow getPostsetFlow(YExternalNetElement netElement)
          gets the flow between this and the succeeding netElement passed (if any)
 Set<YFlow> getPostsetFlows()
          gets the set of outgoing flows from this element
 YExternalNetElement getPresetElement(String id)
          gets an element on an incoming flow to this element
 Set<YExternalNetElement> getPresetElements()
          gets the set of elements that precede this element directly via flows between them
 YFlow getPresetFlow(YExternalNetElement netElement)
          gets the flow between this and the preceding netElement passed (if any)
 Set<YFlow> getPresetFlows()
          gets the set of incoming flows to this element
 String getProperID()
           
 Set<YExternalNetElement> getYawlMappings()
           
 void removeFromCancelledBySet(YTask t)
           
 void removePostsetFlow(YFlow flow)
          removes a flow from the set of outgoing flows for this element
 void removePresetFlow(YFlow flow)
          removes a flow from the set of incoming flows for this element
 void setDocumentation(String doco)
           
 void setName(String name)
           
 String toXML()
           
 List<YVerificationMessage> verify()
          Internally verify the object against YAWL language semantics and report any errors and/or warnings.
protected  List<YVerificationMessage> verifyPostsetFlows()
           
protected  List<YVerificationMessage> 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

_name

protected String _name

_documentation

protected String _documentation

_net

public YNet _net
Constructor Detail

YExternalNetElement

public YExternalNetElement(String id,
                           YNet container)
Method Detail

getName

public String getName()

setName

public void setName(String name)

getDocumentation

public String getDocumentation()

getDocumentationPreParsed

public String getDocumentationPreParsed()

setDocumentation

public void setDocumentation(String doco)

getNet

public YNet getNet()
Gets the net that contains this atomic task.

Returns:
the containing net.

getProperID

public String getProperID()

addPreset

public void addPreset(YFlow flow)
adds a flow to the set of incoming flows for this element

Parameters:
flow - the incoming flow

addPostset

public void addPostset(YFlow flow)
adds a flow to the set of outgoing flows for this element

Parameters:
flow - the outgoing flow

removePresetFlow

public void removePresetFlow(YFlow flow)
removes a flow from the set of incoming flows for this element

Parameters:
flow - the incoming flow

removePostsetFlow

public void removePostsetFlow(YFlow flow)
removes a flow from the set of outgoing flows for this element

Parameters:
flow - the outgoing flow

getPostsetElements

public Set<YExternalNetElement> getPostsetElements()
gets the set of elements that succeed this element directly via flows between them

Returns:
the set of succeeding elements

getPresetElements

public Set<YExternalNetElement> getPresetElements()
gets the set of elements that precede this element directly via flows between them

Returns:
the set of preceding elements

getPostsetFlow

public YFlow getPostsetFlow(YExternalNetElement netElement)
gets the flow between this and the succeeding netElement passed (if any)

Parameters:
netElement - an element that follows this via a flow
Returns:
the flow connecting the elements

getPresetFlow

public YFlow getPresetFlow(YExternalNetElement netElement)
gets the flow between this and the preceding netElement passed (if any)

Parameters:
netElement - an element that precedes this via a flow
Returns:
the flow connecting the elements

getPostsetFlows

public Set<YFlow> getPostsetFlows()
gets the set of outgoing flows from this element

Returns:
the set of outgoing flows

getPresetFlows

public Set<YFlow> getPresetFlows()
gets the set of incoming flows to this element

Returns:
the set of incoming flows

getPostsetElement

public YExternalNetElement getPostsetElement(String id)
gets an element on an outgoing flow from this element

Parameters:
id - the id of the element on the outgoing flow
Returns:
the element if found, or null if not

getPresetElement

public YExternalNetElement getPresetElement(String id)
gets an element on an incoming flow to this element

Parameters:
id - the id of the element on the incoming flow
Returns:
the element if found, or null if not

getCancelledBySet

public Set<YExternalNetElement> getCancelledBySet()

addToCancelledBySet

public void addToCancelledBySet(YTask t)

removeFromCancelledBySet

public void removeFromCancelledBySet(YTask t)

getYawlMappings

public Set<YExternalNetElement> getYawlMappings()

addToYawlMappings

public void addToYawlMappings(YExternalNetElement e)

addToYawlMappings

public void addToYawlMappings(Set<YExternalNetElement> elements)

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

verifyPostsetFlows

protected List<YVerificationMessage> verifyPostsetFlows()

verifyPresetFlows

protected List<YVerificationMessage> verifyPresetFlows()

clone

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

toXML

public String toXML()


Copyright © 2004-2012 The YAWL Foundation.