Facade (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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)

Signatures for all getters are:

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

Field Summary
`static String`	`GENERATED_TAG` This tag is set on elements that are generated by reference when importing.

Method Summary
`boolean`	`equalsPseudostateKind(Object ps1, Object ps2)` Check whether two pseudostatekinds are equal/of the same type.
`Object`	`getAction(Object handle)` Returns the action belonging to some message or argument.
`Object`	`getActivator(Object handle)` Returns the activator belonging to some message.
`Collection`	`getActualArguments(Object handle)` Returns the actual arguments for a given action.
`Object`	`getAddition(Object handle)` Returns an addition for a given include.
`Object`	`getAggregation(Object handle)` Returns the AggregationKind of a given AssociationEnd.
`Collection`	`getAnnotatedElements(Object handle)` Get the modelelement that were commented.
`Collection`	`getAssociatedClasses(Object handle)` Returns all associated classes (classes connected by an Association) for some given classifier.
`Object`	`getAssociation(Object handle)` Returns the association connected to an association end or the association belonging to the given link.
`Object`	`getAssociationEnd(Object handle, Object assoc)` Returns the association end between some classifier and some associaton.
`Collection`	`getAssociationEnds(Object handle)` The list of Association Ends.
`Collection`	`getAssociationRoles(Object handle)` The list of association roles.
`Collection`	`getAttributes(Object handle)` The list of Attributes.
`Object`	`getBase(Object handle)` The base of some model element.
`Object`	`getBaseClass(Object handle)` Deprecated. use getBaseClasses for UML 1.4 and later
`Collection`	`getBaseClasses(Object handle)` Collection of baseclasses of some stereotype.
`Collection`	`getBases(Object handle)` Get the bases of a classifier role.
`Object`	`getBehavioralFeature(Object handle)` Get the behavioral feature of an parameter.
`Collection`	`getBehaviors(Object handle)` Get the StateMachines which define the behaviors of a Modelelement.
`Object`	`getBody(Object handle)` Get the body of an method/constraint/expression/comment.
`int`	`getBound(Object handle)` Return the Synch State's bound.
`Object`	`getChangeability(Object handle)` Return Changeability of a StructuralFeature or a AssociationEnd.
`Object`	`getChangeExpression(Object target)`
`Object`	`getChild(Object handle)` Get the child of a generalization.
`Collection`	`getChildren(Object handle)` Get the children of some generalizable element.
`Object`	`getClassifier(Object handle)` Get the classifier of an Association End.
`Collection`	`getClassifierRoles(Object handle)` Gets the classifiers roles of some model element.
`Collection`	`getClassifiers(Object handle)` Gets the classifierss of some instance.
`Collection`	`getClassifiersInState(Object handle)` Gets the classifiers in state of some model element.
`Collection`	`getClientDependencies(Object handle)` Get the client dependencies of some classifier.
`Collection`	`getClients(Object handle)` Gets the clients of some dependency.
`Collection`	`getCollaborations(Object handle)` Get the collaborations of an element.
`Collection`	`getComments(Object handle)` Get the comments of an element.
`Object`	`getCommunicationConnection(Object handle)` Get the communication connection of an message.
`Object`	`getCommunicationLink(Object handle)` Get the communication link of a stimulus.
`Object`	`getComponentInstance(Object handle)` Get the component instance of an instance.
`Object`	`getConcurrency(Object handle)` Get the concurrency of an operation.
`Object`	`getCondition(Object handle)` Get the condition of an extend.
`Collection`	`getConnections(Object handle)` The list of connections to an association or link.
`Collection`	`getConstrainedElements(Object handle)` Returns the collection of ConstrainedElements of a constraint.
`Collection`	`getConstrainingElements(Object handle)` Returns the collection of ConstrainingElements of a Collaboration.
`Collection`	`getConstraints(Object handle)` Get the collection of all constraints of the given ModelElement.
`Object`	`getContainer(Object handle)` Returns the CompositeState or Component that is the container of the given StateVertex or ElementResidence, respectively.
`Collection`	`getContents(Object handle)` Returns the collection of ModelElements contained in a Partition.
`Object`	`getContext(Object handle)` Returns the context of some given statemachine or the context of some given interaction.
`Collection`	`getContexts(Object handle)` Return the collection of the Contexts of a given Signal.
`Collection`	`getCreateActions(Object handle)` Return the collection of Actions that create/instantiate the given Classifier.
`Collection`	`getDataValue(Object taggedValue)` Return the dataValue collection for a taggedValue.
`Object`	`getDefaultValue(Object handle)` Get the default value of a parameter.
`Collection`	`getDeferrableEvents(Object handle)` Get deferrable events of a state.
`Collection`	`getDeployedComponents(Object handle)` Returns the collection of components that are deployed inside the given node.
`Collection`	`getDeploymentLocations(Object handle)` Returns the context of some given statemachine or the context of some given interaction.
`Object`	`getDiscriminator(Object handle)` Get the discriminator.
`Object`	`getDispatchAction(Object handle)` Get the dispatchaction of a stimulus.
`Object`	`getDoActivity(Object handle)` Returns the do activity action of a state.
`Object`	`getEffect(Object handle)` Returns the effect of some transition.
`Collection`	`getElementImports2(Object handle)` Returns the ElementImports of this ModelElement.
`Collection`	`getElementResidences(Object handle)` Get the residences of an element.
`Object`	`getEntry(Object handle)` Returns the entry action to a state.
`Object`	`getEnumeration(Object handle)` Returns the Enumeration of an EnumerationLiteral.
`List`	`getEnumerationLiterals(Object handle)` Returns the enumeration literals of a UML Enumeration.
`Object`	`getExit(Object handle)` Returns the exit action to a state.
`Object`	`getExpression(Object handle)` Get the Expression belonging to a Guard, ChangeEvent or timeEvent.
`Collection`	`getExtendedElements(Object handle)` Return all extended elements in the current repository for the given stereotype.
`Collection`	`getExtends(Object handle)` Returns all extends of a use case or extension point.
`Collection`	`getExtends2(Object handle)` Returns all extends of a use case.
`Object`	`getExtension(Object handle)` Gets the use case extension of an extend.
`Object`	`getExtensionPoint(Object handle, int index)` Returns the Extensionpoint at given index-number.
`Collection`	`getExtensionPoints(Object handle)` Returns all extends of a use case.
`Collection`	`getFeatures(Object handle)` The list of Features from a Classifier.
`Object`	`getGeneralization(Object handle, Object parent)` Gets the generalization between two generalizable elements.
`Collection`	`getGeneralizations(Object handle)` The list of Generalizations from a GeneralizableElement.
`Object`	`getGuard(Object handle)` Gets the guard for some given transition.
`Object`	`getIcon(Object handle)` Returns the Icon of a Stereotype.
`Object`	`getImplementationLocation(Object handle)` Deprecated. use getContainer
`Object`	`getImportedElement(Object elementImport)` Returns the imported element from a ElementImport.
`Collection`	`getImportedElements(Object pack)` The list of imported elements of the given package.
`Collection`	`getIncludes(Object handle)` Returns the includers for some use case.
`Collection`	`getIncludes2(Object handle)` Returns the includes for some use case.
`Collection`	`getIncomings(Object handle)` Returns the incoming transitions for some statevertex.
`Object`	`getInitialValue(Object handle)` Returns the initial value for some attribute.
`Object`	`getInstance(Object handle)` Returns the instance of an AttributeLink or LinkEnd.
`Collection`	`getInstances(Object handle)` Returns the Instances for some Clasifier.
`Collection`	`getInStates(Object handle)` Returns the collection of States for some ClasifierInState.
`Object`	`getInteraction(Object handle)` Returns the interaction for some message.
`Collection`	`getInteractions(Object handle)` Returns the interactions belonging to a collaboration.
`Collection`	`getInternalTransitions(Object handle)` Returns the internal transitions belonging to a state.
`Object`	`getKind(Object handle)` Returns the Kind of a Pseudostate or Parameter.
`Object`	`getLink(Object handle)` Returns the Link belonging to the given LinkEnd.
`Collection`	`getLinkEnds(Object handle)` Return the LinkEnds of a given Instance or AssociationEnd.
`Collection`	`getLinks(Object handle)` Return the Links of a given Association.
`String`	`getLocation(Object handle)` Gets a location of some extension point.
`int`	`getLower(Object handle)` Returns the lower bound of the multiplicity of the given element (AssociationEnd, Multiplicity or MultiplicityRange).
`Collection`	`getMessages(Object handle)` Returns the messages belonging to some interaction.
`Collection`	`getMessages1(Object handle)` Returns the messages received by the given classifier role.
`Collection`	`getMessages2(Object handle)` Returns the messages send by the given classifier role.
`Collection`	`getMessages3(Object handle)` Returns the messages belonging to some other message.
`Collection`	`getMessages4(Object handle)` Get the messages that are activated by the given message.
`Collection`	`getMethods(Object handle)` Get the methods of an operation.
`Object`	`getModel(Object handle)` Get the model of some model element.
`Object`	`getModelElement(Object handle)`
`List`	`getModelElementAssociated(Object handle)` Returns 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).
`Object`	`getModelElementContainer(Object handle)` Returns the container for the given modelelement.
`List`	`getModelElementContents(Object handle)` Returns all composite components of given ModelElement.
`Object`	`getMultiplicity(Object handle)` Get the Multiplicity from a model element.
`String`	`getName(Object handle)` The name of a model element or some diagram part.
`Object`	`getNamespace(Object handle)` Get the namespace of an element.
`Object`	`getNodeInstance(Object handle)` Get the node instance of a component instance.
`Collection`	`getObjectFlowStates(Object handle)` The collection of object flow states.
`Collection`	`getOccurrences(Object handle)` Get the occurrences of an operation.
`Object`	`getOperation(Object handle)` Get the operation of a Call Action or Call Event.
`Collection`	`getOperations(Object handle)` Get the list of operations.
`Object`	`getOppositeEnd(Object handle)` Returns the opposite end of an association end.
`Object`	`getOrdering(Object handle)` Get ordering of an association end.
`Collection`	`getOtherAssociationEnds(Object handle)` Get the list of Associations Ends connected to this association end.
`Collection`	`getOtherLinkEnds(Object handle)` Get the list of Link Ends connected to this link end.
`Collection`	`getOutgoings(Object handle)` Returns the list of Transitions outgoing from the given stateVertex.
`Collection`	`getOwnedElements(Object handle)` The list of owned elements of the the namespace.
`Object`	`getOwner(Object handle)` Return the owner of a feature or its association end if it is a qualified attribute.
`Object`	`getOwnerScope(Object handle)` Get the owner scope of a feature.
`Object`	`getPackage(Object handle)` Returns the Package that is connected by the given ElementImport.
`Object`	`getParameter(Object handle, int n)` Get a parameter of a behavioral feature.
`Collection`	`getParameters(Object handle)` Get the parameters of a Object Flow State, Behavioral Feature, Classifier or Event.
`Object`	`getParent(Object handle)` Get the parent of a generalization.
`Collection`	`getPartitions(Object container)` Get the partitions from a container.
`Object`	`getPowertype(Object handle)` Get the powertype of a generalization.
`Collection`	`getPowertypeRanges(Object handle)` Get the powertype ranges of a classifier.
`Collection`	`getPredecessors(Object handle)` Get the predecessors of a message.
`Object`	`getPseudostateKind(Object handle)` Returns the Kind of a Pseudostate.
`Collection`	`getQualifiers(Object handle)` Get the qualified attributes of an association end.
`Collection`	`getRaisedSignals(Object handle)` Returns the raised signals of an operation.
`Iterator`	`getRanges(Object handle)` Get the Ranges from a Multiplicity.
`Object`	`getReceiver(Object handle)` Returns the receiver object of a message or stimulus.
`Collection`	`getReceptions(Object handle)` Returns the receptions of a signal.
`Object`	`getRecurrence(Object handle)` Returns the recurrence iteration expression of an action.
`String`	`getReferenceState(Object o)` Return the Stub State's referenced state.
`Collection`	`getReferenceValue(Object taggedValue)` Return the referenceValue collection for a taggedValue.
`Object`	`getRepresentedClassifier(Object handle)` Returns the represented classifier of a collaboration.
`Object`	`getRepresentedOperation(Object handle)` Returns the represented operation of a collaboration.
`Object`	`getResident(Object handle)` Get the resident element.
`Collection`	`getResidentElements(Object handle)` Returns the collection of elements in a given component.
`Collection`	`getResidents(Object handle)` Returns a collection with all residents belonging to the given node.
`Object`	`getScript(Object handle)` Returns the script belonging to a given action.
`Object`	`getSender(Object handle)` Returns the sender object of a stimulus or a message.
`Object`	`getSignal(Object handle)` Returns the Signal of a SendAction, SignalEvent or Reception.
`Object`	`getSource(Object handle)` Gets the source for a given transition.
`Collection`	`getSourceFlows(Object handle)` Returns the sourceflows of a model element.
`Collection`	`getSources(Object handle)` Gets the source for some given flow.
`Collection`	`getSpecializations(Object handle)` The list of Specializations from a GeneralizableElement.
`String`	`getSpecification(Object handle)` Returns the Specification of a given Reception or Operation.
`Collection`	`getSpecifications(Object handle)` Returns specifications for an AssociationEnd or for a Classifier it returns all Interfaces of which this class is a realization.
`Object`	`getState(Object handle)` Returns the state belonging to some given transition.
`Object`	`getStateMachine(Object handle)` Returns the state machine belonging to some given state or transition If you need to find the StateMachine for an internal transition, or for ANY state, use StateMachinesHelper.getStateMachine() instead.
`Collection`	`getStates(Object handle)` Returns the states from a deferable event.
`Collection`	`getStereotypes(Object handle)` Returns the stereotypes belonging to some given model element.
`Collection`	`getStimuli(Object handle)` Returns the stimuli belonging to some given link.
`Collection`	`getStimuli2(Object handle)` Returns the Stimuli that are received by the given Instance.
`Collection`	`getStimuli3(Object handle)` Returns the Stimuli that are send by the given Instance.
`Collection`	`getStructuralFeatures(Object handle)` This method returns all attributes of a given Classifier.
`Object`	`getSubmachine(Object handle)` Returns the submachine of a submachine state.
`Collection`	`getSubmachineStates(Object handle)` Returns the submachine of a submachine state.
`Collection`	`getSubvertices(Object handle)` Returns a collection with all subvertices belonging to the given composite state.
`Collection`	`getSupplierDependencies(Object handle)` The list of SupplierDependencies from a ModelElement.
`Collection`	`getSuppliers(Object handle)` Returns the suppliers of a dependency.
`String`	`getTag(Object handle)` Return the tag of a tagged value.
`Object`	`getTagDefinition(Object handle)` Return the TagDefinition for a TaggedValue.
`Collection`	`getTagDefinitions(Object handle)` Return the TagDefinitions for a StereoType.
`Object`	`getTaggedValue(Object handle, String name)` Return the tagged value with a specific tag.
`Iterator`	`getTaggedValues(Object handle)` Return the tagged values iterator of a model element.
`Collection`	`getTaggedValuesCollection(Object handle)` Returns the TaggedValues of a ModelElement.
`String`	`getTaggedValueValue(Object handle, String name)` Return the value of a tagged value with a specific tag.
`String`	`getTagOfTag(Object handle)` Return the key (tag) of some tagged value.
`Object`	`getTarget(Object handle)` Returns the target of some transition.
`Collection`	`getTargetFlows(Object handle)` Returns the targetflows of a model element.
`Object`	`getTargetScope(Object handle)` Returns the target scope of some model element.
`String`	`getTipString(Object modelElement)` Returns a tooltip that should be shown for the given model element.
`Object`	`getTop(Object handle)` The top of a state machine.
`Object`	`getTransition(Object handle)` Get the transition of a guard or action.
`Collection`	`getTransitions(Object handle)` Returns the transitions belonging to the given handle.
`Object`	`getTrigger(Object handle)` Get the trigger of a transition.
`Object`	`getType(Object handle)` The type of a StructuralFeature, AssociationEnd, Parameter, ObjectFlowState, TagDefinition, TaggedValue or ClassifierInState.
`Collection`	`getTypedValues(Object handle)` Returns collection of TaggedValues typed by a TagDefinition
`String`	`getUMLClassName(Object handle)` Returns the name of the UML Model class.
`int`	`getUpper(Object handle)` Returns the upper bound of the multiplicity of the given element (AssociationEnd, Multiplicity or MultiplicityRange).
`Object`	`getUseCase(Object handle)` Returns the use case of an extension point.
`String`	`getUUID(Object element)` Return the ID of this element.
`Object`	`getValue(Object handle)` Returns the Value of some UML Object.
`String`	`getValueOfTag(Object handle)` Return the value of some tagged value.
`Object`	`getVisibility(Object handle)` Return the visibility of this element.
`Object`	`getWhen(Object target)`
`boolean`	`hasReturnParameterDirectionKind(Object handle)` Determine if the passed parameter has a RETURN direction kind.
`boolean`	`isAAbstraction(Object handle)` Recognizer for Abstraction.
`boolean`	`isAAction(Object handle)` Recognizer for Action.
`boolean`	`isAActionExpression(Object handle)` Recognizer for ActionExpression.
`boolean`	`isAActionSequence(Object handle)` Recognizer for ActionSequence.
`boolean`	`isAActionState(Object handle)` Recognizer for Action state.
`boolean`	`isAActivityGraph(Object handle)` Recognizer for ActivityGraph.
`boolean`	`isAActor(Object handle)` Recognizer for Actor.
`boolean`	`isAAggregationKind(Object handle)` Recognizer for AggregationKind.
`boolean`	`isAArgument(Object modelElement)` Recognizer for Arguments.
`boolean`	`isAAssociation(Object handle)` Recognizer for Association.
`boolean`	`isAAssociationClass(Object handle)` Recognizer for AssociationClass.
`boolean`	`isAAssociationEnd(Object handle)` Recognizer for AssociationEnd.
`boolean`	`isAAssociationEndRole(Object handle)` Recognizer for AssociationEndRole.
`boolean`	`isAAssociationRole(Object handle)` Recognizer for AssociationRole.
`boolean`	`isAAttribute(Object handle)` Recognizer for Attribute.
`boolean`	`isABase(Object handle)` Deprecated. use isAModelElement or a more specific recognizer for all new code
`boolean`	`isABehavioralFeature(Object handle)` Recognizer for behavioral features.
`boolean`	`isAbstract(Object handle)` Recognizer for abstract classes and operations.
`boolean`	`isACallAction(Object handle)` Recognizer for CallAction.
`boolean`	`isACallEvent(Object handle)` Recognizer for CallEvent.
`boolean`	`isACallState(Object handle)` Recognizer for CallState.
`boolean`	`isAChangeEvent(Object handle)` Recognizer for ChangeEvent.
`boolean`	`isAClass(Object handle)` Recognizer for Class.
`boolean`	`isAClassifier(Object handle)` Recognizer for Classifier.
`boolean`	`isAClassifierAndARelationship(Object handle)` Recognizer for a Element that is Classifier and RelationShip.
`boolean`	`isAClassifierInState(Object handle)` Recognizer for ClassifierInState.
`boolean`	`isAClassifierRole(Object handle)` Recognizer for ClassifierRole.
`boolean`	`isACollaboration(Object handle)` Recognizer for Collaboration.
`boolean`	`isAComment(Object handle)` Recognizer for Comment.
`boolean`	`isAComponent(Object handle)` Recognizer for Component.
`boolean`	`isAComponentInstance(Object handle)` Recognizer for ComponentInstance.
`boolean`	`isACompositeState(Object handle)` Recognizer for CompositeState.
`boolean`	`isAConcurrentRegion(Object handle)` Recognizer for ConcurrentRegion.
`boolean`	`isAConstraint(Object handle)` Recognizer for Constraint.
`boolean`	`isACreateAction(Object handle)` Recognizer for CreateAction.
`boolean`	`isActive(Object handle)` Recognizer for Classes that are Active.
`boolean`	`isADataType(Object handle)` Recognizer for DataType.
`boolean`	`isADataValue(Object handle)` Recognizer for DataValue.
`boolean`	`isADependency(Object handle)` Recognizer for Dependency.
`boolean`	`isADestroyAction(Object handle)` Recognizer for DestroyAction.
`boolean`	`isAElement(Object handle)` Recognizer for Element.
`boolean`	`isAElementImport(Object handle)` Recognizer for ElementImport.
`boolean`	`isAElementResidence(Object handle)` Recognizer for ElementResidence.
`boolean`	`isAEnumeration(Object handle)` Recognizer for UML Enumeration.
`boolean`	`isAEnumerationLiteral(Object handle)` Recognizer for UML EnumerationLiteral
`boolean`	`isAEvent(Object handle)` Recognizer for Event.
`boolean`	`isAException(Object handle)` Recognizer for Exception.
`boolean`	`isAExpression(Object handle)` Recognizer for Expression.
`boolean`	`isAExtend(Object handle)` Recognizer for Extend.
`boolean`	`isAExtensionPoint(Object handle)` Recognizer for ExtensionPoint.
`boolean`	`isAFeature(Object handle)` Recognizer for Feature.
`boolean`	`isAFinalState(Object handle)` Recognizer for FinalState.
`boolean`	`isAFlow(Object handle)` Recognizer for Flow.
`boolean`	`isAGeneralizableElement(Object handle)` Recognizer for GeneralizableElement.
`boolean`	`isAGeneralization(Object handle)` Recognizer for GeneralizableElement.
`boolean`	`isAggregate(Object handle)` Returns true if a given associationend is a composite.
`boolean`	`isAGuard(Object handle)` Recognizer for Guard.
`boolean`	`isAInclude(Object handle)` Recognizer for Include.
`boolean`	`isAInstance(Object handle)` Recognizer for Instance.
`boolean`	`isAInteraction(Object handle)` Recognizer for Interaction.
`boolean`	`isAInterface(Object handle)` Recognizer for Interface.
`boolean`	`isALink(Object handle)` Recognizer for Link.
`boolean`	`isALinkEnd(Object handle)` Recognizer for LinkEnd.
`boolean`	`isAMessage(Object handle)` Recognizer for Message.
`boolean`	`isAMethod(Object handle)` Recognizer for Method.
`boolean`	`isAModel(Object handle)` Recognizer for Model.
`boolean`	`isAModelElement(Object handle)` Recognizer for ModelElement.
`boolean`	`isAMultiplicity(Object handle)` Recognizer for Multiplicity.
`boolean`	`isAMultiplicityRange(Object handle)` Recognizer for MultiplicityRange.
`boolean`	`isANamespace(Object handle)` Recognizer for Namespace.
`boolean`	`isANaryAssociation(Object handle)` Recognizer for N-ary Association.
`boolean`	`isANode(Object handle)` Recognizer for a Node.
`boolean`	`isANodeInstance(Object handle)` Recognizer for a NodeInstance.
`boolean`	`isAObject(Object handle)` Recognizer for Object.
`boolean`	`isAObjectFlowState(Object handle)` Recognizer for ObjectFlowState.
`boolean`	`isAOperation(Object handle)` Recognizer for Operation.
`boolean`	`isAPackage(Object handle)` Recognizer for Package.
`boolean`	`isAParameter(Object handle)` Recognizer for Parameter.
`boolean`	`isAPartition(Object handle)` Recognizer for Partition.
`boolean`	`isAPermission(Object handle)` Recognizer for Permission.
`boolean`	`isAPseudostate(Object handle)` Recognizer for Pseudostate.
`boolean`	`isAPseudostateKind(Object handle)` Recognizer for PseudostateKind.
`boolean`	`isAReception(Object handle)` Recognizer for Reception.
`boolean`	`isARelationship(Object handle)` Recognizer for Relationship.
`boolean`	`isAReturnAction(Object handle)` Recognizer for Returnaction.
`boolean`	`isASendAction(Object handle)` Recognizer for SendAction.
`boolean`	`isASignal(Object handle)` Recognizer for Signal.
`boolean`	`isASignalEvent(Object handle)` Recognizer for SignalEvent.
`boolean`	`isASimpleState(Object handle)` Recognizer for SimpleState.
`boolean`	`isAState(Object handle)` Recognizer for State.
`boolean`	`isAStateMachine(Object handle)` Recognizer for StateMachine.
`boolean`	`isAStateVertex(Object handle)` Recognizer for StateVertex.
`boolean`	`isAStereotype(Object handle)` Recognizer for Stereotype.
`boolean`	`isAStimulus(Object handle)` Recognizer for stimulus.
`boolean`	`isAStructuralFeature(Object handle)` Recognizer for StructuralFeature.
`boolean`	`isAStubState(Object handle)` Recognizer for StubState.
`boolean`	`isASubactivityState(Object handle)` Recognizer for SubactivityState.
`boolean`	`isASubmachineState(Object handle)` Recognizer for SubmachineState.
`boolean`	`isASubsystem(Object handle)` Recognizer for Subsystem.
`boolean`	`isAsynchronous(Object handle)` Recognizer for asynchronisity of an action.
`boolean`	`isASynchState(Object handle)` Recognizer for SynchState.
`boolean`	`isATagDefinition(Object handle)` Recognizer for TagDefinition.
`boolean`	`isATaggedValue(Object handle)` Recognizer for TaggedValue.
`boolean`	`isATerminateAction(Object handle)` Recognizer for TerminateAction.
`boolean`	`isATimeEvent(Object handle)` Recognizer for TimeEvent.
`boolean`	`isATransition(Object handle)` Recognizer for Transition.
`boolean`	`isAUninterpretedAction(Object handle)` Recognizer for UninterpretedAction.
`boolean`	`isAUsage(Object handle)` Recognizer for Usage.
`boolean`	`isAUseCase(Object handle)` Recognizer for a Use Case.
`boolean`	`isAVisibilityKind(Object handle)` Recognizer for VisibilityKind.
`boolean`	`isChangeable(Object handle)` Recognizer for attributes that are changeable.
`boolean`	`isClassifierScope(Object handle)` Recognizer for attributes with classifier scope.
`boolean`	`isComposite(Object handle)` Returns true if a given associationend is a composite.
`boolean`	`isConcurrent(Object handle)` Recognizer for concurrent composite state.
`boolean`	`isConstructor(Object handle)` Recognizer for constructor.
`boolean`	`isFrozen(Object handle)` Returns true if the given element is Frozen.
`boolean`	`isInitialized(Object handle)` Recognizer for attributes that are initialized.
`boolean`	`isInstanceScope(Object handle)` Recognizer for attributes with instance scope.
`boolean`	`isInternal(Object handle)` Recognizer for internal transitions.
`boolean`	`isLeaf(Object handle)` Recognizer for leafs.
`boolean`	`isNavigable(Object handle)` Recognizer for Navigable elements.
`boolean`	`isPackage(Object handle)` Recognizer for attributes with package visibility.
`boolean`	`isPrimaryObject(Object handle)` Recognizer for primary objects.
`boolean`	`isPrivate(Object handle)` Recognizer for attributes with private.
`boolean`	`isProtected(Object handle)` Recognizer for attributes with protected.
`boolean`	`isPublic(Object handle)` Recognizer for attributes with public.
`boolean`	`isQuery(Object handle)` Recognizer for MBehaviouralFeature's that are queries.
`boolean`	`isRealize(Object handle)` Recognizer for realize.
`boolean`	`isReturn(Object handle)` Recognizer for return.
`boolean`	`isRoot(Object handle)` Recognizer for roots.
`boolean`	`isSingleton(Object handle)` Recognizer for singleton.
`boolean`	`isSpecification(Object handle)` Recognizer for specifications.
`boolean`	`isStereotype(Object handle, String stereotypename)` Recognizer for model elements with a given stereotype.
`boolean`	`isTop(Object handle)` Returns true if the given CompositeState is the top state.
`boolean`	`isType(Object handle)` Recognizer for type.
`boolean`	`isUtility(Object handle)` Recognizer for utility.
`Object`	`lookupIn(Object handle, String name)` Returns a named object in the given object by calling it's lookup method.
`String`	`toString(Object modelElement)` Returns a textual representation of the given model element.

Field Detail

GENERATED_TAG

public static final 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.

See Also:: Constant Field Values

Method Detail

isAAbstraction

public boolean isAAbstraction(Object handle)

Recognizer for Abstraction.

Parameters:: handle - candidate
Returns:: true if handle is an Abstraction.

isAAction

public boolean isAAction(Object handle)

Recognizer for Action.

Parameters:: handle - candidate
Returns:: true if handle is an Action

isAActionExpression

public boolean isAActionExpression(Object handle)

Recognizer for ActionExpression.

Parameters:: handle - candidate
Returns:: true if handle is an ActionExpression

isAActionSequence

public boolean isAActionSequence(Object handle)

Recognizer for ActionSequence.

Parameters:: handle - candidate
Returns:: true if handle is an action sequence

isAActionState

public boolean isAActionState(Object handle)

Recognizer for Action state.

Parameters:: handle - candidate
Returns:: true if handle is an Action state

isACallState

public boolean isACallState(Object handle)

Recognizer for CallState.

Parameters:: handle - candidate
Returns:: true if handle is an call state

isAObjectFlowState

public boolean isAObjectFlowState(Object handle)

Recognizer for ObjectFlowState.

Parameters:: handle - candidate
Returns:: true if handle is an objectflow state

isASubactivityState

public boolean isASubactivityState(Object handle)

Recognizer for SubactivityState.

Parameters:: handle - candidate
Returns:: true if handle is an subactivity state

isAActor

public boolean isAActor(Object handle)

Recognizer for Actor.

Parameters:: handle - candidate
Returns:: true if handle is an Actor

isAAggregationKind

public boolean isAAggregationKind(Object handle)

Recognizer for AggregationKind.

Parameters:: handle - candidate
Returns:: true if handle is an AggregationKind

isAAssociation

public boolean isAAssociation(Object handle)

Recognizer for Association.

Parameters:: handle - candidate
Returns:: true if handle is an Association

isAAssociationEnd

public boolean isAAssociationEnd(Object handle)

Recognizer for AssociationEnd.

Parameters:: handle - candidate
Returns:: true if handle is an AssociationEnd

isAAssociationRole

public boolean isAAssociationRole(Object handle)

Recognizer for AssociationRole.

Parameters:: handle - candidate
Returns:: true if handle is an AssociationRole

isAAssociationEndRole

public boolean isAAssociationEndRole(Object handle)

Recognizer for AssociationEndRole.

Parameters:: handle - candidate
Returns:: true if handle is an AssociationEndRole

isAAttribute

public boolean isAAttribute(Object handle)

Recognizer for Attribute.

Parameters:: handle - candidate
Returns:: true if handle is an Attribute

isAsynchronous

public boolean isAsynchronous(Object handle)

Recognizer for asynchronisity of an action.

Parameters:: handle - candidate
Returns:: true if the argument is asynchronous

isAbstract

public boolean isAbstract(Object handle)

Recognizer for abstract classes and operations.

Parameters:: handle - candidate
Returns:: true if handle is abstract.

isAActivityGraph

public boolean isAActivityGraph(Object handle)

Recognizer for ActivityGraph.

Parameters:: handle - candidate
Returns:: true if handle is ActivityGraph.

isABase

public boolean isABase(Object handle)

Deprecated. use isAModelElement or a more specific recognizer for all new code

Recognizer for an object that is some form of an element in the model. MBase was the Novosoft term.

Parameters:: handle - candidate
Returns:: true if handle is a base.

isABehavioralFeature

public boolean isABehavioralFeature(Object handle)

Recognizer for behavioral features.

Parameters:: handle - candidate
Returns:: true if handle is a behavioral feature

isACallAction

public boolean isACallAction(Object handle)

Recognizer for CallAction.

Parameters:: handle - candidate
Returns:: true if handle is a CallAction

isACallEvent

public boolean isACallEvent(Object handle)

Recognizer for CallEvent.

Parameters:: handle - candidate
Returns:: true if handle is a CallEvent

isAChangeEvent

public boolean isAChangeEvent(Object handle)

Recognizer for ChangeEvent.

Parameters:: handle - candidate
Returns:: true if handle is a ChangeEvent

isAClass

public boolean isAClass(Object handle)

Recognizer for Class.

Parameters:: handle - candidate
Returns:: true if handle is a Class

isAAssociationClass

public boolean isAAssociationClass(Object handle)

Recognizer for AssociationClass.

Parameters:: handle - candidate
Returns:: true if handle is an AssociationClass

isAClassifierAndARelationship

public boolean isAClassifierAndARelationship(Object handle)

Recognizer for a Element that is Classifier and RelationShip. TODO: Does this really belong here? Is it commonly used? If it really belongs here it is not a recognizer so it should be renamed to isClassifierAndRelationship. (comment by Bob from MDR impl - tfm)

Parameters:: handle - candidate
Returns:: true if handle is a Classifier and a Relationship

isAClassifier

public boolean isAClassifier(Object handle)

Recognizer for Classifier.

Parameters:: handle - candidate
Returns:: true if handle is a Classifier

isAClassifierInState

public boolean isAClassifierInState(Object handle)

Recognizer for ClassifierInState.

Parameters:: handle - candidate
Returns:: true if handle is a ClassifierInState

isAClassifierRole

public boolean isAClassifierRole(Object handle)

Recognizer for ClassifierRole.

Parameters:: handle - candidate
Returns:: true if handle is a ClassifierRole

isAComment

public boolean isAComment(Object handle)

Recognizer for Comment.

Parameters:: handle - candidate
Returns:: true if handle is a Comment

isACollaboration

public boolean isACollaboration(Object handle)

Recognizer for Collaboration.

Parameters:: handle - candidate
Returns:: true if handle is a Collaboration

isAComponent

public boolean isAComponent(Object handle)

Recognizer for Component.

Parameters:: handle - candidate
Returns:: true if handle is a Component

isAComponentInstance

public boolean isAComponentInstance(Object handle)

Recognizer for ComponentInstance.

Parameters:: handle - candidate
Returns:: true if handle is a ComponentInstance

isAConstraint

public boolean isAConstraint(Object handle)

Recognizer for Constraint.

Parameters:: handle - candidate
Returns:: true if handle is a Constraint

isACreateAction

public boolean isACreateAction(Object handle)

Recognizer for CreateAction.

Parameters:: handle - candidate
Returns:: true if handle is a CreateAction

isADataType

public boolean isADataType(Object handle)

Recognizer for DataType.

Parameters:: handle - candidate
Returns:: true if handle is a DataType

isADataValue

public boolean isADataValue(Object handle)

Recognizer for DataValue.

Parameters:: handle - candidate
Returns:: true if handle is a DataValue

isADependency

public boolean isADependency(Object handle)

Recognizer for Dependency.

Parameters:: handle - candidate
Returns:: true if handle is a Dependency

isADestroyAction

public boolean isADestroyAction(Object handle)

Recognizer for DestroyAction.

Parameters:: handle - candidate
Returns:: true if handle is a DestroyAction

isACompositeState

public boolean isACompositeState(Object handle)

Recognizer for CompositeState.

Parameters:: handle - candidate
Returns:: true if handle is a CompositeState

isAElement

public boolean isAElement(Object handle)

Recognizer for Element.

Parameters:: handle - candidate
Returns:: true if handle is an Element

isAElementImport

public boolean isAElementImport(Object handle)

Recognizer for ElementImport.

Parameters:: handle - candidate
Returns:: true if handle is an ElementImport

isAElementResidence

public boolean isAElementResidence(Object handle)

Recognizer for ElementResidence.

Parameters:: handle - candidate
Returns:: true if handle is an ElementResidence

isAEnumeration

public boolean isAEnumeration(Object handle)

Recognizer for UML Enumeration.

Parameters:: handle - candidate
Returns:: true if handle is an UML Enumeration

isAEnumerationLiteral

public boolean isAEnumerationLiteral(Object handle)

Recognizer for UML EnumerationLiteral

Parameters:: handle - the candidate
Returns:: true if handle is an UML EnumerationLiteral

isAEvent

public boolean isAEvent(Object handle)

Recognizer for Event.

Parameters:: handle - candidate
Returns:: true if handle is an Event

isAException

public boolean isAException(Object handle)

Recognizer for Exception.

Parameters:: handle - candidate
Returns:: true if handle is an Exception

isAExpression

public boolean isAExpression(Object handle)

Recognizer for Expression.

Parameters:: handle - candidate
Returns:: true if handle is an Expression

isAExtend

public boolean isAExtend(Object handle)

Recognizer for Extend.

Parameters:: handle - candidate
Returns:: true if handle is an Extend

isAExtensionPoint

public boolean isAExtensionPoint(Object handle)

Recognizer for ExtensionPoint.

Parameters:: handle - candidate
Returns:: true if handle is an ExtensionPoint

isAFeature

public boolean isAFeature(Object handle)

Recognizer for Feature.

Parameters:: handle - candidate
Returns:: true if handle is a Feature

isAFinalState

public boolean isAFinalState(Object handle)

Recognizer for FinalState.

Parameters:: handle - candidate
Returns:: true if handle is a FinalState

isAFlow

public boolean isAFlow(Object handle)

Recognizer for Flow.

Parameters:: handle - candidate
Returns:: true if handle is a Flow

isAGuard

public boolean isAGuard(Object handle)

Recognizer for Guard.

Parameters:: handle - candidate
Returns:: true if handle is a Guard

isAGeneralizableElement

public boolean isAGeneralizableElement(Object handle)

Recognizer for GeneralizableElement.

Parameters:: handle - candidate
Returns:: true if handle is a GeneralizableElement

isAGeneralization

public boolean isAGeneralization(Object handle)

Recognizer for GeneralizableElement.

Parameters:: handle - candidate
Returns:: true if handle is a GeneralizableElement

isAInclude

public boolean isAInclude(Object handle)

Recognizer for Include.

Parameters:: handle - candidate
Returns:: true if handle is an Include

isAInstance

public boolean isAInstance(Object handle)

Recognizer for Instance.

Parameters:: handle - candidate
Returns:: true if handle is a Instance

isAInteraction

public boolean isAInteraction(Object handle)

Recognizer for Interaction.

Parameters:: handle - candidate
Returns:: true if handle is a Interaction

isAInterface

public boolean isAInterface(Object handle)

Recognizer for Interface.

Parameters:: handle - candidate
Returns:: true if handle is a Interface

isALink

public boolean isALink(Object handle)

Recognizer for Link.

Parameters:: handle - candidate
Returns:: true if handle is a Link

isALinkEnd

public boolean isALinkEnd(Object handle)

Recognizer for LinkEnd.

Parameters:: handle - candidate
Returns:: true if handle is a LinkEnd

isAMessage

public boolean isAMessage(Object handle)

Recognizer for Message.

Parameters:: handle - candidate
Returns:: true if handle is a Method

isAMethod

public boolean isAMethod(Object handle)

Recognizer for Method.

Parameters:: handle - candidate
Returns:: true if handle is a Method

isAModel

public boolean isAModel(Object handle)

Recognizer for Model.

Parameters:: handle - candidate
Returns:: true if handle is a Model

isAModelElement

public boolean isAModelElement(Object handle)

Recognizer for ModelElement.

Parameters:: handle - candidate
Returns:: true if handle is a ModelElement

isAMultiplicity

public boolean isAMultiplicity(Object handle)

Recognizer for Multiplicity.

Parameters:: handle - candidate
Returns:: true if handle is a Multiplicity

isAMultiplicityRange

public boolean isAMultiplicityRange(Object handle)

Recognizer for MultiplicityRange.

Parameters:: handle - candidate
Returns:: true if handle is a MultiplicityRange

isANamespace

public boolean isANamespace(Object handle)

Recognizer for Namespace.

Parameters:: handle - candidate
Returns:: true if handle is a Namespace

isANaryAssociation

public boolean isANaryAssociation(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

public boolean isANode(Object handle)

Recognizer for a Node.

Parameters:: handle - candidate
Returns:: true if handle is a Node

isANodeInstance

public boolean isANodeInstance(Object handle)

Recognizer for a NodeInstance.

Parameters:: handle - candidate
Returns:: true if handle is a NodeInstance

isAOperation

public boolean isAOperation(Object handle)

Recognizer for Operation.

Parameters:: handle - candidate
Returns:: true if handle is an Operation

isAObject

public boolean isAObject(Object handle)

Recognizer for Object.

Parameters:: handle - candidate
Returns:: true if handle is an Object

isAParameter

public boolean isAParameter(Object handle)

Recognizer for Parameter.

Parameters:: handle - candidate
Returns:: true if handle is a Parameter

isAPartition

public boolean isAPartition(Object handle)

Recognizer for Partition.

Parameters:: handle - candidate
Returns:: true if handle is a Partition

isAPermission

public boolean isAPermission(Object handle)

Recognizer for Permission.

Parameters:: handle - candidate
Returns:: true if handle is an Permission

isAPackage

public boolean isAPackage(Object handle)

Recognizer for Package.

Parameters:: handle - candidate
Returns:: true if handle is a Package

isAPseudostate

public boolean isAPseudostate(Object handle)

Recognizer for Pseudostate.

Parameters:: handle - candidate
Returns:: true if handle is a Pseudostate

isAPseudostateKind

public boolean isAPseudostateKind(Object handle)

Recognizer for PseudostateKind.

Parameters:: handle - candidate
Returns:: true if handle is a PseudostateKind

getPseudostateKind

public Object getPseudostateKind(Object handle)

Returns the Kind of a Pseudostate. TODO: - Do we need this as well as getKind - I think not

Parameters:: handle - the Pseudostate
Returns:: the Kind

getKind

public Object getKind(Object handle)

Returns the Kind of a Pseudostate or Parameter.

Parameters:: handle - the Pseudostate or Parameter
Returns:: the Kind

getReceiver

public Object getReceiver(Object handle)

Returns the receiver object of a message or stimulus.

Parameters:: handle - candidate
Returns:: receiver

getLink

public Object getLink(Object handle)

Returns the Link belonging to the given LinkEnd.

Parameters:: handle - the LinkEnd
Returns:: the Link

equalsPseudostateKind

public boolean equalsPseudostateKind(Object ps1,
                                     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

public boolean isAReception(Object handle)

Recognizer for Reception.

Parameters:: handle - candidate
Returns:: true if handle is a Reception

isAReturnAction

public boolean isAReturnAction(Object handle)

Recognizer for Returnaction.

Parameters:: handle - candidate
Returns:: true if handle is a returnaction

isARelationship

public boolean isARelationship(Object handle)

Recognizer for Relationship.

Parameters:: handle - candidate
Returns:: true if handle is a Relationship

isASendAction

public boolean isASendAction(Object handle)

Recognizer for SendAction.

Parameters:: handle - candidate
Returns:: true if handle is a SendAction

isASignal

public boolean isASignal(Object handle)

Recognizer for Signal.

Parameters:: handle - candidate
Returns:: true if handle is a Signal

isASignalEvent

public boolean isASignalEvent(Object handle)

Recognizer for SignalEvent.

Parameters:: handle - candidate
Returns:: true if handle is a SignalEvent

isASimpleState

public boolean isASimpleState(Object handle)

Recognizer for SimpleState.

Parameters:: handle - candidate
Returns:: true if handle is a StateMachine

isAStateMachine

public boolean isAStateMachine(Object handle)

Recognizer for StateMachine.

Parameters:: handle - candidate
Returns:: true if handle is a StateMachine

isAStimulus

public boolean isAStimulus(Object handle)

Recognizer for stimulus.

Parameters:: handle - candidate
Returns:: true if handle is a stimulus

isAStateVertex

public boolean isAStateVertex(Object handle)

Recognizer for StateVertex.

Parameters:: handle - candidate
Returns:: true if handle is a StateVertex

isAStereotype

public boolean isAStereotype(Object handle)

Recognizer for Stereotype.

Parameters:: handle - candidate
Returns:: true if handle is a Stereotype

isAStructuralFeature

public boolean isAStructuralFeature(Object handle)

Recognizer for StructuralFeature.

Parameters:: handle - candidate
Returns:: true if handle is a StructuralFeature

isAState

public boolean isAState(Object handle)

Recognizer for State.

Parameters:: handle - candidate
Returns:: true if handle is a State

isAStubState

public boolean isAStubState(Object handle)

Recognizer for StubState.

Parameters:: handle - candidate
Returns:: true if handle is a StubState

isASubmachineState

public boolean isASubmachineState(Object handle)

Recognizer for SubmachineState.

Parameters:: handle - candidate
Returns:: true if handle is a SubmachineState

isASubsystem

public boolean isASubsystem(Object handle)

Recognizer for Subsystem.

Parameters:: handle - candidate
Returns:: true if handle is a Subsystem

isASynchState

public boolean isASynchState(Object handle)

Recognizer for SynchState.

Parameters:: handle - candidate
Returns:: true if handle is a SynchState

isATaggedValue

public boolean isATaggedValue(Object handle)

Recognizer for TaggedValue.

Parameters:: handle - candidate
Returns:: true if handle is a TaggedValue

isATerminateAction

public boolean isATerminateAction(Object handle)

Recognizer for TerminateAction.

Parameters:: handle - candidate
Returns:: true if handle is a TerminateAction

isATransition

public boolean isATransition(Object handle)

Recognizer for Transition.

Parameters:: handle - candidate
Returns:: true if handle is a Transition

isATimeEvent

public boolean isATimeEvent(Object handle)

Recognizer for TimeEvent.

Parameters:: handle - candidate
Returns:: true if handle is a TimeEvent

isAUninterpretedAction

public boolean isAUninterpretedAction(Object handle)

Recognizer for UninterpretedAction.

Parameters:: handle - candidate
Returns:: true if handle is a UninterpretedAction

isAUsage

public boolean isAUsage(Object handle)

Recognizer for Usage.

Parameters:: handle - candidate
Returns:: true if handle is a Usage

isAUseCase

public boolean isAUseCase(Object handle)

Recognizer for a Use Case.

Parameters:: handle - candidate
Returns:: true if handle is a Transition

isAVisibilityKind

public boolean isAVisibilityKind(Object handle)

Recognizer for VisibilityKind.

Parameters:: handle - candidate
Returns:: true if handle is a VisibilityKind

isActive

public boolean isActive(Object handle)

Recognizer for Classes that are Active.

Parameters:: handle - candidate
Returns:: true if Class is Active

isChangeable

public boolean isChangeable(Object handle)

Recognizer for attributes that are changeable.

Parameters:: handle - candidate
Returns:: true if handle is changeable

isClassifierScope

public boolean isClassifierScope(Object handle)

Recognizer for attributes with classifier scope.

Parameters:: handle - candidate
Returns:: true if handle has classifier scope.

isConcurrent

public boolean isConcurrent(Object handle)

Recognizer for concurrent composite state.

Parameters:: handle - composite state
Returns:: true if concurent.

isAConcurrentRegion

public boolean isAConcurrentRegion(Object handle)

Recognizer for ConcurrentRegion.

Parameters:: handle - candidate
Returns:: true if handle is a ConcurrentRegion

isConstructor

public boolean isConstructor(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

public boolean isFrozen(Object handle)

Returns true if the given element is Frozen.

Parameters:: handle - candidate
Returns:: boolean true if Frozen

isComposite

public boolean isComposite(Object handle)

Returns true if a given associationend is a composite.

Parameters:: handle - candidate
Returns:: boolean

isAggregate

public boolean isAggregate(Object handle)

Returns true if a given associationend is a composite.

Parameters:: handle - candidate
Returns:: boolean

isInitialized

public boolean isInitialized(Object handle)

Recognizer for attributes that are initialized.

Parameters:: handle - candidate
Returns:: true if the attribute is initialized.

isInstanceScope

public boolean isInstanceScope(Object handle)

Recognizer for attributes with instance scope.

Parameters:: handle - candidate
Returns:: true if handle has instance scope.

isInternal

public boolean isInternal(Object handle)

Recognizer for internal transitions.

Parameters:: handle - candidate
Returns:: true if handle is an internal transition.

isLeaf

public boolean isLeaf(Object handle)

Recognizer for leafs.

Parameters:: handle - candidate GeneralizableElement
Returns:: true if handle is a leaf

isRoot

public boolean isRoot(Object handle)

Recognizer for roots.

Parameters:: handle - candidate GeneralizableElement
Returns:: true if handle is a leaf

isSpecification

public boolean isSpecification(Object handle)

Recognizer for specifications.

Parameters:: handle - candidate ModelElement
Returns:: true if handle is a specification

isNavigable

public boolean isNavigable(Object handle)

Recognizer for Navigable elements.

Parameters:: handle - candidate
Returns:: true if handle is navigable

isPrimaryObject

public boolean isPrimaryObject(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 when importing some other object are not.

Parameters:: handle - candidate
Returns:: true if primary object.

isPackage

public boolean isPackage(Object handle)

Recognizer for attributes 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

public boolean isPrivate(Object handle)

Recognizer for attributes with private.

Parameters:: handle - candidate
Returns:: true if handle has private

isPublic

public boolean isPublic(Object handle)

Recognizer for attributes with public.

Parameters:: handle - candidate
Returns:: true if handle has public

isQuery

public boolean isQuery(Object handle)

Recognizer for MBehaviouralFeature's that are queries.

Parameters:: handle - candidate
Returns:: true if it is a query

isProtected

public boolean isProtected(Object handle)

Recognizer for attributes with protected.

Parameters:: handle - candidate
Returns:: true if handle has protected

isRealize

public boolean isRealize(Object handle)

Recognizer for realize.

Parameters:: handle - candidate
Returns:: true if handle has a realize stereotype

isReturn

public boolean isReturn(Object handle)

Recognizer for return.

Parameters:: handle - candidate parameter
Returns:: true if handle is a return parameter.

isSingleton

public boolean isSingleton(Object handle)

Recognizer for singleton.

Parameters:: handle - candidate
Returns:: true if handle is a singleton.

isStereotype

public boolean isStereotype(Object handle,
                            String stereotypename)

Recognizer for model elements 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

public boolean isTop(Object handle)

Returns true if the given CompositeState is the top state.

Parameters:: handle - CompositeState
Returns:: boolean true if top state

isType

public boolean isType(Object handle)

Recognizer for type.

Parameters:: handle - candidate
Returns:: true if handle is a type.

isUtility

public boolean isUtility(Object handle)

Recognizer for utility.

Parameters:: handle - candidate
Returns:: true if handle is a utility.

getAssociation

public Object getAssociation(Object handle)

Returns the association connected to an association end or the association belonging to the given link.

Parameters:: handle - is the link
Returns:: association end

getAssociationEnd

public Object getAssociationEnd(Object handle,
                                Object assoc)

Returns the association end between some classifier and some associaton.

Parameters:: handle - is the classifier; assoc - is the association
Returns:: association end

getAssociationEnds

public Collection getAssociationEnds(Object handle)

The list of Association Ends.

Parameters:: handle - the object that we get the association ends from.
Returns:: Collection with association ends.

getAssociationRoles

public Collection getAssociationRoles(Object handle)

The list of association roles.

Parameters:: handle - the object that we get the association roles from.
Returns:: Collection of association roles.

getAttributes

public Collection getAttributes(Object handle)

The list of Attributes.

Parameters:: handle - classifier to examine.
Returns:: iterator with attributes.

getBaseClass

public Object getBaseClass(Object handle)

Deprecated. use getBaseClasses for UML 1.4 and later

The baseclass of some stereotype.

Parameters:: handle - the stereotype
Returns:: the baseclass

getBaseClasses

public Collection getBaseClasses(Object handle)

Collection of baseclasses of some stereotype.

Parameters:: handle - the stereotype
Returns:: collection containing all applicable baseclasses

getBase

public Object getBase(Object handle)

The base of some model element.

Parameters:: handle - the model element
Returns:: the base

getBases

public Collection getBases(Object handle)

Get the bases of a classifier role.

Parameters:: handle - classifier role.
Returns:: the bases.

getBehaviors

public Collection getBehaviors(Object handle)

Get the StateMachines which define the behaviors of a Modelelement.

Parameters:: handle - modelelement to examine.
Returns:: collection of StateMachines.

getBehavioralFeature

public Object getBehavioralFeature(Object handle)

Get the behavioral feature of an parameter.

Parameters:: handle - expression.
Returns:: the behavioral feature.

getBody

public Object getBody(Object handle)

Get the body of an method/constraint/expression/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

public int getBound(Object handle)

Return the Synch State's bound.

Parameters:: handle - the synch State
Returns:: bound

getChangeability

public Object getChangeability(Object handle)

Return Changeability of a StructuralFeature or a AssociationEnd.

Parameters:: handle - the StructuralFeature or AssociationEnd
Returns:: the Changeability

getChild

public Object getChild(Object handle)

Get the child of a generalization.

Parameters:: handle - generalization.
Returns:: the child.

getChildren

public Collection getChildren(Object handle)

Get the children of some generalizable element.

Parameters:: handle - to the generalizable element.
Returns:: a collection with all children.

getClassifierRoles

public Collection getClassifierRoles(Object handle)

Gets the classifiers roles of some model element.

Parameters:: handle - the model element
Returns:: the classifiers roles of the instance

getClassifier

public Object getClassifier(Object handle)

Get the classifier of an Association End.

Parameters:: handle - The Association End to get from.
Returns:: The classifier of the Association End.

getClassifiers

public Collection getClassifiers(Object handle)

Gets the classifierss of some instance.

Parameters:: handle - the instance
Returns:: the classifierss of the instance

getClassifiersInState

public Collection getClassifiersInState(Object handle)

Gets the classifiers in state of some model element.

Parameters:: handle - the model element
Returns:: the classifierss in state

getClients

public Collection getClients(Object handle)

Gets the clients of some dependency.

Parameters:: handle - the dependency
Returns:: the clients of the dependency

getClientDependencies

public Collection getClientDependencies(Object handle)

Get the client dependencies of some classifier.

Parameters:: handle - to the classifier.
Returns:: an iterator with all client dependencies.

getCondition

public Object getCondition(Object handle)

Get the condition of an extend.

Parameters:: handle - The extend.
Returns:: the condition

getConcurrency

public Object getConcurrency(Object handle)

Get the concurrency of an operation.

Parameters:: handle - The operation.
Returns:: the concurrency.

getConnections

public Collection getConnections(Object handle)

The list of connections to an association or link.

Parameters:: handle - to the association or link
Returns:: a Collection with all connections.

getEffect

public Object getEffect(Object handle)

Returns the effect of some transition.

Parameters:: handle - is the transition
Returns:: the effect

getElementResidences

public Collection getElementResidences(Object handle)

Get the residences of an element.

Parameters:: handle - the model element that we are getting the residences of
Returns:: the residence collection

getElementImports2

public Collection getElementImports2(Object handle)

Returns the ElementImports of this ModelElement.

Parameters:: handle - the ModelElement
Returns:: the collection of ElementImports

getEntry

public Object getEntry(Object handle)

Returns the entry action to a state.

Parameters:: handle - is the state
Returns:: the entry

getEnumeration

public Object getEnumeration(Object handle)

Returns the Enumeration of an EnumerationLiteral.

Parameters:: handle - the enumerationliteral
Returns:: the enumeration

getEnumerationLiterals

public List getEnumerationLiterals(Object handle)

Returns the enumeration literals of a UML Enumeration.

Parameters:: handle - is the Enumeration
Returns:: Collection the Enumeration literals.

getExit

public Object getExit(Object handle)

Returns the exit action to a state.

Parameters:: handle - is the state
Returns:: the exit action

getExpression

public Object getExpression(Object handle)

Get the Expression belonging to a Guard, ChangeEvent or timeEvent.

Parameters:: handle - the Object to get the Expression from
Returns:: Object the Expression

getExtendedElements

public Collection getExtendedElements(Object handle)

Return all extended elements in the current repository for the given stereotype.

Parameters:: handle - stereotype for which to return extended elements
Returns:: collection of model elements extended by given stereotype

getExtends

public Collection getExtends(Object handle)

Returns all extends of a use case or extension point.

Parameters:: handle - is the use case or the extension point
Returns:: the extends

getExtends2

public Collection getExtends2(Object handle)

Returns all extends of a use case.

Parameters:: handle - is the use case
Returns:: the extends

getExtension

public Object getExtension(Object handle)

Gets the use case extension of an extend.

Parameters:: handle - is the extend
Returns:: The extension

getExtensionPoint

public Object getExtensionPoint(Object handle,
                                int index)

Returns the Extensionpoint at given index-number.

Parameters:: handle - Extend; index - int
Returns:: ExtensionPoint

getExtensionPoints

public Collection getExtensionPoints(Object handle)

Returns all extends of a use case.

Parameters:: handle - is the use case or the extend
Returns:: the extends

getFeatures

public Collection getFeatures(Object handle)

The list of Features from a Classifier.

Parameters:: handle - Classifier to retrieve from.
Returns:: Collection with Features

getGeneralization

public Object getGeneralization(Object handle,
                                Object parent)

Gets the generalization between two generalizable elements. Returns null if there is none.

Parameters:: handle - is the child; parent - is the parent
Returns:: The generalization

getGeneralizations

public Collection getGeneralizations(Object handle)

The list of Generalizations from a GeneralizableElement.

Parameters:: handle - GeneralizableElement to retrieve from.
Returns:: Generalizations

getGuard

public Object getGuard(Object handle)

Gets the guard for some given transition.

Parameters:: handle - is the transition
Returns:: Object

getIcon

public Object getIcon(Object handle)

Returns the Icon of a Stereotype.

Parameters:: handle - the Stereotype to get the Icon from
Returns:: the Icon

getImplementationLocation

public Object getImplementationLocation(Object handle)

Deprecated. use getContainer

Gets the component of some element residence.

Parameters:: handle - is an element residence
Returns:: component

getIncludes

public Collection getIncludes(Object handle)

Returns the includers for some use case.

Note: Changes from getIncludes in UML 1.3 to getIncluders in UML 1.4.

Parameters:: handle - is the use case
Returns:: the includes as a Collection

getIncludes2

public Collection getIncludes2(Object handle)

Returns the includes for some use case.

Note:Changes from getIncludes2 in UML 1.3 to getIncludes in UML 1.4.

Parameters:: handle - is the use case
Returns:: the includes as a Collection

getIncomings

public Collection getIncomings(Object handle)

Returns the incoming transitions for some statevertex.

Parameters:: handle - is the state vertex
Returns:: Collection

getInitialValue

public Object getInitialValue(Object handle)

Returns the initial value for some attribute.

Parameters:: handle - is the attribute
Returns:: initial value

getInstance

public Object getInstance(Object handle)

Returns the instance of an AttributeLink or LinkEnd.

Parameters:: handle - is the attribute link or link end
Returns:: initial value

getInstances

public Collection getInstances(Object handle)

Returns the Instances for some Clasifier.

Parameters:: handle - is the classifier
Returns:: Collection

getInStates

public Collection getInStates(Object handle)

Returns the collection of States for some ClasifierInState.

Parameters:: handle - is the classifierInState
Returns:: Collection

getInteraction

public Object getInteraction(Object handle)

Returns the interaction for some message.

Parameters:: handle - is the message
Returns:: the interaction

getInteractions

public Collection getInteractions(Object handle)

Returns the interactions belonging to a collaboration.

Parameters:: handle - is the collaboration
Returns:: Collection

getInternalTransitions

public Collection getInternalTransitions(Object handle)

Returns the internal transitions belonging to a state.

Parameters:: handle - is the state
Returns:: Collection

getMessages

public Collection getMessages(Object handle)

Returns the messages belonging to some interaction.

Parameters:: handle - candidate
Returns:: Collection

getMessages3

public Collection getMessages3(Object handle)

Returns the messages belonging to some other message.

Parameters:: handle - is the message
Returns:: Collection

getMessages4

public Collection getMessages4(Object handle)

Get the messages that are activated by the given message.

Parameters:: handle - Message
Returns:: the Collection of Messages

getMessages1

public Collection getMessages1(Object handle)

Returns the messages received by the given classifier role.

Parameters:: handle - is the classifier role
Returns:: Collection

getMessages2

public Collection getMessages2(Object handle)

Returns the messages send by the given classifier role.

Parameters:: handle - is the classifier role
Returns:: Collection

getModel

public Object getModel(Object handle)

Get the model of some model element.

Parameters:: handle - to the model element.
Returns:: model for the model element.

getModelElement

public Object getModelElement(Object handle)

Parameters:: handle - an Element Import or TaggedValue.
Returns:: the model element

getMultiplicity

public Object getMultiplicity(Object handle)

Get the Multiplicity from a model element.

Parameters:: handle - model element to retrieve from.
Returns:: multiplicity

getRanges

public Iterator getRanges(Object handle)

Get the Ranges from a Multiplicity.

Parameters:: handle - multiplicity to retrieve from.
Returns:: iterator containing ranges

getComments

public Collection getComments(Object handle)

Get the comments of an element.

Parameters:: handle - the model element that we are getting the comments of
Returns:: the comment (or null)

getAnnotatedElements

public Collection getAnnotatedElements(Object handle)

Get the modelelement that were commented.

Parameters:: handle - the comment that we are getting the model elements of
Returns:: the modelelements (or null)

getCommunicationConnection

public Object getCommunicationConnection(Object handle)

Get the communication connection of an message.

Parameters:: handle - the message that we are getting the communication connection
Returns:: the communication connection

getCommunicationLink

public Object getCommunicationLink(Object handle)

Get the communication link of a stimulus.

Parameters:: handle - the message that we are getting the communication link
Returns:: the communication link

getCollaborations

public Collection getCollaborations(Object handle)

Get the collaborations of an element.

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

getComponentInstance

public Object getComponentInstance(Object handle)

Get the component instance of an instance.

Parameters:: handle - is the instance
Returns:: the component instance

getConstrainingElements

public Collection getConstrainingElements(Object handle)

Returns the collection of ConstrainingElements of a Collaboration.

Parameters:: handle - the Collaboration
Returns:: the collection of ConstrainingElements

getConstrainedElements

public Collection getConstrainedElements(Object handle)

Returns the collection of ConstrainedElements of a constraint.

Parameters:: handle - the Constraint
Returns:: the collection of ConstrainedElements

getConstraints

public Collection getConstraints(Object handle)

Get the collection of all constraints of the given ModelElement.

Parameters:: handle - the ModelElement
Returns:: the collection of all constraints

getModelElementContainer

public Object getModelElementContainer(Object handle)

Returns 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

public List getModelElementContents(Object handle)

Returns 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

public List getModelElementAssociated(Object handle)

Returns 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

public Object getContainer(Object handle)

Returns 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

public Collection getContents(Object handle)

Returns the collection of ModelElements contained in a Partition.

Parameters:: handle - the Partition
Returns:: the contents of the Partition

getContext

public Object getContext(Object handle)

Returns the context of some given statemachine or the context of some given interaction.

Parameters:: handle - the statemachine or the interaction
Returns:: the context of the statemachine or interaction or null if the statemachine or interaction doesn't have a context.

getContexts

public Collection getContexts(Object handle)

Return the collection of the Contexts of a given Signal.

Parameters:: handle - the Signal
Returns:: a collection of the Contexts

getCreateActions

public Collection getCreateActions(Object handle)

Return the collection of Actions that create/instantiate the given Classifier.

Parameters:: handle - the Classifier
Returns:: a collection containing all the creating actions

getDefaultValue

public Object getDefaultValue(Object handle)

Get the default value of a parameter.

Parameters:: handle - the parameter that we are getting the defaultvalue from
Returns:: the default value

getDeferrableEvents

public Collection getDeferrableEvents(Object handle)

Get deferrable events of a state.

Parameters:: handle - the state that we are getting the deferrable event from
Returns:: the deferrable events collection

getDeployedComponents

public Collection getDeployedComponents(Object handle)

Returns the collection of components that are deployed inside the given node.

Parameters:: handle - the given node
Returns:: collection of components

getDeploymentLocations

public Collection getDeploymentLocations(Object handle)

Returns the context of some given statemachine or the context of some given interaction.

Parameters:: handle - the statemachine or the interaction
Returns:: the context of the statemachine or interaction or null if the statemachine or interaction doesn't have a context.

getDiscriminator

public Object getDiscriminator(Object handle)

Get the discriminator.

Parameters:: handle - the Generalization
Returns:: the discriminator a String

getDispatchAction

public Object getDispatchAction(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

public Object getDoActivity(Object handle)

Returns the do activity action of a state.

Parameters:: handle - is the state
Returns:: the do activity

getImportedElements

public Collection getImportedElements(Object pack)

The list of imported elements of the given package.

Parameters:: pack - package to retrieve from.
Returns:: A Collection with the imported elements.

getImportedElement

public Object getImportedElement(Object elementImport)

Returns the imported element from a ElementImport.

Parameters:: elementImport - the given ElementImport
Returns:: the ModelElement that was imported

getLinks

public Collection getLinks(Object handle)

Return the Links of a given Association.

Parameters:: handle - the Association
Returns:: the collection of Links

getLinkEnds

public Collection getLinkEnds(Object handle)

Return the LinkEnds of a given Instance or AssociationEnd.

Parameters:: handle - the candidate
Returns:: the collection of LinkEnds

getLocation

public String getLocation(Object handle)

Gets a location of some extension point.

Parameters:: handle - extension point
Returns:: the location

getMethods

public Collection getMethods(Object handle)

Get the methods of an operation.

Parameters:: handle - the operation that we are getting the methods of
Returns:: methods collection (or null)

getNamespace

public Object getNamespace(Object handle)

Get the namespace of an element.

Parameters:: handle - the model element that we are getting the namespace of
Returns:: the namespace (or null)

getNodeInstance

public Object getNodeInstance(Object handle)

Get the node instance of a component instance.

Parameters:: handle - the model element that we are getting the node instance of
Returns:: the node instance

getObjectFlowStates

public Collection getObjectFlowStates(Object handle)

The collection of object flow states.

Parameters:: handle - the classifier
Returns:: collection of object flow states

getOperation

public Object getOperation(Object handle)

Get the operation of a Call Action or Call Event.

Parameters:: handle - the model element that we are getting the operation of
Returns:: the Operation

getOccurrences

public Collection getOccurrences(Object handle)

Get the occurrences of an operation.

Parameters:: handle - the Opration
Returns:: the collection of occurrences

getOperations

public Collection getOperations(Object handle)

Get the list of operations.

Parameters:: handle - classifier to examine.
Returns:: Collection with operations.

getOppositeEnd

public Object getOppositeEnd(Object handle)

Returns the opposite end of an association end.

Parameters:: handle - is the association end
Returns:: Object the opposite end.

getOrdering

public Object getOrdering(Object handle)

Get ordering of an association end.

Parameters:: handle - association end to retrieve from
Returns:: ordering

getOutgoings

public Collection getOutgoings(Object handle)

Returns the list of Transitions outgoing from the given stateVertex.

Parameters:: handle - statevertex
Returns:: Collection

getOtherAssociationEnds

public Collection getOtherAssociationEnds(Object handle)

Get the list of Associations Ends connected to this association end.

Parameters:: handle - association end to start from
Returns:: A Collection with all connected association ends.

getOtherLinkEnds

public Collection getOtherLinkEnds(Object handle)

Get the list of Link Ends connected to this link end.

Parameters:: handle - link end to start from
Returns:: A Collection with all connected link ends.

getOwnedElements

public Collection getOwnedElements(Object handle)

The list of owned elements of the the namespace.

Parameters:: handle - namespace to retrieve from.
Returns:: A Collection with the owned elements.

getOwnerScope

public Object getOwnerScope(Object handle)

Get the owner scope of a feature.

Parameters:: handle - feature
Returns:: owner scope

getPowertype

public Object getPowertype(Object handle)

Get the powertype of a generalization.

Parameters:: handle - generalization
Returns:: powertype

getPowertypeRanges

public Collection getPowertypeRanges(Object handle)

Get the powertype ranges of a classifier.

Parameters:: handle - classifier to retrieve from
Returns:: collection of poertype ranges

getPredecessors

public Collection getPredecessors(Object handle)

Get the predecessors of a message.

Parameters:: handle - message to retrieve from
Returns:: collection of predecessors

getQualifiers

public Collection getQualifiers(Object handle)

Get the qualified attributes of an association end.

Parameters:: handle - association end to retrieve from
Returns:: Collection with qualifiers.

hasReturnParameterDirectionKind

public boolean hasReturnParameterDirectionKind(Object handle)

Determine if the passed parameter has a RETURN direction kind.

Parameters:: handle - is the parameter
Returns:: true if it is a return direction kind

getPackage

public Object getPackage(Object handle)

Returns the Package that is connected by the given ElementImport.

Parameters:: handle - the ElementImport
Returns:: the Package

getParameter

public Object getParameter(Object handle,
                           int n)

Get a parameter of a behavioral feature.

Parameters:: handle - behavioral feature to retrieve from; n - parameter number
Returns:: parameter.

getParameters

public Collection getParameters(Object handle)

Get the parameters of a Object Flow State, Behavioral Feature, Classifier or Event.

Parameters:: handle - operation to retrieve from
Returns:: A Collection with the parameters.

getParent

public Object getParent(Object handle)

Get the parent of a generalization.

Parameters:: handle - generalization.
Returns:: the parent.

getRaisedSignals

public Collection getRaisedSignals(Object handle)

Returns the raised signals of an operation.

Parameters:: handle - is the operation
Returns:: raised signals

getReceptions

public Collection getReceptions(Object handle)

Returns the receptions of a signal.

Parameters:: handle - is the signal
Returns:: receptions

getRecurrence

public Object getRecurrence(Object handle)

Returns the recurrence iteration expression of an action.

Parameters:: handle - is the action.
Returns:: the recurrence

getRepresentedClassifier

public Object getRepresentedClassifier(Object handle)

Returns the represented classifier of a collaboration.

Parameters:: handle - is the collaboration
Returns:: represented classifier

getRepresentedOperation

public Object getRepresentedOperation(Object handle)

Returns the represented operation of a collaboration.

Parameters:: handle - is the collaboration
Returns:: represented operation

getScript

public Object getScript(Object handle)

Returns the script belonging to a given action.

Parameters:: handle - is the action
Returns:: the script

getSender

public Object getSender(Object handle)

Returns the sender object of a stimulus or a message.

Parameters:: handle - is the stimulus or message
Returns:: the sender

getSignal

public Object getSignal(Object handle)

Returns the Signal of a SendAction, SignalEvent or Reception.

Parameters:: handle - is the object
Returns:: the signal

getResident

public Object getResident(Object handle)

Get the resident element.

Parameters:: handle - is the element residence
Returns:: resident element

getResidentElements

public Collection getResidentElements(Object handle)

Returns the collection of elements in a given component.

Parameters:: handle - the component
Returns:: the Collection of ResidentElements

getResidents

public Collection getResidents(Object handle)

Returns a collection with all residents belonging to the given node.

Parameters:: handle - is the node, nodeinstance, componentinstance
Returns:: Collection

getSource

public Object getSource(Object handle)

Gets the source for a given transition.

Parameters:: handle - is the transition
Returns:: Object (MStateVertex)

getSources

public Collection getSources(Object handle)

Gets the source for some given flow.

Parameters:: handle - is the flow
Returns:: Collection

getSourceFlows

public Collection getSourceFlows(Object handle)

Returns the sourceflows of a model element.

Parameters:: handle - is the model element
Returns:: a collection of sourceflows

getSpecializations

public Collection getSpecializations(Object handle)

The list of Specializations from a GeneralizableElement.

Parameters:: handle - GeneralizableElement to retrieve from.
Returns:: Collection of Specializations.

getStateMachine

public Object getStateMachine(Object handle)

Returns the state machine belonging to some given state or transition If you need to find the StateMachine for an internal transition, or for ANY state, use StateMachinesHelper.getStateMachine() instead.

Parameters:: handle - is the state or transition
Returns:: Object

getState

public Object getState(Object handle)

Returns the state belonging to some given transition.

Parameters:: handle - is the transition
Returns:: Object

getStates

public Collection getStates(Object handle)

Returns the states from a deferable event.

Parameters:: handle - is the event
Returns:: Object

getStereotypes

public Collection getStereotypes(Object handle)

Returns the stereotypes belonging to some given model element.

Note! For UML version 1.3 there can only be one stereotype per model element. This means that the returned Collection will only have zero or one elements. Don't write any code that rely on this! Consider it to be a Collection with zero or more elements as it will be in later UML versions.

Parameters:: handle - The model element.
Returns:: a Collection with all stereotypes or empty if none.

getStimuli

public Collection getStimuli(Object handle)

Returns the stimuli belonging to some given link.

Parameters:: handle - is the link
Returns:: Object

getStimuli2

public Collection getStimuli2(Object handle)

Returns the Stimuli that are received by the given Instance.

Parameters:: handle - the Instance
Returns:: the collection of stimuli

getStimuli3

public Collection getStimuli3(Object handle)

Returns the Stimuli that are send by the given Instance.

Parameters:: handle - the Instance
Returns:: the collection of stimuli

getSubvertices

public Collection getSubvertices(Object handle)

Returns a collection with all subvertices belonging to the given composite state.

Parameters:: handle - is the composite state
Returns:: Collection

getSubmachine

public Object getSubmachine(Object handle)

Returns the submachine of a submachine state.

Parameters:: handle - is the submachine state
Returns:: submachine

getSubmachineStates

public Collection getSubmachineStates(Object handle)

Returns the submachine of a submachine state.

Parameters:: handle - is the submachine state
Returns:: submachine

getSupplierDependencies

public Collection getSupplierDependencies(Object handle)

The list of SupplierDependencies from a ModelElement.

Parameters:: handle - model element.
Returns:: A Collection with the supplier dependencies.

getTop

public Object getTop(Object handle)

The top of a state machine.

Parameters:: handle - the state machine
Returns:: the top

getTransition

public Object getTransition(Object handle)

Get the transition of a guard or action.

Parameters:: handle - the guard or action
Returns:: the transition

getTrigger

public Object getTrigger(Object handle)

Get the trigger of a transition.

Parameters:: handle - the transition
Returns:: the trigger

getType

public Object getType(Object handle)

The type of a StructuralFeature, AssociationEnd, Parameter, ObjectFlowState, TagDefinition, TaggedValue or ClassifierInState.

Parameters:: handle - the StructuralFeature, AssociationEnd, Parameter, ObjectFlowState, TagDefinition, TaggedValue or ClassifierInState
Returns:: the type

getTypedValues

public Collection getTypedValues(Object handle)

Returns collection of TaggedValues typed by a TagDefinition

Parameters:: handle - the TagDefinition
Returns:: collection of TaggedValues

getTarget

public Object getTarget(Object handle)

Returns the target of some transition.

Parameters:: handle - is the transition
Returns:: Object

getTargetScope

public Object getTargetScope(Object handle)

Returns the target scope of some model element.

Parameters:: handle - is the model element
Returns:: Object

getTargetFlows

public Collection getTargetFlows(Object handle)

Returns the targetflows of a model element.

Parameters:: handle - is the model element
Returns:: a collection of targetflows

getUpper

public int getUpper(Object handle)

Returns the upper bound of the multiplicity of the given element (AssociationEnd, Multiplicity or MultiplicityRange). A value of -1 corresponds to the special UML value 'unlimited' represented graphically by '*'.

Parameters:: handle - is the model element
Returns:: int

getUseCase

public Object getUseCase(Object handle)

Returns the use case of an extension point.

Parameters:: handle - is the extension point
Returns:: a use case

getLower

public int getLower(Object handle)

Returns the lower bound of the multiplicity of the given element (AssociationEnd, Multiplicity or MultiplicityRange).

Parameters:: handle - is the model element
Returns:: int

getTransitions

public Collection getTransitions(Object handle)

Returns the transitions belonging to the given handle. The handle can be a statemachine or a composite state or an event. If it's a statemachine the transitions will be given back belonging to that statemachine. If it's a compositestate the internal transitions of that compositestate will be given back. If it's an event, all transitions triggered by this event will be given back.

Parameters:: handle - is the model element
Returns:: Collection

getStructuralFeatures

public Collection getStructuralFeatures(Object handle)

This method returns all attributes of a given Classifier.

Parameters:: handle - is the classifier you want to have the attributes for.
Returns:: a collection of the attributes

getSpecification

public String getSpecification(Object handle)

Returns the Specification of a given Reception or Operation. If you need the Specification of a Method, use the method in CoreHelper which returns an object instead of a string.

Parameters:: handle - the Reception or Operation
Returns:: String the Specification
See Also:: CoreHelper.getSpecification(Object)

getSpecifications

public Collection getSpecifications(Object handle)

Returns specifications for an AssociationEnd or for a Classifier it returns all Interfaces of which this class is a realization.

When returning Interfaces it follows all Abstraction depencies which have the "realize" Stereotype and returns the Interfaces at the far end.

Parameters:: handle - the class you want to have the interfaces for
Returns:: a collection of the Interfaces

getSuppliers

public Collection getSuppliers(Object handle)

Returns the suppliers of a dependency.

Parameters:: handle - is the dependency
Returns:: a collection of the suppliers

getAction

public Object getAction(Object handle)

Returns the action belonging to some message or argument.

Parameters:: handle - is the message or argument.
Returns:: the action

getActivator

public Object getActivator(Object handle)

Returns the activator belonging to some message.

Parameters:: handle - is the message
Returns:: the activator

getActualArguments

public Collection getActualArguments(Object handle)

Returns the actual arguments for a given action.

Parameters:: handle - is the action
Returns:: the actual arguments

getAddition

public Object getAddition(Object handle)

Returns an addition for a given include.

Parameters:: handle - is the include
Returns:: the addition

getAggregation

public Object getAggregation(Object handle)

Returns the AggregationKind of a given AssociationEnd.

Parameters:: handle - the AssociationEnd
Returns:: the AggregationKind

getAssociatedClasses

public Collection getAssociatedClasses(Object handle)

Returns all associated classes (classes connected by an Association) for some given classifier. Returns an empty collection if the given argument handle is not a classifier. The given parameter is included in the returned collection if it has a self-referencing association.

Parameters:: handle - is the classifier
Returns:: Collection

getName

public String getName(Object handle)

The name of a model element or some diagram part.

Parameters:: handle - that points out the object.
Returns:: the name

getOwner

public Object getOwner(Object handle)

Return the owner of a feature or its association end if it is a qualified attribute. Returns the stereotype that owns a TagDefinition.

Parameters:: handle - is the feature
Returns:: classifier from the repository.

getTag

public String getTag(Object handle)

Return the tag of a tagged value.

Parameters:: handle - The tagged value belongs to this.
Returns:: The found tag as a String.

getTaggedValues

public Iterator getTaggedValues(Object handle)

Return the tagged values iterator of a model element.

Parameters:: handle - The tagged values belong to this.
Returns:: The tagged values iterator

getTaggedValuesCollection

public Collection getTaggedValuesCollection(Object handle)

Returns the TaggedValues of a ModelElement.

Parameters:: handle - the ModelElement
Returns:: the Collection of TaggedValues

getTaggedValue

public Object getTaggedValue(Object handle,
                             String name)

Return the tagged value with a specific tag.

Parameters:: handle - The model element the tagged value belongs to.; name - The tag name.
Returns:: The found tag, null if not found

getTaggedValueValue

public String getTaggedValueValue(Object handle,
                                  String name)

Return the value of a tagged value with a specific tag.

Parameters:: handle - The model element that the tagged value belongs to.; name - The tag name.
Returns:: The value of the found tag. "" if not found.

getTagOfTag

public String getTagOfTag(Object handle)

Return the key (tag) of some tagged value. TODO: This does exactly the same as getTag(Object). Remove one of them.

Parameters:: handle - The tagged value.
Returns:: The found value as String.

getValue

public Object getValue(Object handle)

Returns the Value of some UML Object.

Parameters:: handle - Object
Returns:: Object the exact type depends on the handle type (String, Expression, Instance, TaggedValue...)

getValueOfTag

public String getValueOfTag(Object handle)

Return the value of some tagged value.

Parameters:: handle - The tagged value.
Returns:: The found value as String.

getReferenceValue

public Collection getReferenceValue(Object taggedValue)

Return the referenceValue collection for a taggedValue.

Parameters:: taggedValue - the tagged value to read from
Returns:: collection of referenceValues for the given TaggedValue

getDataValue

public Collection getDataValue(Object taggedValue)

Return the dataValue collection for a taggedValue.

Parameters:: taggedValue - taggedValue the tagged value to read from
Returns:: a collection of dataValues for the given TaggedValue

getUUID

public String getUUID(Object element)

Return the ID of this element. This is guaranteed to always return a value, but the uniqueness and stability of the ID may vary by implementation. The original implementation guaranteed universally unique (across time and space) identifiers which were also stable across reloads of an XMI file.

Parameters:: element - ModelElement to retrieve ID for.
Returns:: UUID

getVisibility

public Object getVisibility(Object handle)

Return the visibility of this element.

Parameters:: handle - a model element
Returns:: visibility

getPartitions

public Collection getPartitions(Object container)

Get the partitions from a container.

Parameters:: container - The container.
Returns:: The partitions (a collection).

getReferenceState

public String getReferenceState(Object o)

Return the Stub State's referenced state.

Parameters:: o - Stub State
Returns:: referenced state

lookupIn

public Object lookupIn(Object handle,
                       String name)

Returns a named object in the given object by calling it's lookup method.

Parameters:: handle - the object that we search through; name - of the model element
Returns:: found object, null otherwise

getUMLClassName

public String getUMLClassName(Object handle)

Returns the name of the UML Model class.

Parameters:: handle - The object to check.
Returns:: classname of modelelement

isAArgument

public boolean isAArgument(Object modelElement)

Recognizer for Arguments.

Parameters:: modelElement - candidate
Returns:: true if an argument.

getTipString

public String getTipString(Object modelElement)

Returns a tooltip that should be shown for the given model element.

Parameters:: modelElement - The model element for which to gerneate a tip
Returns:: the tip

toString

public String toString(Object modelElement)

Returns a textual representation of the given model element.

All implementations should return the same value as would be expected from the toString() method of the NSUML class MModelElement.

Parameters:: modelElement - The model element for which to convert to text
Returns:: the textual representation of the model element

getWhen

public Object getWhen(Object target)

Parameters:: target - The TimeEvent.
Returns:: TimeExpression

getChangeExpression

public Object getChangeExpression(Object target)

Parameters:: target - The ChangeEvent.
Returns:: BooleanExpression

isATagDefinition

public boolean isATagDefinition(Object handle)

Recognizer for TagDefinition. Implemented only in UML 1.4+ metamodels.

Parameters:: handle - candidate
Returns:: true if handle is a TagDefinition

getTagDefinitions

public Collection getTagDefinitions(Object handle)

Return the TagDefinitions for a StereoType.

Parameters:: handle - Stereotype to fetch TagDefinitions for
Returns:: collection of TagDefinitions

getTagDefinition

public Object getTagDefinition(Object handle)

Return the TagDefinition for a TaggedValue.

Parameters:: handle - TaggedValue to return TagDefinition for
Returns:: TagDefinition for given element