org.eclipse.uml2.uml
Interface CombinedFragment

All Superinterfaces:
Element, EModelElement, EObject, InteractionFragment, NamedElement, Notifier
All Known Subinterfaces:
ConsiderIgnoreFragment

public interface CombinedFragment
extends InteractionFragment

A representation of the model object 'Combined Fragment'. A combined fragment defines an expression of interaction fragments. A combined fragment is defined by an interaction operator and corresponding interaction operands. Through the use of combined fragments the user will be able to describe a number of traces in a compact and concise manner.

The following features are supported:

See Also:
UMLPackage.getCombinedFragment()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 Gate createCfragmentGate(String name)
          Creates a new Gate, with the specified 'Name', and appends it to the 'Cfragment Gate' containment reference list
 InteractionOperand createOperand(String name)
          Creates a new InteractionOperand, with the specified 'Name', and appends it to the 'Operand' containment reference list
 Gate getCfragmentGate(String name)
          Retrieves the first Gate with the specified 'Name' from the 'Cfragment Gate' containment reference list
 Gate getCfragmentGate(String name, boolean ignoreCase, boolean createOnDemand)
          Retrieves the first Gate with the specified 'Name' from the 'Cfragment Gate' containment reference list
 EList getCfragmentGates()
          Returns the value of the 'Cfragment Gate' containment reference list.
 InteractionOperatorKind getInteractionOperator()
          Returns the value of the 'Interaction Operator' attribute.
 InteractionOperand getOperand(String name)
          Retrieves the first InteractionOperand with the specified 'Name' from the 'Operand' containment reference list
 InteractionOperand getOperand(String name, boolean ignoreCase, boolean createOnDemand)
          Retrieves the first InteractionOperand with the specified 'Name' from the 'Operand' containment reference list
 EList getOperands()
          Returns the value of the 'Operand' containment reference list.
 void setInteractionOperator(InteractionOperatorKind value)
          Sets the value of the 'Interaction Operator' attribute
 boolean validateBreak(DiagnosticChain diagnostics, Map context)
           If the interactionOperator is break, the corresponding InteractionOperand must cover all Lifelines within the enclosing InteractionFragment.
 boolean validateConsiderAndIgnore(DiagnosticChain diagnostics, Map context)
           The interaction operators 'consider' and 'ignore' can only be used for the CombineIgnoreFragment subtype of CombinedFragment ((interactionOperator = #consider) or (interactionOperator = #ignore)) implies oclsisTypeOf(CombineIgnoreFragment)
 boolean validateMinintAndMaxint(DiagnosticChain diagnostics, Map context)
           The InteractionConstraint with minint and maxint only apply when attached to an InteractionOperand where the interactionOperator is loop.
 boolean validateOptLoopBreakNeg(DiagnosticChain diagnostics, Map context)
           If the interactionOperator is opt, loop, break, or neg there must be exactly one operand true
 
Methods inherited from interface org.eclipse.uml2.uml.InteractionFragment
createGeneralOrdering, getCovered, getCovered, getCovereds, getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering, getGeneralOrdering, getGeneralOrderings, setEnclosingInteraction, setEnclosingOperand
 
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

getInteractionOperator

public InteractionOperatorKind getInteractionOperator()
Returns the value of the 'Interaction Operator' attribute. The default value is "seq". The literals are from the enumeration InteractionOperatorKind. Specifies the operation which defines the semantics of this combination of InteractionFragments.

Returns:
the value of the 'Interaction Operator' attribute.
See Also:
InteractionOperatorKind, CombinedFragment.setInteractionOperator(InteractionOperatorKind), UMLPackage.getCombinedFragment_InteractionOperator()

setInteractionOperator

public void setInteractionOperator(InteractionOperatorKind value)
Sets the value of the 'Interaction Operator' attribute.

Parameters:
value - the new value of the 'Interaction Operator' attribute.
See Also:
InteractionOperatorKind, CombinedFragment.getInteractionOperator()

getOperands

public EList getOperands()
Returns the value of the 'Operand' containment reference list. The list contents are of type InteractionOperand. The set of operands of the combined fragment.

Returns:
the value of the 'Operand' containment reference list.
See Also:
UMLPackage.getCombinedFragment_Operand()

createOperand

public InteractionOperand createOperand(String name)
Creates a new InteractionOperand, with the specified 'Name', and appends it to the 'Operand' containment reference list.

Parameters:
name - The 'Name' for the new InteractionOperand, or null.
Returns:
The new InteractionOperand.
See Also:
CombinedFragment.getOperands()

getOperand

public InteractionOperand getOperand(String name)
Retrieves the first InteractionOperand with the specified 'Name' from the 'Operand' containment reference list.

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

getOperand

public InteractionOperand getOperand(String name,
                                     boolean ignoreCase,
                                     boolean createOnDemand)
Retrieves the first InteractionOperand with the specified 'Name' from the 'Operand' containment reference list.

Parameters:
name - The 'Name' of the InteractionOperand to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
createOnDemand - Whether to create a InteractionOperand on demand if not found.
Returns:
The first InteractionOperand with the specified 'Name', or null.
See Also:
CombinedFragment.getOperands()

getCfragmentGates

public EList getCfragmentGates()
Returns the value of the 'Cfragment Gate' containment reference list. The list contents are of type Gate. Specifies the gates that form the interface between this CombinedFragment and its surroundings

Returns:
the value of the 'Cfragment Gate' containment reference list.
See Also:
UMLPackage.getCombinedFragment_CfragmentGate()

createCfragmentGate

public Gate createCfragmentGate(String name)
Creates a new Gate, with the specified 'Name', and appends it to the 'Cfragment Gate' containment reference list.

Parameters:
name - The 'Name' for the new Gate, or null.
Returns:
The new Gate.
See Also:
CombinedFragment.getCfragmentGates()

getCfragmentGate

public Gate getCfragmentGate(String name)
Retrieves the first Gate with the specified 'Name' from the 'Cfragment Gate' containment reference list.

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

getCfragmentGate

public Gate getCfragmentGate(String name,
                             boolean ignoreCase,
                             boolean createOnDemand)
Retrieves the first Gate with the specified 'Name' from the 'Cfragment Gate' containment reference list.

Parameters:
name - The 'Name' of the Gate to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
createOnDemand - Whether to create a Gate on demand if not found.
Returns:
The first Gate with the specified 'Name', or null.
See Also:
CombinedFragment.getCfragmentGates()

validateOptLoopBreakNeg

public boolean validateOptLoopBreakNeg(DiagnosticChain diagnostics,
                                       Map context)
If the interactionOperator is opt, loop, break, or neg there must be exactly one operand true


validateMinintAndMaxint

public boolean validateMinintAndMaxint(DiagnosticChain diagnostics,
                                       Map context)
The InteractionConstraint with minint and maxint only apply when attached to an InteractionOperand where the interactionOperator is loop. true


validateBreak

public boolean validateBreak(DiagnosticChain diagnostics,
                             Map context)
If the interactionOperator is break, the corresponding InteractionOperand must cover all Lifelines within the enclosing InteractionFragment. true


validateConsiderAndIgnore

public boolean validateConsiderAndIgnore(DiagnosticChain diagnostics,
                                         Map context)
The interaction operators 'consider' and 'ignore' can only be used for the CombineIgnoreFragment subtype of CombinedFragment ((interactionOperator = #consider) or (interactionOperator = #ignore)) implies oclsisTypeOf(CombineIgnoreFragment)


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