org.eclipse.uml2.uml
Interface ActivityEdge

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, RedefinableElement
All Known Subinterfaces:
ControlFlow, ObjectFlow

public interface ActivityEdge
extends RedefinableElement

A representation of the model object 'Activity Edge'. An activity edge is an abstract class for directed connections between two activity nodes. Activity edges can be contained in interruptible regions.

The following features are supported:

See Also:
UMLPackage.getActivityEdge()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 ValueSpecification createGuard(String name, Type type, EClass eClass)
          Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Guard' containment reference
 ValueSpecification createWeight(String name, Type type, EClass eClass)
          Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Weight' containment reference
 Activity getActivity()
          Returns the value of the 'Activity' container reference.
 ValueSpecification getGuard()
          Returns the value of the 'Guard' containment reference
 EList getInGroups()
          Returns the value of the 'In Group' reference list.
 ActivityPartition getInPartition(String name)
          Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list
 ActivityPartition getInPartition(String name, boolean ignoreCase)
          Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list
 EList getInPartitions()
          Returns the value of the 'In Partition' reference list.
 StructuredActivityNode getInStructuredNode()
          Returns the value of the 'In Structured Node' container reference.
 InterruptibleActivityRegion getInterrupts()
          Returns the value of the 'Interrupts' reference.
 ActivityEdge getRedefinedEdge(String name)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Redefined Edge' reference list
 ActivityEdge getRedefinedEdge(String name, boolean ignoreCase, EClass eClass)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Redefined Edge' reference list
 EList getRedefinedEdges()
          Returns the value of the 'Redefined Edge' reference list.
 ActivityNode getSource()
          Returns the value of the 'Source' reference.
 ActivityNode getTarget()
          Returns the value of the 'Target' reference.
 ValueSpecification getWeight()
          Returns the value of the 'Weight' containment reference
 void setActivity(Activity value)
          Sets the value of the 'Activity' container reference
 void setGuard(ValueSpecification value)
          Sets the value of the 'Guard' containment reference
 void setInStructuredNode(StructuredActivityNode value)
          Sets the value of the 'In Structured Node' container reference
 void setInterrupts(InterruptibleActivityRegion value)
          Sets the value of the 'Interrupts' reference
 void setSource(ActivityNode value)
          Sets the value of the 'Source' reference
 void setTarget(ActivityNode value)
          Sets the value of the 'Target' reference
 void setWeight(ValueSpecification value)
          Sets the value of the 'Weight' containment reference
 boolean validateOwned(DiagnosticChain diagnostics, Map context)
           Activity edges may be owned only by activities or groups.
 boolean validateSourceAndTarget(DiagnosticChain diagnostics, Map context)
           The source and target of an edge must be in the same activity as the edge.
 boolean validateStructuredNode(DiagnosticChain diagnostics, Map context)
           Activity edges may be owned by at most one structured node.
 
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.uml.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.uml.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getActivity

public Activity getActivity()
Returns the value of the 'Activity' container reference. It is bidirectional and its opposite is 'Edge'. Activity containing the edge.

Returns:
the value of the 'Activity' container reference.
See Also:
ActivityEdge.setActivity(Activity), UMLPackage.getActivityEdge_Activity(), Activity.getEdges()

setActivity

public void setActivity(Activity value)
Sets the value of the 'Activity' container reference.

Parameters:
value - the new value of the 'Activity' container reference.
See Also:
ActivityEdge.getActivity()

getInGroups

public EList getInGroups()
Returns the value of the 'In Group' reference list. The list contents are of type ActivityGroup. It is bidirectional and its opposite is 'Contained Edge'. Groups containing the edge.

Returns:
the value of the 'In Group' reference list.
See Also:
UMLPackage.getActivityEdge_InGroup(), ActivityGroup.getContainedEdges()

getInPartitions

public EList getInPartitions()
Returns the value of the 'In Partition' reference list. The list contents are of type ActivityPartition. It is bidirectional and its opposite is 'Edge'. Partitions containing the edge.

Returns:
the value of the 'In Partition' reference list.
See Also:
UMLPackage.getActivityEdge_InPartition(), ActivityPartition.getEdges()

getInPartition

public ActivityPartition getInPartition(String name)
Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list.

Parameters:
name - The 'Name' of the ActivityPartition to retrieve, or null.
Returns:
The first ActivityPartition with the specified 'Name', or null.
See Also:
ActivityEdge.getInPartitions()

getInPartition

public ActivityPartition getInPartition(String name,
                                        boolean ignoreCase)
Retrieves the first ActivityPartition with the specified 'Name' from the 'In Partition' reference list.

Parameters:
name - The 'Name' of the ActivityPartition to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
Returns:
The first ActivityPartition with the specified 'Name', or null.
See Also:
ActivityEdge.getInPartitions()

getInStructuredNode

public StructuredActivityNode getInStructuredNode()
Returns the value of the 'In Structured Node' container reference. It is bidirectional and its opposite is 'Edge'. Structured activity node containing the edge.

Returns:
the value of the 'In Structured Node' container reference.
See Also:
ActivityEdge.setInStructuredNode(StructuredActivityNode), UMLPackage.getActivityEdge_InStructuredNode(), StructuredActivityNode.getEdges()

setInStructuredNode

public void setInStructuredNode(StructuredActivityNode value)
Sets the value of the 'In Structured Node' container reference.

Parameters:
value - the new value of the 'In Structured Node' container reference.
See Also:
ActivityEdge.getInStructuredNode()

getTarget

public ActivityNode getTarget()
Returns the value of the 'Target' reference. It is bidirectional and its opposite is 'Incoming'. Node to which tokens are put when they traverse the edge.

Returns:
the value of the 'Target' reference.
See Also:
ActivityEdge.setTarget(ActivityNode), UMLPackage.getActivityEdge_Target(), ActivityNode.getIncomings()

setTarget

public void setTarget(ActivityNode value)
Sets the value of the 'Target' reference.

Parameters:
value - the new value of the 'Target' reference.
See Also:
ActivityEdge.getTarget()

getRedefinedEdges

public EList getRedefinedEdges()
Returns the value of the 'Redefined Edge' reference list. The list contents are of type ActivityEdge. Inherited edges replaced by this edge in a specialization of the activity.

Returns:
the value of the 'Redefined Edge' reference list.
See Also:
UMLPackage.getActivityEdge_RedefinedEdge()

getRedefinedEdge

public ActivityEdge getRedefinedEdge(String name)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Redefined Edge' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityEdge.getRedefinedEdges()

getRedefinedEdge

public ActivityEdge getRedefinedEdge(String name,
                                     boolean ignoreCase,
                                     EClass eClass)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Redefined Edge' reference list.

Parameters:
name - The 'Name' of the ActivityEdge to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
eClass - The Ecore class of the ActivityEdge to retrieve, or null.
Returns:
The first ActivityEdge with the specified 'Name', or null.
See Also:
ActivityEdge.getRedefinedEdges()

getGuard

public ValueSpecification getGuard()
Returns the value of the 'Guard' containment reference. Specification evaluated at runtime to determine if the edge can be traversed.

Returns:
the value of the 'Guard' containment reference.
See Also:
ActivityEdge.setGuard(ValueSpecification), UMLPackage.getActivityEdge_Guard()

setGuard

public void setGuard(ValueSpecification value)
Sets the value of the 'Guard' containment reference.

Parameters:
value - the new value of the 'Guard' containment reference.
See Also:
ActivityEdge.getGuard()

createGuard

public ValueSpecification createGuard(String name,
                                      Type type,
                                      EClass eClass)
Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Guard' containment reference.

Parameters:
name - The 'Name' for the new ValueSpecification, or null.
type - The 'Type' for the new ValueSpecification, or null.
eClass - The Ecore class of the ValueSpecification to create.
Returns:
The new ValueSpecification.
See Also:
ActivityEdge.getGuard()

getWeight

public ValueSpecification getWeight()
Returns the value of the 'Weight' containment reference. Number of tokens consumed from the source node on each traversal.

Returns:
the value of the 'Weight' containment reference.
See Also:
ActivityEdge.setWeight(ValueSpecification), UMLPackage.getActivityEdge_Weight()

setWeight

public void setWeight(ValueSpecification value)
Sets the value of the 'Weight' containment reference.

Parameters:
value - the new value of the 'Weight' containment reference.
See Also:
ActivityEdge.getWeight()

createWeight

public ValueSpecification createWeight(String name,
                                       Type type,
                                       EClass eClass)
Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Weight' containment reference.

Parameters:
name - The 'Name' for the new ValueSpecification, or null.
type - The 'Type' for the new ValueSpecification, or null.
eClass - The Ecore class of the ValueSpecification to create.
Returns:
The new ValueSpecification.
See Also:
ActivityEdge.getWeight()

getInterrupts

public InterruptibleActivityRegion getInterrupts()
Returns the value of the 'Interrupts' reference. It is bidirectional and its opposite is 'Interrupting Edge'. Region that the edge can interrupt.

Returns:
the value of the 'Interrupts' reference.
See Also:
ActivityEdge.setInterrupts(InterruptibleActivityRegion), UMLPackage.getActivityEdge_Interrupts(), InterruptibleActivityRegion.getInterruptingEdges()

setInterrupts

public void setInterrupts(InterruptibleActivityRegion value)
Sets the value of the 'Interrupts' reference.

Parameters:
value - the new value of the 'Interrupts' reference.
See Also:
ActivityEdge.getInterrupts()

getSource

public ActivityNode getSource()
Returns the value of the 'Source' reference. It is bidirectional and its opposite is 'Outgoing'. Node from which tokens are taken when they traverse the edge.

Returns:
the value of the 'Source' reference.
See Also:
ActivityEdge.setSource(ActivityNode), UMLPackage.getActivityEdge_Source(), ActivityNode.getOutgoings()

setSource

public void setSource(ActivityNode value)
Sets the value of the 'Source' reference.

Parameters:
value - the new value of the 'Source' reference.
See Also:
ActivityEdge.getSource()

validateSourceAndTarget

public boolean validateSourceAndTarget(DiagnosticChain diagnostics,
                                       Map context)
The source and target of an edge must be in the same activity as the edge. true


validateOwned

public boolean validateOwned(DiagnosticChain diagnostics,
                             Map context)
Activity edges may be owned only by activities or groups. true


validateStructuredNode

public boolean validateStructuredNode(DiagnosticChain diagnostics,
                                      Map context)
Activity edges may be owned by at most one structured node. true


Copyright 2003, 2006 IBM Corporation and others.
All Rights Reserved.