org.yawlfoundation.yawl.elements

Class YExternalNetElement

java.lang.Object

org.yawlfoundation.yawl.elements.YNetElement

org.yawlfoundation.yawl.elements.YExternalNetElement

All Implemented Interfaces:

java.lang.Cloneable, java.lang.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

Fields

Modifier and Type	Field and Description
protected java.lang.String	_documentation
protected java.lang.String	_name
YNet	_net

Constructor Summary

Constructors

Constructor and Description
YExternalNetElement(java.lang.String id, YNet container)

Method Summary

Modifier and Type	Method and Description
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(java.util.Set<YExternalNetElement> elements)
void	addToYawlMappings(YExternalNetElement e)
java.lang.Object	clone()
java.util.Set<YExternalNetElement>	getCancelledBySet()
java.lang.String	getDocumentation()
java.lang.String	getDocumentationPreParsed()
java.lang.String	getName()
YNet	getNet() Gets the net that contains this atomic task.
YExternalNetElement	getPostsetElement(java.lang.String id) gets an element on an outgoing flow from this element
java.util.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)
java.util.Set<YFlow>	getPostsetFlows() gets the set of outgoing flows from this element
YExternalNetElement	getPresetElement(java.lang.String id) gets an element on an incoming flow to this element
java.util.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)
java.util.Set<YFlow>	getPresetFlows() gets the set of incoming flows to this element
java.lang.String	getProperID()
java.util.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(java.lang.String doco)
void	setID(java.lang.String id)
void	setName(java.lang.String name)
java.lang.String	toXML()
void	verify(YVerificationHandler handler) Internally verify the object against YAWL language semantics and report any errors and/or warnings.
protected void	verifyPostsetFlows(YVerificationHandler handler)
protected void	verifyPresetFlows(YVerificationHandler handler)

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 java.lang.String _name

_documentation

protected java.lang.String _documentation

_net

public YNet _net

Constructor Detail

YExternalNetElement

public YExternalNetElement(java.lang.String id,
                           YNet container)

Method Detail

setID

public void setID(java.lang.String id)

Overrides:

setID in class YNetElement

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDocumentation

public java.lang.String getDocumentation()

getDocumentationPreParsed

public java.lang.String getDocumentationPreParsed()

setDocumentation

public void setDocumentation(java.lang.String doco)

getNet

public YNet getNet()

Gets the net that contains this atomic task.

Returns:

the containing net.

getProperID

public java.lang.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 java.util.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 java.util.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 java.util.Set<YFlow> getPostsetFlows()

gets the set of outgoing flows from this element

Returns:

the set of outgoing flows

getPresetFlows

public java.util.Set<YFlow> getPresetFlows()

gets the set of incoming flows to this element

Returns:

the set of incoming flows

getPostsetElement

public YExternalNetElement getPostsetElement(java.lang.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(java.lang.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 java.util.Set<YExternalNetElement> getCancelledBySet()

addToCancelledBySet

public void addToCancelledBySet(YTask t)

removeFromCancelledBySet

public void removeFromCancelledBySet(YTask t)

getYawlMappings

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

addToYawlMappings

public void addToYawlMappings(YExternalNetElement e)

addToYawlMappings

public void addToYawlMappings(java.util.Set<YExternalNetElement> elements)

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

verifyPostsetFlows

protected void verifyPostsetFlows(YVerificationHandler handler)

verifyPresetFlows

protected void verifyPresetFlows(YVerificationHandler handler)

clone

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

Overrides:

clone in class YNetElement

Throws:

java.lang.CloneNotSupportedException

toXML

public java.lang.String toXML()