org.argouml.model
Interface Facade

public interface Facade

Facade object for the Model subsystem in ArgoUML.

The purpose of this Facade object is to allow for decoupling other subsystems from the insides of the model. For this purpose all of the methods in this class give away and accept handles (of type Object) to the objects within the model.

This is just recognizers and getters.

To manipulate the objects of the model there is a set of factories and helpers within the Model subsystem.

Signatures for all recognizers are:

• public boolean isATYPE(Object handle)
• public boolean isPROPERTY(Object handle)
• public boolean hasPROPERTY(Object handle)

• public Object getROLENAME(Object handle) - 1..1
• public Iterator/Collection getROLENAMEs(Object handle) - 0..*
• public String getName(Object handle) - Name

GENERATED_TAG

static final java.lang.String GENERATED_TAG

This tag is set on elements that are generated by reference when importing. If it is set, then the critics could ignore those objects if they want. TODO: This is really belongs in a higher level utility class that uses the Facade's tagged value methods. Also, it needs to be updated to use a UML 1.4 TagDefinition instead of a simple String.

See Also:

Constant Field Values

DERIVED_TAG

static final java.lang.String DERIVED_TAG

Tag which indicates a ModelElement is derived. From UML Standard Elements profile.

See Also:

Constant Field Values

getUmlVersion

java.lang.String getUmlVersion()

Return the version of the UML metamodel supported by the underlying implementation. The version string is made up of numerical components separated by the '.' character with the most significant digits on the left.

The MDR implementation supports UML 1.4 and the initial eUML implementation supports UML 2.1.1. The earlier NSUML implementation supported UML 1.3.

Returns:

a period ('.') separated string of version numbers. e.g. "1.4" or "2.1.1"

isAAbstraction

boolean isAAbstraction(java.lang.Object handle)

Recognizer for Abstraction.

Parameters:

handle - candidate

Returns:

true if handle is an Abstraction.

isAAction

boolean isAAction(java.lang.Object handle)

Recognizer for Action.

Parameters:

handle - candidate

Returns:

true if handle is an Action

isAAcceptEventAction

boolean isAAcceptEventAction(java.lang.Object handle)

Recognizer for a UML2 AcceptEventAction.

Parameters:

handle - candidate

Returns:

true if handle is an AcceptEventAction

isAActionSequence

boolean isAActionSequence(java.lang.Object handle)

Recognizer for ActionSequence.

Parameters:

handle - candidate

Returns:

true if handle is an action sequence

isAActionState

boolean isAActionState(java.lang.Object handle)

Recognizer for ActionState.

Parameters:

handle - candidate

Returns:

true if handle is an ActionState

isACallState

boolean isACallState(java.lang.Object handle)

Recognizer for CallState.

Parameters:

handle - candidate

Returns:

true if handle is an call state

isAObjectFlowState

boolean isAObjectFlowState(java.lang.Object handle)

Recognizer for ObjectFlowState.

Parameters:

handle - candidate

Returns:

true if handle is an objectflow state

isAObjectNode

boolean isAObjectNode(java.lang.Object handle)

Recognizer for ObjectNode.

Parameters:

handle - candidate

Returns:

true if handle is an ObjectNode

isASubactivityState

boolean isASubactivityState(java.lang.Object handle)

Recognizer for SubactivityState.

Parameters:

handle - candidate

Returns:

true if handle is an subactivity state

isAActor

boolean isAActor(java.lang.Object handle)

Recognizer for Actor.

Parameters:

handle - candidate

Returns:

true if handle is an Actor

isAAggregationKind

boolean isAAggregationKind(java.lang.Object handle)

Recognizer for AggregationKind.

Parameters:

handle - candidate

Returns:

true if handle is an AggregationKind

isAAppliedProfileElement

boolean isAAppliedProfileElement(java.lang.Object handle)

Recognizer for an applied profile element. UML2 only.

Parameters:

handle - candidate

Returns:

true if handle is an applied profile element

isAArtifact

boolean isAArtifact(java.lang.Object handle)

Recognizer for Artifact.

Parameters:

handle - candidate

Returns:

true if handle is an Artifact

isAAssociation

boolean isAAssociation(java.lang.Object handle)

Recognizer for Association.

Parameters:

handle - candidate

Returns:

true if handle is an Association

isAAssociationEnd

boolean isAAssociationEnd(java.lang.Object handle)

Recognizer for AssociationEnd.

Parameters:

handle - candidate

Returns:

true if handle is an AssociationEnd

isAAssociationRole

boolean isAAssociationRole(java.lang.Object handle)

Recognizer for AssociationRole.

Parameters:

handle - candidate

Returns:

true if handle is an AssociationRole

isAAssociationEndRole

boolean isAAssociationEndRole(java.lang.Object handle)

Recognizer for AssociationEndRole.

Parameters:

handle - candidate

Returns:

true if handle is an AssociationEndRole

isAAttribute

boolean isAAttribute(java.lang.Object handle)

Recognizer for Attribute.

Parameters:

handle - candidate

Returns:

true if handle is an Attribute

isAAttributeLink

boolean isAAttributeLink(java.lang.Object handle)

Recognizer for AttributeLink.

Parameters:

handle - candidate

Returns:

true if handle is an AttributeLink

isAsynchronous

boolean isAsynchronous(java.lang.Object handle)

Recognizer for asynchronisity of an action.

Parameters:

handle - candidate

Returns:

true if the argument is asynchronous

isAbstract

boolean isAbstract(java.lang.Object handle)

Recognizer for abstract classes and operations. True if it has an isAbstract attribute with a value of true. If there's no such attribute (ie it isn't a type which has that attribute in the UML metamodel), it will return false without throwing an error.

Parameters:

handle - candidate

Returns:

true if handle is abstract.

isAActivityEdge

boolean isAActivityEdge(java.lang.Object handle)

Recognizer for UML2 ActivityEdge.

Parameters:

handle - candidate

Returns:

true if handle is ActivityEdge.

isAActivityGraph

boolean isAActivityGraph(java.lang.Object handle)

Recognizer for UML1.4 ActivityGraph.

Parameters:

handle - candidate

Returns:

true if handle is ActivityGraph.

isAActivityNode

boolean isAActivityNode(java.lang.Object handle)

Recognizer for UML2 ActivityNode.

Parameters:

handle - candidate

Returns:

true if handle is ActivityNode.

isABehavioralFeature

boolean isABehavioralFeature(java.lang.Object handle)

Recognizer for BehavioralFeature.

Parameters:

handle - candidate

Returns:

true if handle is a behavioral feature

isABinding

boolean isABinding(java.lang.Object handle)

Recognizer for Binding.

Parameters:

handle - candidate

Returns:

true if handle is a Binding

isACallAction

boolean isACallAction(java.lang.Object handle)

Recognizer for CallAction.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isAASynchCallMessage

boolean isAASynchCallMessage(java.lang.Object handle)

Recognizer for Message or sort ASynchCall.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isAASynchSignalMessage

boolean isAASynchSignalMessage(java.lang.Object handle)

Recognizer for Message or sort ASynchSignal.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isADeleteMessage

boolean isADeleteMessage(java.lang.Object handle)

Recognizer for Message or sort Delete.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isACreateMessage

boolean isACreateMessage(java.lang.Object handle)

Recognizer for Message or sort Create

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isASynchCallMessage

boolean isASynchCallMessage(java.lang.Object handle)

Recognizer for Message or sort SynchCall.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isAReplyMessage

boolean isAReplyMessage(java.lang.Object handle)

Recognizer for Message or sort Reply.

Parameters:

handle - candidate

Returns:

true if handle is a CallAction

isACallEvent

boolean isACallEvent(java.lang.Object handle)

Recognizer for CallEvent.

Parameters:

handle - candidate

Returns:

true if handle is a CallEvent

isAChangeEvent

boolean isAChangeEvent(java.lang.Object handle)

Recognizer for ChangeEvent.

Parameters:

handle - candidate

Returns:

true if handle is a ChangeEvent

isAClass

boolean isAClass(java.lang.Object handle)

Recognizer for UML Class.

Parameters:

handle - candidate

Returns:

true if handle is a UML Class

isAAssociationClass

boolean isAAssociationClass(java.lang.Object handle)

Recognizer for AssociationClass.

Parameters:

handle - candidate

Returns:

true if handle is an AssociationClass

isAClassifier

boolean isAClassifier(java.lang.Object handle)

Recognizer for Classifier.

Parameters:

handle - candidate

Returns:

true if handle is a Classifier

isAClassifierInState

boolean isAClassifierInState(java.lang.Object handle)

Recognizer for ClassifierInState.

Parameters:

handle - candidate

Returns:

true if handle is a ClassifierInState

isAClassifierRole

boolean isAClassifierRole(java.lang.Object handle)

Recognizer for ClassifierRole.

Parameters:

handle - candidate

Returns:

true if handle is a ClassifierRole

isAComment

boolean isAComment(java.lang.Object handle)

Recognizer for Comment.

Parameters:

handle - candidate

Returns:

true if handle is a Comment

isACollaboration

boolean isACollaboration(java.lang.Object handle)

Recognizer for Collaboration.

Parameters:

handle - candidate

Returns:

true if handle is a Collaboration

isACollaborationInstanceSet

boolean isACollaborationInstanceSet(java.lang.Object handle)

Recognizer for CollaborationInstanceSet.

Parameters:

handle - candidate

Returns:

true if handle is a CollaborationInstanceSet

isAComponent

boolean isAComponent(java.lang.Object handle)

Recognizer for Component.

Parameters:

handle - candidate

Returns:

true if handle is a Component

isAComponentInstance

boolean isAComponentInstance(java.lang.Object handle)

Recognizer for ComponentInstance.

Parameters:

handle - candidate

Returns:

true if handle is a ComponentInstance

isAConstraint

boolean isAConstraint(java.lang.Object handle)

Recognizer for Constraint.

Parameters:

handle - candidate

Returns:

true if handle is a Constraint

isACreateAction

boolean isACreateAction(java.lang.Object handle)

Recognizer for CreateAction.

Parameters:

handle - candidate

Returns:

true if handle is a CreateAction

isADataType

boolean isADataType(java.lang.Object handle)

Recognizer for DataType.

Parameters:

handle - candidate

Returns:

true if handle is a DataType

isADataValue

boolean isADataValue(java.lang.Object handle)

Recognizer for DataValue.

Parameters:

handle - candidate

Returns:

true if handle is a DataValue

isADependency

boolean isADependency(java.lang.Object handle)

Recognizer for Dependency.

Parameters:

handle - candidate

Returns:

true if handle is a Dependency

isADirectedRelationship

boolean isADirectedRelationship(java.lang.Object handle)

Parameters:

handle - element to test

Returns:

true if Element is a DirectedRelationship

isADestroyAction

boolean isADestroyAction(java.lang.Object handle)

Recognizer for DestroyAction.

Parameters:

handle - candidate

Returns:

true if handle is a DestroyAction

isACompositeState

boolean isACompositeState(java.lang.Object handle)

Recognizer for CompositeState.

Parameters:

handle - candidate

Returns:

true if handle is a CompositeState

isAElement

boolean isAElement(java.lang.Object handle)

Recognizer for Element.

NOTE: In the UML 1.4 specification there are a number of types that one might expect to be subtypes of Element, but which are not. The spec isn't clear on whether this is intentional or not but if you want all types in the spec, including things which are not subtypes of Element such as Expression, Multiplicity, MultiplicityRange TemplateArgument, TemplateParameter, ElementResidence, ElementImport use the method isAUMLElement(Object).

Parameters:

handle - candidate

Returns:

true if handle is an Element

See Also:

isAUMLElement(Object)

isAElementImport

boolean isAElementImport(java.lang.Object handle)

Recognizer for ElementImport.

Parameters:

handle - candidate

Returns:

true if handle is an ElementImport

isAElementResidence

boolean isAElementResidence(java.lang.Object handle)

Recognizer for ElementResidence.

Parameters:

handle - candidate

Returns:

true if handle is an ElementResidence

isAEnumeration

boolean isAEnumeration(java.lang.Object handle)

Recognizer for UML Enumeration.

Parameters:

handle - candidate

Returns:

true if handle is an UML Enumeration

isAEnumerationLiteral

boolean isAEnumerationLiteral(java.lang.Object handle)

Recognizer for UML EnumerationLiteral

Parameters:

handle - the candidate

Returns:

true if handle is an UML EnumerationLiteral

isAEvent

boolean isAEvent(java.lang.Object handle)

Recognizer for Event.

Parameters:

handle - candidate

Returns:

true if handle is an Event

isAException

boolean isAException(java.lang.Object handle)

Recognizer for UML Exception.

Parameters:

handle - candidate

Returns:

true if handle is a UML Exception

isAExpression

boolean isAExpression(java.lang.Object handle)

Recognizer for Expression.

Parameters:

handle - candidate

Returns:

true if handle is an Expression

isAExtend

boolean isAExtend(java.lang.Object handle)

Recognizer for Extend.

Parameters:

handle - candidate

Returns:

true if handle is an Extend

isAExtension

boolean isAExtension(java.lang.Object handle)

Recognizer for Extension. For UML2 only.

Parameters:

handle - candidate

Returns:

true if handle is an ExtensionPoint

isAExtensionPoint

boolean isAExtensionPoint(java.lang.Object handle)

Recognizer for ExtensionPoint.

Parameters:

handle - candidate

Returns:

true if handle is an ExtensionPoint

isAFeature

boolean isAFeature(java.lang.Object handle)

Recognizer for Feature.

Parameters:

handle - candidate

Returns:

true if handle is a Feature

isAFinalState

boolean isAFinalState(java.lang.Object handle)

Recognizer for FinalState.

Parameters:

handle - candidate

Returns:

true if handle is a FinalState

isAFlow

boolean isAFlow(java.lang.Object handle)

Recognizer for Flow.

Parameters:

handle - candidate

Returns:

true if handle is a Flow

isAGuard

boolean isAGuard(java.lang.Object handle)

Recognizer for Guard.

Parameters:

handle - candidate

Returns:

true if handle is a Guard

isAGeneralizableElement

boolean isAGeneralizableElement(java.lang.Object handle)

Recognizer for GeneralizableElement.

Parameters:

handle - candidate

Returns:

true if handle is a GeneralizableElement

isAGeneralization

boolean isAGeneralization(java.lang.Object handle)

Recognizer for Generalization.

Parameters:

handle - candidate

Returns:

true if handle is a Generalization

isAInclude

boolean isAInclude(java.lang.Object handle)

Recognizer for Include.

Parameters:

handle - candidate

Returns:

true if handle is an Include

isAInstance

boolean isAInstance(java.lang.Object handle)

Recognizer for Instance.

Parameters:

handle - candidate

Returns:

true if handle is a Instance

isAInteraction

boolean isAInteraction(java.lang.Object handle)

Recognizer for Interaction.

Parameters:

handle - candidate

Returns:

true if handle is a Interaction

isAInteractionInstanceSet

boolean isAInteractionInstanceSet(java.lang.Object handle)

Recognizer for InteractionInstanceSet.

Parameters:

handle - candidate

Returns:

true if handle is a InteractionInstanceSet

isAInterface

boolean isAInterface(java.lang.Object handle)

Recognizer for Interface.

Parameters:

handle - candidate

Returns:

true if handle is a Interface

isALifeline

boolean isALifeline(java.lang.Object handle)

Recognizer for Lifeline.

Parameters:

handle - candidate

Returns:

true if handle is a Lifeline

isALink

boolean isALink(java.lang.Object handle)

Recognizer for Link.

Parameters:

handle - candidate

Returns:

true if handle is a Link

isALinkEnd

boolean isALinkEnd(java.lang.Object handle)

Recognizer for LinkEnd.

Parameters:

handle - candidate

Returns:

true if handle is a LinkEnd

isALinkObject

boolean isALinkObject(java.lang.Object handle)

Recognizer for LinkObject.

Parameters:

handle - candidate

Returns:

true if handle is a LinkObject

isAMessage

boolean isAMessage(java.lang.Object handle)

Recognizer for Message.

Parameters:

handle - candidate

Returns:

true if handle is a Method

isAMethod

boolean isAMethod(java.lang.Object handle)

Recognizer for Method.

Parameters:

handle - candidate

Returns:

true if handle is a Method

isAModel

boolean isAModel(java.lang.Object handle)

Recognizer for Model.

Parameters:

handle - candidate

Returns:

true if handle is a Model

isAModelElement

boolean isAModelElement(java.lang.Object handle)

Recognizer for ModelElement. NOTE: Consider using isAUMLElement(Object) instead since it is more likely to do what you want. This is strictly for subtypes of ModelElement which excludes many UML types such as Multiplicities, TemplateParameters, etc. It also will fail to work for UML 2 types which are subtypes of Element, but not ModelElement.

Parameters:

handle - candidate

Returns:

true if handle is a ModelElement

isANamedElement

boolean isANamedElement(java.lang.Object handle)

Recognizer for a UML element which can have a name. In UML 1.x, this is just a ModelElement, but in UML 2.x it's a separate metatype. Use this method if you're principally interested in whether something can be named.

Parameters:

handle - candidate

Returns:

true if handle is a ModelElement

isAMultiplicity

boolean isAMultiplicity(java.lang.Object handle)

Recognizer for Multiplicity.

Parameters:

handle - candidate

Returns:

true if handle is a Multiplicity

isAMultiplicityRange

boolean isAMultiplicityRange(java.lang.Object handle)

Recognizer for MultiplicityRange.

Parameters:

handle - candidate

Returns:

true if handle is a MultiplicityRange

isANamespace

boolean isANamespace(java.lang.Object handle)

Recognizer for Namespace.

Parameters:

handle - candidate

Returns:

true if handle is a Namespace

isANaryAssociation

boolean isANaryAssociation(java.lang.Object handle)

Recognizer for N-ary Association. TODO: This is not a recognizer for some type. Rename to isNaryAssociation?

Parameters:

handle - candidate

Returns:

true if handle is an Association

isANode

boolean isANode(java.lang.Object handle)

Recognizer for a Node.

Parameters:

handle - candidate

Returns:

true if handle is a Node

isANodeInstance

boolean isANodeInstance(java.lang.Object handle)

Recognizer for a NodeInstance.

Parameters:

handle - candidate

Returns:

true if handle is a NodeInstance

isAOperation

boolean isAOperation(java.lang.Object handle)

Recognizer for Operation.

Parameters:

handle - candidate

Returns:

true if handle is an Operation

isAObject

boolean isAObject(java.lang.Object handle)

Recognizer for Object.

Parameters:

handle - candidate

Returns:

true if handle is an Object

isAParameter

boolean isAParameter(java.lang.Object handle)

Recognizer for Parameter.

Parameters:

handle - candidate

Returns:

true if handle is a Parameter

isAPartition

boolean isAPartition(java.lang.Object handle)

Recognizer for Partition.

Parameters:

handle - candidate

Returns:

true if handle is a Partition

isAPackageImport

boolean isAPackageImport(java.lang.Object handle)

Recognizer for PackageImport (was Permission in UML 1.x).

Parameters:

handle - candidate

Returns:

true if handle is an PackageImport (or Permission in UML 1.4)

Since:

UML 2.0

isAPackage

boolean isAPackage(java.lang.Object handle)

Recognizer for Package.

Parameters:

handle - candidate

Returns:

true if handle is a Package

isAPrimitiveType

boolean isAPrimitiveType(java.lang.Object handle)

Recognizer for PrimitiveType.

Parameters:

handle - candidate

Returns:

true if handle is a Primitive

isAProfile

boolean isAProfile(java.lang.Object handle)

Recognizer for Profile. In UML 2, this is no longer a model, but a separate meta package instance. In UML 1.4, ArgoUML assumes it to be a model instance with a <> stereotype.

Parameters:

handle - candidate

Returns:

true if handle is a Profile

isAProfileApplication

boolean isAProfileApplication(java.lang.Object handle)

Recognizer for ProfileApplication. In UML 2 only.

Parameters:

handle - candidate

Returns:

true if handle is a ProfileApplication

isAProperty

boolean isAProperty(java.lang.Object handle)

Recognizer for Property. UML 2 only.

Parameters:

handle - candidate

Returns:

true if handle is a Property

isAPseudostate

boolean isAPseudostate(java.lang.Object handle)

Recognizer for Pseudostate.

Parameters:

handle - candidate

Returns:

true if handle is a Pseudostate

isAPseudostateKind

boolean isAPseudostateKind(java.lang.Object handle)

Recognizer for PseudostateKind.

Parameters:

handle - candidate

Returns:

true if handle is a PseudostateKind

getKind

java.lang.Object getKind(java.lang.Object handle)

Return the Kind of a Pseudostate or Parameter.

Parameters:

handle - the Pseudostate or Parameter

Returns:

the Kind

getReceiver

java.lang.Object getReceiver(java.lang.Object handle)

Return the receiver Instance for a Stimulus or the receiver ClassifierRole for a Message.

Parameters:

handle - candidate

Returns:

Instance or ClassifierRole

getLink

java.lang.Object getLink(java.lang.Object handle)

Return the Link belonging to the given LinkEnd.

Parameters:

handle - the LinkEnd

Returns:

the Link

equalsPseudostateKind

boolean equalsPseudostateKind(java.lang.Object ps1,
                              java.lang.Object ps2)

Check whether two pseudostatekinds are equal/of the same type.

Parameters:

ps1 - one kind

ps2 - one kind

Returns:

true if the are the same type

isAReception

boolean isAReception(java.lang.Object handle)

Recognizer for Reception.

Parameters:

handle - candidate

Returns:

true if handle is a Reception

isAReturnAction

boolean isAReturnAction(java.lang.Object handle)

Recognizer for ReturnAction.

Parameters:

handle - candidate

Returns:

true if handle is a ReturnAction

isARelationship

boolean isARelationship(java.lang.Object handle)

Recognizer for Relationship.

Parameters:

handle - candidate

Returns:

true if handle is a Relationship

isASendAction

boolean isASendAction(java.lang.Object handle)

Recognizer for SendAction.

Parameters:

handle - candidate

Returns:

true if handle is a SendAction

isASendSignalAction

boolean isASendSignalAction(java.lang.Object handle)

Recognizer for UML2 SendSignalAction.

Parameters:

handle - candidate

Returns:

true if handle is a SendSignalAction

isASignal

boolean isASignal(java.lang.Object handle)

Recognizer for Signal.

Parameters:

handle - candidate

Returns:

true if handle is a Signal

isASignalEvent

boolean isASignalEvent(java.lang.Object handle)

Recognizer for SignalEvent.

Parameters:

handle - candidate

Returns:

true if handle is a SignalEvent

isASimpleState

boolean isASimpleState(java.lang.Object handle)

Recognizer for SimpleState.

Parameters:

handle - candidate

Returns:

true if handle is a StateMachine

isAStateMachine

boolean isAStateMachine(java.lang.Object handle)

Recognizer for StateMachine.

Parameters:

handle - candidate

Returns:

true if handle is a StateMachine

isAStimulus

boolean isAStimulus(java.lang.Object handle)

Recognizer for Stimulus.

Parameters:

handle - candidate

Returns:

true if handle is a Stimulus

isAStateVertex

boolean isAStateVertex(java.lang.Object handle)

Recognizer for StateVertex.

Parameters:

handle - candidate

Returns:

true if handle is a StateVertex

isAStereotype

boolean isAStereotype(java.lang.Object handle)

Recognizer for Stereotype.

Parameters:

handle - candidate

Returns:

true if handle is a Stereotype

isAStructuralFeature

boolean isAStructuralFeature(java.lang.Object handle)

Recognizer for StructuralFeature.

Parameters:

handle - candidate

Returns:

true if handle is a StructuralFeature

isAState

boolean isAState(java.lang.Object handle)

Recognizer for State.

Parameters:

handle - candidate

Returns:

true if handle is a State

isAStubState

boolean isAStubState(java.lang.Object handle)

Recognizer for StubState.

Parameters:

handle - candidate

Returns:

true if handle is a StubState

isASubmachineState

boolean isASubmachineState(java.lang.Object handle)

Recognizer for SubmachineState.

Parameters:

handle - candidate

Returns:

true if handle is a SubmachineState

isASubsystem

boolean isASubsystem(java.lang.Object handle)

Recognizer for Subsystem.

Parameters:

handle - candidate

Returns:

true if handle is a Subsystem

isASubsystemInstance

boolean isASubsystemInstance(java.lang.Object handle)

Recognizer for SubsystemInstance.

Parameters:

handle - candidate

Returns:

true if handle is a SubsystemInstance

isASynchState

boolean isASynchState(java.lang.Object handle)

Recognizer for SynchState.

Parameters:

handle - candidate

Returns:

true if handle is a SynchState

isATaggedValue

boolean isATaggedValue(java.lang.Object handle)

Recognizer for TaggedValue.

Parameters:

handle - candidate

Returns:

true if handle is a TaggedValue

isATemplateArgument

boolean isATemplateArgument(java.lang.Object handle)

Recognizer for TemplateArgument.

Parameters:

handle - candidate

Returns:

true if handle is a TemplateArgument

isATemplateParameter

boolean isATemplateParameter(java.lang.Object handle)

Recognizer for TemplateParameter.

Parameters:

handle - candidate

Returns:

true if handle is a TemplateParameter

isATerminateAction

boolean isATerminateAction(java.lang.Object handle)

Recognizer for TerminateAction.

Parameters:

handle - candidate

Returns:

true if handle is a TerminateAction

isATransition

boolean isATransition(java.lang.Object handle)

Recognizer for Transition.

Parameters:

handle - candidate

Returns:

true if handle is a Transition

isATimeEvent

boolean isATimeEvent(java.lang.Object handle)

Recognizer for TimeEvent.

Parameters:

handle - candidate

Returns:

true if handle is a TimeEvent

isAUMLElement

boolean isAUMLElement(java.lang.Object handle)

Recognizer for any UML type defined in the UML specification, including those which are not subtypes of Element.

In the UML 1.4 specification, not all defined types are subtypes of Element, although this has been fixed/changed in UML 2.

Parameters:

handle - the UML object

Returns:

true if the given object is a UML object

See Also:

isAElement(Object)

isAUninterpretedAction

boolean isAUninterpretedAction(java.lang.Object handle)

Recognizer for UninterpretedAction.

Parameters:

handle - candidate

Returns:

true if handle is a UninterpretedAction

isAUsage

boolean isAUsage(java.lang.Object handle)

Recognizer for Usage.

Parameters:

handle - candidate

Returns:

true if handle is a Usage

isAUseCase

boolean isAUseCase(java.lang.Object handle)

Recognizer for a UseCase.

Parameters:

handle - candidate

Returns:

true if handle is a UseCase

isAVisibilityKind

boolean isAVisibilityKind(java.lang.Object handle)

Recognizer for VisibilityKind.

Parameters:

handle - candidate

Returns:

true if handle is a VisibilityKind

isActive

boolean isActive(java.lang.Object handle)

Recognizer for UML Classes that are Active.

Parameters:

handle - candidate

Returns:

true if Class is Active

isConcurrent

boolean isConcurrent(java.lang.Object handle)

Recognizer for concurrent CompositeState.

Parameters:

handle - composite state

Returns:

true if concurent.

isAConcurrentRegion

boolean isAConcurrentRegion(java.lang.Object handle)

Recognizer for ConcurrentRegion. A concurrent region is a CompositeState which has an owner that is concurrent.

Parameters:

handle - candidate

Returns:

true if handle is a ConcurrentRegion

isConstructor

boolean isConstructor(java.lang.Object handle)

Recognizer for constructor. A constructor is an operation that has a stereotype named create or a method that is a specification of an operator that is a constructor.

Parameters:

handle - candidate

Returns:

true if handle is a constructor.

isFrozen

boolean isFrozen(java.lang.Object handle)

Returns true if the given element is Frozen.

Parameters:

handle - candidate

Returns:

boolean true if Frozen

isComposite

boolean isComposite(java.lang.Object handle)

Returns true if a given AssociationEnd has an aggretation kind of Composite.

Parameters:

handle - candidate

Returns:

boolean

isAggregate

boolean isAggregate(java.lang.Object handle)

Returns true if a given AssociationEnd has an aggretation kind of Aggregate.

Parameters:

handle - candidate

Returns:

boolean

isInitialized

boolean isInitialized(java.lang.Object handle)

Recognizer for Attributes that are initialized. An Attribute is considered initalized if it has an initialValue expression with a non-empty body.

Parameters:

handle - candidate

Returns:

true if the attribute is initialized.

isInternal

boolean isInternal(java.lang.Object handle)

Recognizer for internal transitions. An internal Transition has its owning State as both the source State and target State.

Parameters:

handle - candidate

Returns:

true if handle is an internal transition.

isLeaf

boolean isLeaf(java.lang.Object handle)

Recognizer for leaf element. True if it has an isLeaf attribute with a value of true. If there's no such attribute (ie it isn't a type which has that attribute in the UML metamodel), it will return false without throwing an error.

Parameters:

handle - candidate GeneralizableElement, Operation, or Reception

Returns:

true if handle is a leaf

isRoot

boolean isRoot(java.lang.Object handle)

Recognizer for roots. True if it has an isRoot attribute with a value of true. If there's no such attribute (ie it isn't a type which has that attribute in the UML metamodel), it will return false without throwing an error.

Parameters:

handle - candidate GeneralizableElement, Operation, or Reception

Returns:

true if handle is a root

isSpecification

boolean isSpecification(java.lang.Object handle)

Return value of isSpecification attribute for a ModelElement or ElemetImport.

Parameters:

handle - candidate ModelElement or ElemetImport

Returns:

boolean value contained by the isSpecification attribute

isNavigable

boolean isNavigable(java.lang.Object handle)

Return navigability of an AssociationEnd.

Parameters:

handle - candidate AssociationEnd

Returns:

true if handle is navigable

isPrimaryObject

boolean isPrimaryObject(java.lang.Object handle)

Recognizer for primary objects. A primary object is an object that is created by the parser or by a user. Object that are created as a side effect of importing some other object are not.

TODO: This doesn't belong in the Facade. It's a higher level function used specifically for certain reverse engineering operations. - tfmorris

Parameters:

handle - candidate

Returns:

true if primary object.

isPackage

boolean isPackage(java.lang.Object handle)

Recognizer for ModelElements with package visibility. TODO: This method name was chosen for compatibility with the existing naming scheme, but has the potential of clashing with some future use.

Parameters:

handle - candidate

Returns:

true if handle has package visibility

isPrivate

boolean isPrivate(java.lang.Object handle)

Recognizer for ModelElements with private visibility.

Parameters:

handle - candidate

Returns:

true if handle has private

isPublic

boolean isPublic(java.lang.Object handle)

Recognizer for ModelElements with public visibility.

Parameters:

handle - candidate

Returns:

true if handle has public

isQuery

boolean isQuery(java.lang.Object handle)

Recognizer for BehaviouralFeature's that are queries.

Parameters:

handle - candidate

Returns:

true if it is a query

isProtected

boolean isProtected(java.lang.Object handle)

Recognizer for ModelElements with protected visibility.

Parameters:

handle - candidate

Returns:

true if handle has protected

isRealize

boolean isRealize(java.lang.Object handle)

Recognizer for ModelElements which have the <> Stereotype applied.

Parameters:

handle - candidate

Returns:

true if handle has a realize stereotype

isReturn

boolean isReturn(java.lang.Object handle)

Recognizer for Parameter's with a DirectionKind of Return. TODO: This is a duplicate of hasReturnParameterDirectionKind(Object)

Parameters:

handle - candidate parameter

Returns:

true if handle is a return parameter.

isSingleton

boolean isSingleton(java.lang.Object handle)

Recognizer for ModelElements which have the <> Stereotype applied.

TODO: Moved this out of the Facade to someplace elese since it's not Model subsystem specific - tfm 20070607

Parameters:

handle - candidate

Returns:

true if handle is a singleton.

isStereotype

boolean isStereotype(java.lang.Object handle,
                     java.lang.String stereotypename)

Recognizer for ModelElements with a given stereotype.

Parameters:

handle - candidate model element

stereotypename - a string that is the stereotype name.

Returns:

true if handle is an object that has the given stereotype.

isTop

boolean isTop(java.lang.Object handle)

Returns true if the given CompositeState is the top state. The top state has no containing StateMachine.

Parameters:

handle - CompositeState

Returns:

boolean true if top state

isType

boolean isType(java.lang.Object handle)

Recognizer for ModelElements with the <> Stereotype applied.

Parameters:

handle - candidate

Returns:

true if handle is a type.

isUtility

boolean isUtility(java.lang.Object handle)

Recognizer for ModelElements which have the <> Stereotype applied.

Parameters:

handle - candidate

Returns:

true if handle is a utility.

getAssociation

java.lang.Object getAssociation(java.lang.Object handle)

Returns the Association connected to an AssociationEnd or belonging to the given Link.

Parameters:

handle - the AssociationEnd or Link

Returns:

association end

getAssociations

java.util.Collection getAssociations(java.lang.Object handle)

Returns the Associations connected to a Classifer. UML2 only

Parameters:

handle - the Classifier

Returns:

associations

getAssociationEnd

java.lang.Object getAssociationEnd(java.lang.Object classifier,
                                   java.lang.Object association)

Return the AssociationEnd connecting the given Classifier and Association.

Parameters:

classifier - the classifier

association - is the association

Returns:

association end

getAssociationEnds

java.util.Collection getAssociationEnds(java.lang.Object handle)

Return the collection of AssociationEnds for a Classifier

Parameters:

handle - the Classifier for which to get the AssociationEnds.

Returns:

Collection with association ends.

getAssociationRoles

java.util.Collection getAssociationRoles(java.lang.Object handle)

Return the collection of AssociationRoles for an Association.

Parameters:

handle - the Association that we get the association roles from.

Returns:

Collection of association roles.

getAttributes

java.util.List getAttributes(java.lang.Object handle)

Return the List of Attributes for a Classifier.

Parameters:

handle - classifier to examine.

Returns:

Collection with attributes.

getBaseClasses

java.util.Collection<java.lang.String> getBaseClasses(java.lang.Object handle)

Return the Collection of the names of baseClasses for a Stereotype. Note that the returned values are Names, not Elements.

Parameters:

handle - the stereotype

Returns:

collection containing all applicable baseclasses

getBase

java.lang.Object getBase(java.lang.Object handle)

Return the base of a ModelElement. The element may be one of the following types: AssociationEndRole, AssociationRole, Extend, Include, or ClassifierRoles. NOTE: in the case of a ClassifierRole, the return value is a Collection of elements, not a single element. If you know you are dealing with a ClassifierRole, it is prefeable to use getBases(Object).

For UML 2.x with a target of an Include element, use getIncludingCase().

Parameters:

handle - the model element

Returns:

the base

getBases

java.util.Collection getBases(java.lang.Object handle)

Get the bases of a ClassifierRole.

Parameters:

handle - ClassifierRole.

Returns:

the bases.

getBehaviors

java.util.Collection getBehaviors(java.lang.Object handle)

Get the StateMachines which define the behaviors of a Modelelement.

Parameters:

handle - modelelement to examine.

Returns:

collection of StateMachines.

getBehavioralFeature

java.lang.Object getBehavioralFeature(java.lang.Object handle)

Get the BehavioralFeature of a Parameter.

Parameters:

handle - the Parameter

Returns:

the behavioral feature.

getBody

java.lang.Object getBody(java.lang.Object handle)

Get the body of a Method, Constraint, Expression, or Comment.

If the argument is an Expression, the body returned is a String (or null). If you want a type-safe version of this version of the call, use DataTypesHelper.getBody(Object).

Parameters:

handle - expression.

Returns:

the body.

getBound

int getBound(java.lang.Object handle)

Return the SynchState's bound.

Parameters:

handle - the synch State

Returns:

bound

getChangeability

@Deprecated
java.lang.Object getChangeability(java.lang.Object handle)

Deprecated. for 0.25.4 by tfmorris. Use isReadOnly(Object).

Return Changeability of a StructuralFeature or a AssociationEnd.

Parameters:

handle - the StructuralFeature or AssociationEnd

Returns:

the Changeability

getSpecific

java.lang.Object getSpecific(java.lang.Object handle)

Get the specific end of a generalization. This was getChild() in UML 1.x.

Parameters:

handle - generalization.

Returns:

the specific classifier.

Since:

0.25.4

getChildren

java.util.Collection getChildren(java.lang.Object handle)

Get the children of a GeneralizableElement.

Parameters:

handle - the GeneralizableElement.

Returns:

a collection with all children.

getClassifierRoles

java.util.Collection getClassifierRoles(java.lang.Object handle)

Get the ClassifierRoles of a Classifier or Feature.

Parameters:

handle - the Classifer or Feature.

Returns:

the classifiers roles of the instance

getClassifier

java.lang.Object getClassifier(java.lang.Object handle)

Get the classifier (participant) of an AssociationEnd. TODO: Rename this getParticipant to align with UML spec - tfm - 20070331

Parameters:

handle - The AssociationEnd to get from.

Returns:

The classifier of the AssociationEnd.

getClassifiers

java.util.Collection getClassifiers(java.lang.Object handle)

Get the classifiers of an Instance.

Parameters:

handle - the Instance

Returns:

the classifiers of the Instance

getClassifiersInState

java.util.Collection getClassifiersInState(java.lang.Object handle)

Get the classifiers in state of a Classifier or State.

Parameters:

handle - the model element

Returns:

the classifierss in state

getClients

java.util.Collection getClients(java.lang.Object handle)

Get the clients of a Dependency.

Parameters:

handle - the dependency

Returns:

the clients of the dependency

getClientDependencies

java.util.Collection getClientDependencies(java.lang.Object handle)

Get the client dependencies of a ModelElement (i.e. those Dependencies in which this ModelElement participates as a client).

Parameters:

handle - the ModelElement.

Returns:

a collection of all client dependencies.

getCondition

java.lang.Object getCondition(java.lang.Object handle)

Get the condition of an Extend.

Parameters:

handle - The Extend.

Returns:

the condition

getConcurrency

java.lang.Object getConcurrency(java.lang.Object handle)

Get the concurrency of an Operation.

Parameters:

handle - The Operation.

Returns:

the concurrency.

getConnections

java.util.Collection getConnections(java.lang.Object handle)

Return the connections to an Association or a Link.

Parameters:

handle - the Association or Link

Returns:

a Collection with all connections of type AssociationEnd or LinkEnd.

getEffect

java.lang.Object getEffect(java.lang.Object handle)

Return the effect of a Transition.

Parameters:

handle - the Transition

Returns:

the effect

getElementResidences

java.util.Collection getElementResidences(java.lang.Object handle)

Get the ElementResidences of a ModelElement.

Parameters:

handle - the ModelElement that we are getting the residences of

Returns:

the collection with ElementResidences

getElementImports2

java.util.Collection getElementImports2(java.lang.Object handle)

Return the ElementImports which have this ModelElement as their importedElement. For the inverse relationship (ElementImports which import into a Package) see getElementImports(Object).

Parameters:

handle - the ModelElement

Returns:

the collection of ElementImports

See Also:

getElementImports(Object)

getElementImports

java.util.Collection getElementImports(java.lang.Object handle)

Return the ElementImports which import into this Package. For the inverse relationship (ElementImports which have a particular ModelElement as their importedElement), see getElementImports2(Object).

Parameters:

handle - the package

Returns:

the collection of ElementImports

See Also:

getElementImports2(Object)

getEntry

java.lang.Object getEntry(java.lang.Object handle)

Return the entry Action for a State.

Parameters:

handle - the State

Returns:

the entry

getEnumeration

java.lang.Object getEnumeration(java.lang.Object handle)

Return the Enumeration which owns a given EnumerationLiteral.

Parameters:

handle - the EnumerationLiteral

Returns:

the owning Enumeration

getEnumerationLiterals

java.util.List getEnumerationLiterals(java.lang.Object handle)

Return the List of enumeration literals for a UML Enumeration.

Parameters:

handle - the Enumeration

Returns:

List of the Enumeration literals.

getExit

java.lang.Object getExit(java.lang.Object handle)

Return the exit action to a State.

Parameters:

handle - the state

Returns:

the exit action

getExpression

java.lang.Object getExpression(java.lang.Object handle)

Get the Expression belonging to a Argument, Guard, ChangeEvent or TimeEvent.

Parameters:

handle - the Object to get the Expression from

Returns:

Object the Expression

getExtendedElements

java.util.Collection getExtendedElements(java.lang.Object handle)

Return ModelElements which have a given Stereotype applied. (ie. the Stereotype's extendedElements collection)

Parameters:

handle - stereotype for which to return extended elements

Returns:

collection of model elements extended by given stereotype

getExtends

java.util.Collection getExtends(java.lang.Object handle)

Return all Extends of a UseCase or ExtensionPoint.

Parameters:

handle - the UseCase or the ExtensionPoint

Returns:

the extends

getExtenders

java.util.Collection getExtenders(java.lang.Object handle)

Return all extenders of a UseCase.

Parameters:

handle - the UseCase

Returns:

the extends

getExtension

java.lang.Object getExtension(java.lang.Object handle)

Get the UseCase which is the extension of an Extend.

Parameters:

handle - the extend

Returns:

The extension

getExtensionPoint

java.lang.Object getExtensionPoint(java.lang.Object handle,
                                   int index)

Return the ExtensionPoint at given index-number.

Parameters:

handle - Extend

index - int

Returns:

ExtensionPoint

getExtensionPoints

java.util.Collection getExtensionPoints(java.lang.Object handle)

Return all ExtensionPoints of a UseCase or Extend.

Parameters:

handle - the UseCase or the Extend

Returns:

the Collection of ExtensionPoints. If the argument was an Extend, the Collection is ordered, ie a List.

getFeatures

java.util.List getFeatures(java.lang.Object handle)

Get the List of Features owned by a Classifier.

Parameters:

handle - Classifier to retrieve from.

Returns:

List of Features

getGeneralization

java.lang.Object getGeneralization(java.lang.Object handle,
                                   java.lang.Object parent)

Get the Generalization connecting two GeneralizableElements. Returns null if there is none.

Parameters:

handle - the child

parent - is the parent

Returns:

The generalization or null if none found

getGeneralizations

java.util.Collection getGeneralizations(java.lang.Object handle)

Return collection of Generalizations that the given GeneralizableElement participates in as a child. Use getSpecializations(Object) to find the Generalizations that it particpates in as a parent.

Parameters:

handle - GeneralizableElement to retrieve from.

Returns:

Generalizations

getGuard

java.lang.Object getGuard(java.lang.Object handle)

Get the guard for a Transition.

Parameters:

handle - the Transition

Returns:

Object

getIcon

java.lang.Object getIcon(java.lang.Object handle)

Return the Icon of a Stereotype.

Parameters:

handle - the Stereotype to get the Icon from

Returns:

the Icon

getIncludes

java.util.Collection getIncludes(java.lang.Object handle)

Return the includes for a UseCase.

Parameters:

handle - the UseCase

Returns:

a Collection containing the Includes

getIncluders

java.util.Collection getIncluders(java.lang.Object handle)

Return Includes which have the given UseCase as an addition. NOTE: The association is not navigable in this direction, so this isn't guaranteed to work in the general case, but it will return all appropriate elements which can be found in the current model repository.

Parameters:

handle - the UseCase

Returns:

the includes as a Collection

getIncomings

java.util.Collection getIncomings(java.lang.Object handle)

Return the incoming Transitions for some StateVertex, Transition, Action, or Guard. For a Transition, the incomings of its source StateVertex are used. For an Action or Guard, the owning Transition is found and then the algorithm for Transitions is applied.

Parameters:

handle - a StateVertex, Transition, Action, or Guard

Returns:

Collection of Transitions

getInitialValue

java.lang.Object getInitialValue(java.lang.Object handle)

Return the initial value of an Attribute.

Parameters:

handle - the Attribute

Returns:

an Expression representing the initial value

getInstance

java.lang.Object getInstance(java.lang.Object handle)

Return the instance of an AttributeLink or LinkEnd.

Parameters:

handle - the attribute link or link end

Returns:

initial value

getInstances

java.util.Collection getInstances(java.lang.Object handle)

Return the Instances associated with a Classifier.

Parameters:

handle - the classifier

Returns:

Collection

getInStates

java.util.Collection getInStates(java.lang.Object handle)

Return the collection of States for a ClassifierInState.

Parameters:

handle - the classifierInState

Returns:

Collection

getInteraction

java.lang.Object getInteraction(java.lang.Object handle)

Return the Interaction for a Message.

Parameters:

handle - the Message

Returns:

the interaction

getInteractions

java.util.Collection getInteractions(java.lang.Object handle)

Return the Interactions belonging to a Collaboration.

Parameters:

handle - the Collaboration

Returns:

Collection

getInternalTransitions

java.util.Collection getInternalTransitions(java.lang.Object handle)

Return the internalTransitions belonging to a State.

Parameters:

handle - the State

Returns:

Collection

getMessages

java.util.Collection getMessages(java.lang.Object handle)

Return the messages belonging to an Interaction, AssociationRole, or Action.

Parameters:

handle - the candidate element

Returns:

Collection of Messages

getMessageSort

java.lang.Object getMessageSort(java.lang.Object handle)

Return the MessageSort of the Message

Parameters:

handle - the message

Returns:

the MessageSort

getSuccessors

java.util.Collection getSuccessors(java.lang.Object handle)

Return the Messages which are successors to the given Message.

Parameters:

handle - the message

Returns:

Collection

getActivatedMessages

java.util.Collection getActivatedMessages(java.lang.Object handle)

Return the Messages that are activated by the given Message.

Parameters:

handle - Message

Returns:

the Collection of Messages

getReceivedMessages

java.util.Collection getReceivedMessages(java.lang.Object handle)

Return the Messages received by the given ClassifierRole.

Parameters:

handle - the ClassifierRole

Returns:

Collection

getSentMessages

java.util.Collection getSentMessages(java.lang.Object handle)

Return the Messages sent by the given ClassifierRole.

Parameters:

handle - the ClassifierRole

Returns:

Collection

getInnerContainingModel

java.lang.Object getInnerContainingModel(java.lang.Object handle)

Get the innermost containing Model of a ModelElement.

If no containing Model can be found, the outermost containing ModelElement is returned (which could be the original element itself if it has no owner).

This method is intended to return the innermost containing Model, but there are circumstances where one may really expect the outermost containing Model or root package to be returned (e.g. where it's being used to test if two elements are from disjoint namespace hierarchies). Hence, there are two separate methods with different semantics. The method getRoot(Object) returns the outermost containing object.

TODO: Note also that some code uses org.argouml.kernel.Project#getRoot() to navigate down from the top instead of up from the bottom. We need to use a consistent algorithm for this. - tfm 20070724

Parameters:

handle - to the model element.

Returns:

model for the model element.

getRoot

java.lang.Object getRoot(java.lang.Object handle)

Get the top level containing element, i.e. the element which has no owner. For well-formed models, this will typically be a UML Package, often a Model.

Parameters:

handle - to the model element.

Returns:

the top level element.

getRootElements

java.util.Collection getRootElements()

Return a collection of all Elements which have no owner (ie top level elements).

For ArgoUML created models this will typically just return a single top level Model model element, but models created by other tools may have other top level elements.

getModelElement

java.lang.Object getModelElement(java.lang.Object handle)

Get the ModelElement which is one of:

• the importElement of an ElementImport
• the modelElement of a TaggedValue
• the modelElement of a TemplateParameter

Parameters:

handle - an Element Import or TaggedValue.

Returns:

the model element

getMultiplicity

java.lang.Object getMultiplicity(java.lang.Object handle)

Get the Multiplicity of an AssociationEnd, ClassifierRole, StructuralFeature, or TagDefinition.

Parameters:

handle - model element to retrieve from. An exception is thrown if null.

Returns:

multiplicity

getComments

java.util.Collection getComments(java.lang.Object handle)

Get the Comments which annotate a ModelElement.

Parameters:

handle - the ModelElement that we are getting the comments of

Returns:

the Collection of Comments

getAnnotatedElements

java.util.Collection getAnnotatedElements(java.lang.Object handle)

Get the ModelElements (annotatedElements) which are annotated by a Comment.

Parameters:

handle - the Comment that we are getting the model elements of

Returns:

a Collection of ModelElements

getCommunicationConnection

java.lang.Object getCommunicationConnection(java.lang.Object handle)

Get the communicationConnection of a Message.

Parameters:

handle - the Message for which to find the communicationConnection

Returns:

Message which is the communicationConnection or null

getCommunicationLink

java.lang.Object getCommunicationLink(java.lang.Object handle)

Get the communicationLink of a Stimulus.

Parameters:

handle - the Stimulus for which to find the communicationLink

Returns:

Link which is the communicationLink or null if none.

getCollaborations

java.util.Collection getCollaborations(java.lang.Object handle)

Get the collaborations for a Classifier or Operation. This returns the Collaborations which have the given Classifier or Operation as their representedClassifier or representedOperation.

Parameters:

handle - the model element that we are getting the collaborations of.

Returns:

Collection of Collaborations

getComponentInstance

java.lang.Object getComponentInstance(java.lang.Object handle)

Get the componentInstance of an Instance.

Parameters:

handle - the Instance

Returns:

the ComponentInstance

getConstrainingElements

java.util.Collection getConstrainingElements(java.lang.Object handle)

Return the constrainingElements of a Collaboration.

Parameters:

handle - the Collaboration

Returns:

Collection of ModelElements

getConstrainedElements

java.util.List getConstrainedElements(java.lang.Object handle)

Return the constrainedElements of a Constraint.

Parameters:

handle - the Constraint

Returns:

List of ModelElements

getConstraints

java.util.Collection getConstraints(java.lang.Object handle)

Return the Constraints for the given ModelElement.

Parameters:

handle - the ModelElement

Returns:

the collection of all Constraints

getModelElementContainer

java.lang.Object getModelElementContainer(java.lang.Object handle)

Return the container for the given modelelement. If you know the type of ModelElement you are working with, you should use the appropriate more specific function (e.g. getAssociation for an AssociationEnd).

This is principally intended as a convenience function for generic code that deals with a variety of element types that just wants a parent of some type without really caring what it is.

The container is the owner of the modelelement. It will be null for elements that don't have an owner. All elements except for the root element in a project should have an owner. The root element is always a model.

In the future, this function could return the container of Figs too.

Parameters:

handle - is the base

Returns:

Object

getModelElementContents

java.util.List getModelElementContents(java.lang.Object handle)

Return all composite components of given ModelElement. This is the inverse of getModelElementContainer and that method will return handle for all elements in the Collection.

Parameters:

handle - ModelElement for which to fetch components

Returns:

collection of components contained by ModelElement

getModelElementAssociated

java.util.List getModelElementAssociated(java.lang.Object handle)

Return all ModelElements associated with the given ModelElement by a MOF level association (not an just an association in the user model, although it includes those too).

This is useful for traversing the model to find elements which are related in ANY way to the current element.

Parameters:

handle - ModelElement for which to find associated elements

Returns:

collection of elements associated with ModelElement

getContainer

java.lang.Object getContainer(java.lang.Object handle)

Return the CompositeState or Component that is the container of the given StateVertex or ElementResidence, respectively.

ElementResidence support is new in UML 1.4 (was getImplementationLocation)

Parameters:

handle - the StateVertex or ElementResidence

Returns:

the CompositeState or Component that is the container

getContents

java.util.Collection getContents(java.lang.Object handle)

Return all ModelElements contained in a Partition.

Parameters:

handle - the Partition

Returns:

Collection of ModelElements

getContext

java.lang.Object getContext(java.lang.Object handle)

Return the context of a StateMachine or Interaction.

Parameters:

handle - the StateMachine or the Interaction

Returns:

the ModelElement representing the context, or null if no context set.

getContexts

java.util.Collection getContexts(java.lang.Object handle)

Return the BehavioralFeatures which are contexts for a given Signal (ie have this Signal as a raisedSignal).

Parameters:

handle - the Signal

Returns:

Collection of BehavioralFeatures

getCreateActions

java.util.Collection getCreateActions(java.lang.Object handle)

Return the CreateActions that create/instantiate the given Classifier.

Parameters:

handle - the Classifier

Returns:

a collection of CreateActions

getDefaultValue

java.lang.Object getDefaultValue(java.lang.Object handle)

Get the defaultValue of a Parameter.

Parameters:

handle - the Parameter that we are getting the defaultvalue from

Returns:

an Expression representing the default value

getDeferrableEvents

java.util.Collection getDeferrableEvents(java.lang.Object handle)

Get deferrable events of a State.

Parameters:

handle - the state that we are getting the deferrable event from

Returns:

Collection of Events

getDeployedComponents

java.util.Collection getDeployedComponents(java.lang.Object handle)

Return all Components that are deployed inside the given Node.

Parameters:

handle - the given Node

Returns:

Collection of Components

getDeploymentLocations

java.util.Collection getDeploymentLocations(java.lang.Object handle)

Return all Nodes in which the given Component is deployed.

Parameters:

handle - the Componet

Returns:

Collection of Nodes

getDiscriminator

@Deprecated
java.lang.Object getDiscriminator(java.lang.Object handle)

Deprecated. for 0.25.4 by tfmorris. Discriminators have been removed from UML 2.x.

Get the discriminator for a Generalization.

Parameters:

handle - the Generalization

Returns:

the discriminator a String

getDispatchAction

java.lang.Object getDispatchAction(java.lang.Object handle)

Get the dispatchAction of a Stimulus.

Parameters:

handle - the stimulus that we are getting the dispatchaction of

Returns:

the dispatchaction (or null)

getDoActivity

java.lang.Object getDoActivity(java.lang.Object handle)

Return the Action which is the doActivity for the given State.

Parameters:

handle - the state

Returns:

the do activity

getImportedElements

java.util.Collection getImportedElements(java.lang.Object pack)

The collection of imported elements of the given package.

Parameters:

pack - package to retrieve from.

Returns:

A Collection with the imported elements.

getImportedElement

java.lang.Object getImportedElement(java.lang.Object elementImport)