org.eclipse.uml2.uml
Interface ActivityGroup

All Superinterfaces:
ActivityContent, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, NamedElement, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
ActivityPartition, ConditionalNode, ExpansionRegion, InterruptibleActivityRegion, LoopNode, SequenceNode, StructuredActivityNode

public interface ActivityGroup
extends NamedElement, ActivityContent

A representation of the model object 'Activity Group'. ActivityGroup is an abstract class for defining sets of ActivityNodes and ActivityEdges in an Activity.

From package UML::Activities.

The following features are supported:

See Also:
UMLPackage.getActivityGroup()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 ActivityEdge getContainedEdge(java.lang.String name)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Contained Edge' reference list
 ActivityEdge getContainedEdge(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)
          Retrieves the first ActivityEdge with the specified 'Name' from the 'Contained Edge' reference list
 org.eclipse.emf.common.util.EList<ActivityEdge> getContainedEdges()
          Returns the value of the 'Contained Edge' reference list.
 ActivityNode getContainedNode(java.lang.String name)
          Retrieves the first ActivityNode with the specified 'Name' from the 'Contained Node' reference list
 ActivityNode getContainedNode(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)
          Retrieves the first ActivityNode with the specified 'Name' from the 'Contained Node' reference list
 org.eclipse.emf.common.util.EList<ActivityNode> getContainedNodes()
          Returns the value of the 'Contained Node' reference list.
 Activity getInActivity()
          Returns the value of the 'In Activity' reference.
 ActivityGroup getSubgroup(java.lang.String name)
          Retrieves the first ActivityGroup with the specified 'Name' from the 'Subgroup' reference list
 ActivityGroup getSubgroup(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)
          Retrieves the first ActivityGroup with the specified 'Name' from the 'Subgroup' reference list
 org.eclipse.emf.common.util.EList<ActivityGroup> getSubgroups()
          Returns the value of the 'Subgroup' reference list.
 ActivityGroup getSuperGroup()
          Returns the value of the 'Super Group' reference.
 void setInActivity(Activity value)
          Sets the value of the 'In Activity' reference
 boolean validateNodesAndEdges(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
          All containedNodes and containeEdges of an ActivityGroup must be in the same Activity as the group.
 boolean validateNotContained(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
          No containedNode or containedEdge of an ActivityGroup may be contained by its subgroups or its superGroups, transitively.
 
Methods inherited from interface org.eclipse.uml2.uml.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, 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, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.uml2.uml.ActivityContent
containingActivity
 

Method Detail

getSubgroups

org.eclipse.emf.common.util.EList<ActivityGroup> getSubgroups()
Returns the value of the 'Subgroup' reference list. The list contents are of type ActivityGroup. It is bidirectional and its opposite is 'Super Group'.

This feature subsets the following features:

This feature is a derived union. Other ActivityGroups immediately contained in this ActivityGroup.

From package UML::Activities.

Returns:
the value of the 'Subgroup' reference list.
See Also:
UMLPackage.getActivityGroup_Subgroup(), getSuperGroup()

getSubgroup

ActivityGroup getSubgroup(java.lang.String name)
Retrieves the first ActivityGroup with the specified 'Name' from the 'Subgroup' reference list.

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

getSubgroup

ActivityGroup getSubgroup(java.lang.String name,
                          boolean ignoreCase,
                          org.eclipse.emf.ecore.EClass eClass)
Retrieves the first ActivityGroup with the specified 'Name' from the 'Subgroup' reference list.

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

getSuperGroup

ActivityGroup getSuperGroup()
Returns the value of the 'Super Group' reference. It is bidirectional and its opposite is 'Subgroup'.

This feature subsets the following features:

This feature is a derived union. The ActivityGroup immediately containing this ActivityGroup, if it is directly owned by another ActivityGroup.

From package UML::Activities.

Returns:
the value of the 'Super Group' reference.
See Also:
UMLPackage.getActivityGroup_SuperGroup(), getSubgroups()

getContainedNodes

org.eclipse.emf.common.util.EList<ActivityNode> getContainedNodes()
Returns the value of the 'Contained Node' reference list. The list contents are of type ActivityNode. It is bidirectional and its opposite is 'In Group'. This feature is a derived union. ActivityNodes immediately contained in the ActivityGroup.

From package UML::Activities.

Returns:
the value of the 'Contained Node' reference list.
See Also:
UMLPackage.getActivityGroup_ContainedNode(), ActivityNode.getInGroups()

getContainedNode

ActivityNode getContainedNode(java.lang.String name)
Retrieves the first ActivityNode with the specified 'Name' from the 'Contained Node' reference list.

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

getContainedNode

ActivityNode getContainedNode(java.lang.String name,
                              boolean ignoreCase,
                              org.eclipse.emf.ecore.EClass eClass)
Retrieves the first ActivityNode with the specified 'Name' from the 'Contained Node' reference list.

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

getInActivity

Activity getInActivity()
Returns the value of the 'In Activity' reference. It is bidirectional and its opposite is 'Group'.

This feature subsets the following features:

The Activity containing the ActivityGroup, if it is directly owned by an Activity.

From package UML::Activities.

Returns:
the value of the 'In Activity' reference.
See Also:
setInActivity(Activity), UMLPackage.getActivityGroup_InActivity(), Activity.getGroups()

setInActivity

void setInActivity(Activity value)
Sets the value of the 'In Activity' reference.

Parameters:
value - the new value of the 'In Activity' reference.
See Also:
getInActivity()

getContainedEdges

org.eclipse.emf.common.util.EList<ActivityEdge> getContainedEdges()
Returns the value of the 'Contained Edge' reference list. The list contents are of type ActivityEdge. It is bidirectional and its opposite is 'In Group'. This feature is a derived union. ActivityEdges immediately contained in the ActivityGroup.

From package UML::Activities.

Returns:
the value of the 'Contained Edge' reference list.
See Also:
UMLPackage.getActivityGroup_ContainedEdge(), ActivityEdge.getInGroups()

getContainedEdge

ActivityEdge getContainedEdge(java.lang.String name)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Contained 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:
getContainedEdges()

getContainedEdge

ActivityEdge getContainedEdge(java.lang.String name,
                              boolean ignoreCase,
                              org.eclipse.emf.ecore.EClass eClass)
Retrieves the first ActivityEdge with the specified 'Name' from the 'Contained 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:
getContainedEdges()

validateNodesAndEdges

boolean validateNodesAndEdges(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                              java.util.Map<java.lang.Object,java.lang.Object> context)
All containedNodes and containeEdges of an ActivityGroup must be in the same Activity as the group. containedNode->forAll(activity = self.containingActivity()) and containedEdge->forAll(activity = self.containingActivity())

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

validateNotContained

boolean validateNotContained(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                             java.util.Map<java.lang.Object,java.lang.Object> context)
No containedNode or containedEdge of an ActivityGroup may be contained by its subgroups or its superGroups, transitively. subgroup->closure(subgroup).containedNode->excludesAll(containedNode) and superGroup->closure(superGroup).containedNode->excludesAll(containedNode) and subgroup->closure(subgroup).containedEdge->excludesAll(containedEdge) and superGroup->closure(superGroup).containedEdge->excludesAll(containedEdge)

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

Copyright 2003, 2014 IBM Corporation, CEA, and others.
All Rights Reserved.