org.argouml.model
Interface CoreHelper

All Known Implementing Classes:

AbstractCoreHelperDecorator

public interface CoreHelper

The interface for the helper for Core.

isSubType

boolean isSubType(java.lang.Object type,
                  java.lang.Object subType)

Determine if a meta type is a subtype of another.

Parameters:

type - The parent metatype.

subType - The metatype to test for being a subtype.

Returns:

true is subType is a sub-type of type.

getAllSupertypes

java.util.Collection getAllSupertypes(java.lang.Object element)

Return all elements of which this GeneralizableElement is a direct or indirect subtype.

Note: This follows the Generalizations in UML, so the results do not include Interfaces which are connected to Classes by Realizations.

Parameters:

element - the GeneralizableElement you want to have the parents for

Returns:

a collection of the parents, each of which is a GeneralizableElement.

getSupertypes

java.util.Collection getSupertypes(java.lang.Object generalizableElement)

Return the immediate supertypes of a GeneralizableElement.

Parameters:

generalizableElement - the element you want to have the parents for

Returns:

a collection of the parents, each of which is a GeneralizableElement.

getAssociateEndsInh

java.util.Collection getAssociateEndsInh(java.lang.Object classifier)

Return all AssociationEnds of a given Classifier plus all AssociationEnds of all of the Classifier's supertypes.

Note: Until 0.24 this was documented as returning the opposite ends, but the implementation has returned the near ends since at least beginning of the MDR implementation (0.18).

Parameters:

classifier - the classifier for which to get the association ends

Returns:

a collection of the AssociationEnds

removeFeature

void removeFeature(java.lang.Object cls,
                   java.lang.Object feature)

Remove a Feature from a Classifier.

Parameters:

cls - the classifier

feature - the feature to be removed

removeLiteral

void removeLiteral(java.lang.Object enumeration,
                   java.lang.Object literal)

Remove an EnumerationLiteral from an Enumeration.

Parameters:

enumeration - the enumeration

literal - the literal to be removed

setOperations

void setOperations(java.lang.Object classifier,
                   java.util.List operations)

Replace all operations of the given classifier by the given list of operations.

Parameters:

classifier - the given classifier

operations - the new operations

setAttributes

void setAttributes(java.lang.Object classifier,
                   java.util.List attributes)

Replace all attributes of the given classifier by the given collection of attributes.

Parameters:

classifier - the classifier

attributes - an ordered list of new attributes

getAttributesInh

java.util.Collection getAttributesInh(java.lang.Object classifier)

Return all attributes of a given Classifier, including inherited.

Parameters:

classifier - the classifier you want to have the attributes for

Returns:

a collection of the attributes

getOperationsInh

java.util.Collection getOperationsInh(java.lang.Object classifier)

Return all operations of a given Classifier, including inherited.

Parameters:

classifier - the classifier you want to have the operations for

Returns:

a collection of the operations

getParents

java.util.Collection getParents(java.lang.Object generalizableElement)

Return the collection of all direct parents.

This function is additional operation number 1 for a GeneralizableElement from the UML1.4 standard.

Parameters:

generalizableElement - the given element

Returns:

a collection of GeneralizableElement

getReturnParameters

java.util.List getReturnParameters(java.lang.Object operation)

Return all return parameters for an Operation.

Parameters:

operation - is the operation.

Returns:

List of parameters of with direction kind of Return.

getSpecification

java.lang.Object getSpecification(java.lang.Object object)

Return the Operation which is the specification for a Method.

There is also a method in the Facade interface with the same name which may be what you want if you are looking for the specification of something other than a Method.

Parameters:

object - the method you want the realized operation of.

Returns:

an operation, or null.

See Also:

Facade.getSpecification(Object)

getSubtypes

java.util.Collection getSubtypes(java.lang.Object cls)

Return all Classifiers of which this class is a direct supertype.

Parameters:

cls - the class you want to have the children for

Returns:

a collection of the children, each of which is a GeneralizableElement.

getAllBehavioralFeatures

java.util.Collection getAllBehavioralFeatures(java.lang.Object element)

Return all behavioralfeatures found in this element and its children.

Parameters:

element - is the element

Returns:

Collection

getBehavioralFeatures

java.util.List getBehavioralFeatures(java.lang.Object classifier)

Return all behavioral features of a Classifier.

Parameters:

classifier - The classifier

Returns:

the list with all behavioral features of the classifier

getAllInterfaces

java.util.Collection getAllInterfaces(java.lang.Object ns)

Return all interfaces found in this namespace and in its children.

Parameters:

ns - the given namespace

Returns:

Collection with all interfaces found

getAllClasses

java.util.Collection getAllClasses(java.lang.Object ns)

Return all classes found in this namespace and in its children.

Parameters:

ns - is the namespace.

Returns:

Collection

getRealizedInterfaces

java.util.Collection getRealizedInterfaces(java.lang.Object cls)

Return all interfaces the given class realizes.

Parameters:

cls - the classifier

Returns:

Collection

getExtendedClassifiers

java.util.Collection getExtendedClassifiers(java.lang.Object element)

Return all classes that the given GeneralizableElement extends.

Parameters:

element - is the GeneralizableElement

Returns:

Collection

getGeneralization

java.lang.Object getGeneralization(java.lang.Object achild,
                                   java.lang.Object aparent)

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

Parameters:

achild - is the child GeneralizableElement.

aparent - is the parent GeneralizableElement.

Returns:

Generalization

getBody

java.lang.String getBody(java.lang.Object comment)

Gets the body of a comment.

Parameters:

comment - the comment

Returns:

the body of the comment

getFlows

java.util.Collection getFlows(java.lang.Object source,
                              java.lang.Object target)

Return all flows connecting from a source ModelElement to a target ModelElement.

Parameters:

source - is the source model element.

target - is the target model element.

Returns:

Collection

getExtendingElements

java.util.Collection getExtendingElements(java.lang.Object element)

Return all elements that extend a Class.

Parameters:

element - is the class (a GeneralizableElement)

Returns:

Collection

getExtendingClassifiers

java.util.Collection getExtendingClassifiers(java.lang.Object classifier)

Return all classifiers that extend a Classifier.

Parameters:

classifier - is the classifier.

Returns:

Collection

getAllComponents

java.util.Collection getAllComponents(java.lang.Object ns)

Return all components found in this namespace and in its children.

Parameters:

ns - is the namespace.

Returns:

Collection

getAllDataTypes

java.util.Collection getAllDataTypes(java.lang.Object ns)

Return all components found in this namespace and in its children.

Parameters:

ns - is the namespace

Returns:

Collection

getAllNodes

java.util.Collection getAllNodes(java.lang.Object ns)

Return all components found in this namespace and in its children.

Parameters:

ns - is the namespace

Returns:

Collection

getAssociatedClassifiers

java.util.Collection getAssociatedClassifiers(java.lang.Object aclassifier)

Gets all classifiers that are associated to the given classifier (have an association relationship with the classifier).

Parameters:

aclassifier - an Classifier

Returns:

Collection

getAssociations

java.util.Collection getAssociations(java.lang.Object from,
                                     java.lang.Object to)

Gets the associations between the classifiers from and to. Returns an empty collection if no Associations are found.

Parameters:

from - a classifier

to - a classifier

Returns:

a Collection with Associations

getAllClassifiers

java.util.Collection getAllClassifiers(java.lang.Object namespace)

Return all classifiers found in this namespace and in its children.

Parameters:

namespace - the given namespace

Returns:

Collection the collection of all classifiers found in the namespace

getAssociations

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

Return all associations for a Classifier.

Parameters:

oclassifier - the given classifier

Returns:

Collection all associations for the given classifier

getAssociationEnd

java.lang.Object getAssociationEnd(java.lang.Object type,
                                   java.lang.Object assoc)

Returns the associationend between a classifier and an associaton.

Parameters:

type - is the classifier

assoc - is the association

Returns:

An AssociationEnd.

getAllAttributes

java.util.Collection getAllAttributes(java.lang.Object classifier)

Return all Attributes of a Classifier and of its parents.

Parameters:

classifier - is the classifier

Returns:

Collection

getAllVisibleElements

java.util.Collection getAllVisibleElements(java.lang.Object ns)

Return a Set containing all ModelElements visible outside of the Namespace. This is an "Additional Operation" from the UML spec.

Parameters:

ns - the given namespace

Returns:

the collection with ModelElements

getSource

java.lang.Object getSource(java.lang.Object relationship)

Return the source of a relation or Link. The source of a relation is defined as the ModelElement that propagates this relation. If there are more then 1 sources, only the first is returned. If there is no source, null is returned. Examples of sources include classifiers that are types to associationends, usecases that are bases to extend and include relations and so on. A source is always the start from the arrow in the fig, the destination the end.

TODO: move this method to a generic ModelHelper

Parameters:

relationship - is the relation

Returns:

Object

getDestination

java.lang.Object getDestination(java.lang.Object relationship)

Returns the destination of a relation or link. The destination of a relation is defined as the ModelElement that receives this relation. If there are more then 1 destinations, only the first is returned. If there is no destination, null is returned. Examples of sources include classifiers that are types to associationends, usecases that are bases to extend and include relations and so on. In the case of an association, the destination is defined as the type of the second element in the connections list.

TODO: move this method to a generic ModelHelper

Parameters:

relationship - is the relation

Returns:

object

getDependencies

java.util.Collection getDependencies(java.lang.Object supplier,
                                     java.lang.Object client)

Return the dependencies between a supplier ModelElement and a client ModelElement. Does not return the inverse relationship (dependency 'from client to supplier').

Parameters:

supplier - a ModelElement

client - a ModelElement

Returns:

Collection

getPackageImport

java.lang.Object getPackageImport(java.lang.Object supplier,
                                  java.lang.Object client)

Return the packageImport (Permission with <<import>> or <<access>> stereotype in UML 1.4) between a supplier Package and a client Namespace, if any.

Parameters:

supplier - a Package

client - a Namespace

Returns:

the import or null

getPackageImports

java.util.Collection getPackageImports(java.lang.Object client)

Return all packageImports (Permissions with <<import>> or <<access>> stereotype in UML 1.4) that this Namespace is a client of.

Parameters:

client - a Namespace

Returns:

Collection of imports

getRelationships

java.util.Collection getRelationships(java.lang.Object source,
                                      java.lang.Object dest)

Return all relationships between the source and destination ModelElement and vice versa.

Parameters:

source - is the source model element

dest - is the destination model element

Returns:

Collection

isValidNamespace

boolean isValidNamespace(java.lang.Object element,
                         java.lang.Object namespace)

Return true if the given ModelElement may be owned by the given namespace.

Simply returns false if the parameters are not the expected UML elements - any Object is accepted.

Parameters:

element - a ModelElement

namespace - a Namespace

Returns:

boolean

getFirstSharedNamespace

java.lang.Object getFirstSharedNamespace(java.lang.Object ns1,
                                         java.lang.Object ns2)

Return the first namespace which two namespaces share. That is: it returns the first namespace that owns the given namespaces themselves or an owner of the given namespaces.

Parameters:

ns1 - is the first name space

ns2 - is the second name space

Returns:

The Namespace.

getAllPossibleNamespaces

java.util.Collection getAllPossibleNamespaces(java.lang.Object modelElement,
                                              java.lang.Object model)

Return all possible namespaces that are valid owners of the given ModelElement as determined by the method isValidNamespace.

Parameters:

modelElement - is the model element

model - the model to search

Returns:

Collection

getChildren

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

Return all children of a given GeneralizableElement on all levels (the complete subtree excluding the GeneralizableElement itself).

Parameters:

element - is the GeneralizableElement

Returns:

Collection

Throws:

java.lang.IllegalStateException - if there is a circular reference.

getAllRealizedInterfaces

java.util.Collection getAllRealizedInterfaces(java.lang.Object element)

Return all interfaces that are realized by the given class or by its superclasses. It's possible that interfaces occur twice in the collection returned. In that case there is a double reference to that interface.

Parameters:

element - is the given class

Returns:

Collection

hasCompositeEnd

boolean hasCompositeEnd(java.lang.Object association)

Determine whether an Association has at least one AssociationEnd of AggregationKind Composite.

Parameters:

association - the association to be investigated

Returns:

true if one of the association ends of the given association is of the composite kind

equalsAggregationKind

boolean equalsAggregationKind(java.lang.Object associationEnd,
                              java.lang.String kindType)

Parameters:

associationEnd - is the association end

kindType - the AggregationKind as a string in lower case, eg: composite.

Returns:

true if the aggregation kinds are the same.

removeAnnotatedElement

void removeAnnotatedElement(java.lang.Object handle,
                            java.lang.Object me)

Remove the given ModelElement from a given comment.

Parameters:

handle - Comment

me - ModelElement

removeClientDependency

void removeClientDependency(java.lang.Object handle,
                            java.lang.Object dep)

Remove a dependency from a ModelElement.

Parameters:

handle - is the model element

dep - is the dependency

removeConstraint

void removeConstraint(java.lang.Object handle,
                      java.lang.Object cons)

Remove the given constraint from a given ModelElement.

Parameters:

handle - ModelElement

cons - Constraint

removeOwnedElement

void removeOwnedElement(java.lang.Object handle,
                        java.lang.Object value)

Remove an owned model element from a namespace.

Parameters:

handle - is the name space

value - is the model element

removeParameter

void removeParameter(java.lang.Object handle,
                     java.lang.Object parameter)

Remove a Parameter from an Operation.

Parameters:

handle - The operation.

parameter - The parameter.

removeQualifier

void removeQualifier(java.lang.Object handle,
                     java.lang.Object qualifier)

Remove a Qualifier from a AssociationEnd.

Parameters:

handle - the AssociationEnd

qualifier - the Qualifier attribute to be removed

removeSourceFlow

void removeSourceFlow(java.lang.Object handle,
                      java.lang.Object flow)

Remove a source flow from a ModelElement.

Parameters:

handle - The model element.

flow - The flow.

removeSupplierDependency

void removeSupplierDependency(java.lang.Object supplier,
                              java.lang.Object dependency)

Add a supplier dependency to a ModelElement.

Parameters:

supplier - the supplier

dependency - the dependency

removeTargetFlow

void removeTargetFlow(java.lang.Object handle,
                      java.lang.Object flow)

Add a target flow to a ModelElement.

Parameters:

handle - The model element.

flow - The flow to add.

removeTemplateArgument

void removeTemplateArgument(java.lang.Object binding,
                            java.lang.Object argument)

Remove a TemplateArgument from a Binding.

Parameters:

binding - The Binding.

argument - The argument.

removeTemplateParameter

void removeTemplateParameter(java.lang.Object handle,
                             java.lang.Object parameter)

Remove a TemplateParameter from a ModelElement.

Parameters:

handle - The element.

parameter - The parameter.

addAnnotatedElement

void addAnnotatedElement(java.lang.Object comment,
                         java.lang.Object annotatedElement)

Add an annotated element to a comment.

Parameters:

comment - The comment to which the element is annotated

annotatedElement - The element to annotate

addClient

void addClient(java.lang.Object dependency,
               java.lang.Object element)

Add a client model element to a Dependency.

Parameters:

dependency - the Dependency.

element - The model element.

addClientDependency

void addClientDependency(java.lang.Object handle,
                         java.lang.Object dependency)

Add a client Dependency to a ModelElement.

Parameters:

handle - the ModelElement

dependency - the dependency

addComment

void addComment(java.lang.Object element,
                java.lang.Object comment)

Add a new comment to a ModelElement.

Parameters:

element - the element to which the comment is to be added

comment - the comment for the model element

addConnection

void addConnection(java.lang.Object handle,
                   java.lang.Object connection)

Add an End to a connection.

Parameters:

handle - Association or Link

connection - AssociationEnd or LinkEnd

addConnection

void addConnection(java.lang.Object handle,
                   int position,
                   java.lang.Object connection)

Add an End to a connection.

Parameters:

handle - Association or Link

position - the 0-based position at which to insert the AssociationEnd or LinkEnd

connection - AssociationEnd or LinkEnd

addConstraint

void addConstraint(java.lang.Object handle,
                   java.lang.Object mc)

Add a constraint to a ModelElement.

Parameters:

handle - model element

mc - constraint

addDeploymentLocation

void addDeploymentLocation(java.lang.Object handle,
                           java.lang.Object node)

Parameters:

handle - Component

node - Node

addFeature

void addFeature(java.lang.Object handle,
                int index,
                java.lang.Object f)

Add a feature to a Classifier.

Parameters:

handle - classifier

index - position

f - feature

addLiteral

void addLiteral(java.lang.Object handle,
                int index,
                java.lang.Object literal)

Add an EnumerationLiteral to an Enumeration at the specified position.

Parameters:

handle - the enumeration

index - the position

literal - the EnumerationLiteral to be added

addFeature

void addFeature(java.lang.Object handle,
                java.lang.Object f)

Add a feature to a Classifier.

Parameters:

handle - classifier

f - feature

addLink

void addLink(java.lang.Object handle,
             java.lang.Object link)

Add the given Link to the given Link or Association.

Parameters:

handle - the Link or Association

link - Link

addMethod

void addMethod(java.lang.Object handle,
               java.lang.Object method)

Add a method to an Operation and copy the values of the Operation's visibility and scope attributes to the Method.

Parameters:

handle - is the operation

method - is the method

addOwnedElement

void addOwnedElement(java.lang.Object handle,
                     java.lang.Object me)

Add a ModelElement to a Namespace.

Parameters:

handle - namespace

me - model element

addParameter

void addParameter(java.lang.Object handle,
                  int index,
                  java.lang.Object parameter)

Add a Parameter to the given object at given location.

Parameters:

handle - The object that will get the Parameter: Event, BehavioralFeature.

index - the location

parameter - Object that will be added

addParameter

void addParameter(java.lang.Object handle,
                  java.lang.Object parameter)

Add a Parameter to the given object.

Parameters:

handle - The object that will get the Parameter: ObjectFlowState, Event, BehavioralFeature, Classifier.

parameter - Object that will be added

addQualifier

void addQualifier(java.lang.Object handle,
                  int position,
                  java.lang.Object qualifier)

Parameters:

handle - the Association End

position - the 0-based position at which to insert the Qualifier

qualifier - the Qualifier attribute

addRaisedSignal

void addRaisedSignal(java.lang.Object handle,
                     java.lang.Object sig)

Add a raised Signal to a Message.

Parameters:

handle - the Message or Operation

sig - the Signal that is raised

addRaisedException

void addRaisedException(java.lang.Object handle,
                        java.lang.Object exception)

Add a raised exception to a Operation.

Parameters:

handle - the Operation

exception - the raised exception.

addSourceFlow

void addSourceFlow(java.lang.Object handle,
                   java.lang.Object flow)

Add a source flow to a ModelElement.

Parameters:

handle - The model element.

flow - The flow.

addSupplier

void addSupplier(java.lang.Object handle,
                 java.lang.Object element)

Add a supplier to a Dependency.

Parameters:

handle - the Dependency to which to add the supplier

element - supplier model element

addSupplierDependency

void addSupplierDependency(java.lang.Object supplier,
                           java.lang.Object dependency)

Add a supplier dependency to a ModelElement.

Parameters:

supplier - the supplier

dependency - the dependency

addTargetFlow

void addTargetFlow(java.lang.Object handle,
                   java.lang.Object flow)

Add a target flow to a ModelElement.

Parameters:

handle - The model element.

flow - The flow to add.

addTemplateArgument

void addTemplateArgument(java.lang.Object handle,
                         int index,
                         java.lang.Object argument)

Add a TemplateArgument to the given object at given location.

Parameters:

handle - The object that will get the TemplateParameter

index - the location

argument - Object that will be added

addTemplateArgument

void addTemplateArgument(java.lang.Object handle,
                         java.lang.Object argument)

Add a TemplateArgument to the given object.

Parameters:

handle - The object that will get the TemplateArgument

argument - Object that will be added

addTemplateParameter

void addTemplateParameter(java.lang.Object handle,
                          int index,
                          java.lang.Object parameter)

Add a TemplateParameter to the given object at given location.

Parameters:

handle - The object that will get the TemplateParameter

index - the location

parameter - Object that will be added

addTemplateParameter

void addTemplateParameter(java.lang.Object handle,
                          java.lang.Object parameter)

Add a TemplateTParameter to the given object.

Parameters:

handle - The object that will get the TemplateParameter

parameter - Object that will be added

setAbstract

void setAbstract(java.lang.Object handle,
                 boolean isAbstract)

Set the isAbstract attribute of a GeneralizableElement.

Parameters:

handle - the GeneralizableElement

isAbstract - is true if it should be abstract

setActive

void setActive(java.lang.Object handle,
               boolean isActive)

Set the isActive attribute of a UML Class.

Parameters:

handle - Class

isActive - boolean

setAggregation

void setAggregation(java.lang.Object handle,
                    java.lang.Object aggregationKind)

Set the aggregation attribute of an AssociationEnd.

Parameters:

handle - the AssociationEnd

aggregationKind - an AggregationKind of Aggregate, Composite, or None returned from Model.getAggregationKind().

setAnnotatedElements

void setAnnotatedElements(java.lang.Object handle,
                          java.util.Collection elems)

Set the list of annotated elements for the given comment.

Parameters:

handle - the given comment

elems - the collection of annotated ModelElements

setAssociation

void setAssociation(java.lang.Object handle,
                    java.lang.Object association)

Set the association of a ModelElement.

Parameters:

handle - the model element to set association

association - is the association

setLeaf

void setLeaf(java.lang.Object handle,
             boolean isLeaf)

Set the isLeaf attribute of a GeneralizableElement.

Parameters:

handle - the GeneralizableElement

isLeaf - is true if it is a leaf, ie it has no subtypes.

setRaisedSignals

void setRaisedSignals(java.lang.Object handle,
                      java.util.Collection raisedSignals)

Set the raised signals of a BehavioralFeature.

Parameters:

handle - the behavioural feature

raisedSignals - the raised signals

setBody

void setBody(java.lang.Object handle,
             java.lang.Object expr)

Sets a body of a given Method or Constraint.

Parameters:

handle - The method or constraint.

expr - The body of the expression. If it is a method, this must be a ProcedureExpression. If it is a Constraint, this must be a BooleanExpression.

setChangeability

@Deprecated
void setChangeability(java.lang.Object handle,
                                 java.lang.Object ck)

Deprecated. for 0.25.4 by tfmorris. Use setReadOnly(Object, boolean). NOTE: The UML 1.x enum of AddOnly has no equivalent in UML 2.x.

Set the Changeability of a StructuralFeature or AssociationEnd.

Parameters:

handle - StructuralFeature or AssociationEnd

ck - a ChangeableKind of Changeable, Frozen or AddOnly returned from Model.getChangeableKind().

setReadOnly

void setReadOnly(java.lang.Object handle,
                 boolean isReadOnly)

Set the isReadOnly (UML 2.x) or changeable (UML 1.x) attribute of a StructuralFeature or AssociationEnd.

Parameters:

handle - is the feature

isReadOnly - true for ReadOnly (Frozen in UML 1.x).

setChild

void setChild(java.lang.Object handle,
              java.lang.Object child)

Set the child for a generalization.

Parameters:

handle - Generalization

child - GeneralizableElement

setConcurrency

void setConcurrency(java.lang.Object handle,
                    java.lang.Object concurrencyKind)

Set the concurrency of an Operation.

Parameters:

handle - the Operation

concurrencyKind - a ConcurrencyKind of Concurrent, Guarded, or Sequential returned from Model.getConcurrencyKind().

setConnections

void setConnections(java.lang.Object handle,
                    java.util.Collection ends)

Sets the list of connections of the given association or link.

Parameters:

handle - the given association or link

ends - the list of association-ends or link-ends

setDefaultElement

void setDefaultElement(java.lang.Object handle,
                       java.lang.Object element)

Sets the default ModelEelement of a TemplateParameter.

Parameters:

handle - is the TemplateParameter

element - is the default ModelElement or null

setDefaultValue

void setDefaultValue(java.lang.Object handle,
                     java.lang.Object expression)

Set the defaultValue of a Parameter.

Parameters:

handle - is the Parameter

expression - the Expression to be used as the default value

setDiscriminator

void setDiscriminator(java.lang.Object handle,
                      java.lang.String discriminator)

Set the discriminator of a Generalization.

Parameters:

handle - a Generalization

discriminator - the String representing the discriminator

setFeature

void setFeature(java.lang.Object classifier,
                int index,
                java.lang.Object feature)

Set the Feature of a Classifier at the given position.

Parameters:

classifier - The classifier to set.

index - The position. Start with 0.

feature - The feature to set.

setFeatures

void setFeatures(java.lang.Object classifier,
                 java.util.Collection features)

Sets the features of a Classifier.

Parameters:

classifier - the Classifier to set features to

features - the list of features. NOTE: although the API allows any type of Collection, the list of features is ordered, so only a List should be passed here. Other types of collections will be converted to a List in their natural order (which may not be the desired order.

setContainer

void setContainer(java.lang.Object handle,
                  java.lang.Object component)

Set the Container of the given ElementResidence to the given Component.

Parameters:

handle - the ElementResidence

component - the Component

setInitialValue

void setInitialValue(java.lang.Object attribute,
                     java.lang.Object expression)

Set the initialValue of an Attribute.

Parameters:

attribute - attribute that we set the initial value of

expression - that is the value to set. Can be null.

setKind

void setKind(java.lang.Object handle,
             java.lang.Object kind)

Set the kind of a Parameter or the Pseudostate.

Parameters:

handle - is the Parameter or Pseudostate

kind - a direction kind returned from Model.getDirectionKind() or a pseudostate kind returned from Model.getPseudostateKind().

setModelElementContainer

void setModelElementContainer(java.lang.Object handle,
                              java.lang.Object container)

Set the container that owns the handle.

Warning: the implementation does not support setting the owner of actions. Use setState1 etc. on action for that goal.

Use a more specific method such as setOwner, setContainer, etc if at all possible, rather than this method.

Parameters:

handle - The ModelElement that must be added to the container

container - The owning ModelElement

Throws:

java.lang.IllegalArgumentException - when the handle or container is null or if the handle cannot be added to the container.

setMultiplicity

void setMultiplicity(java.lang.Object handle,
                     java.lang.Object arg)

Set the multiplicity of a ModelElement.

Parameters:

handle - model element

arg - multiplicity as string OR multiplicity object, null is a valid value (unspecified)

setName

void setName(java.lang.Object handle,
             java.lang.String name)

Set the name of a ModelElement.

Parameters:

handle - is the model element

name - to set

setBody

void setBody(java.lang.Object handle,
             java.lang.String body)

Set the body of a comment.

NOTE: For UML 1.3, this actually set Comment.name, but for UML 1.4 it sets Comment.body. This is a behavior change in the API.

Parameters:

handle - the Comment element

body - the string

setNamespace

void setNamespace(java.lang.Object handle,
                  java.lang.Object ns)

Set the namespace of a ModelElement.

Parameters:

handle - is the model element

ns - is the namespace. Can be null.

setNavigable

void setNavigable(java.lang.Object handle,
                  boolean flag)

Set the navigability of an AssociationEnd.

Parameters:

handle - is the association end

flag - is the navigability flag

setOrdering

void setOrdering(java.lang.Object handle,
                 java.lang.Object ordering)

Set the OrderingKind of a given AssociationEnd.

Parameters:

handle - AssociationEnd

ordering - an OrderingKind returned from Model.getOrderingKind().

setOwner

void setOwner(java.lang.Object handle,
              java.lang.Object owner)

Set the owner of a Feature or a TagDefinition.

Parameters:

handle - Feature or TagDefinition

owner - Classifier or null

setStatic

void setStatic(java.lang.Object element,
               boolean isStatic)

Set the isStatic (UML 2.x) or ownerScope (UML 1.x) attribute of a feature. As a special backward compatibility bridge, if passed a UML 1.4 AssociationEnd, it will set the targetScope instead of the ownerScope (since AssociationEnds don't have an ownerScope).

Parameters:

element - feature or association end

isStatic - true if static (Classifier scope in UML 1.x). False is equivalent to the UML 1.x ScopeKind of 'Instance'.

Since:

0.25.4

setParameter

void setParameter(java.lang.Object handle,
                  java.lang.Object parameter)

Set the parameter of a TemplateParameter.

Parameters:

handle - the TemplateParameter

parameter - the dummy ModelElement to be used as the parameter

setParameters

void setParameters(java.lang.Object handle,
                   java.util.Collection parameters)

Set the parameters of a classifier, event, objectflowstate or behavioralfeature.

Parameters:

handle - the classifier, event, objectflowstate or behavioralfeature

parameters - is a Collection of parameters

setParent

void setParent(java.lang.Object handle,
               java.lang.Object parent)

Set the parent of a generalization.

Parameters:

handle - generalization

parent - GeneralizableElement (parent)

setPowertype

void setPowertype(java.lang.Object handle,
                  java.lang.Object powerType)

Set the powerType of a Generalization.

Parameters:

handle - Generalization

powerType - the Classifier to set as the powerType or null to clear the powerType.

setQualifiers

void setQualifiers(java.lang.Object handle,
                   java.util.List qualifiers)

Set the qualifier attributes of an AssociationEnd.

Parameters:

handle - the association end

qualifiers - List of Attributes to be set as qualifiers

setQuery

void setQuery(java.lang.Object handle,
              boolean isQuery)

Sets the isQuery attribute of a BehavioralFeature.

Parameters:

handle - is the behavioral feature

isQuery - new value for the isQuery attribute

setResident

void setResident(java.lang.Object handle,
                 java.lang.Object resident)

Sets the ModelElement of a ElementResidence.

Parameters:

handle - ElementResidence

resident - ModelElement or null

setResidents

void setResidents(java.lang.Object handle,
                  java.util.Collection residents)

Sets the residents of a NodeInstance or ComponentInstance.

Parameters:

handle - the NodeInstance or ComponentInstance

residents - collection of ComponentInstances (in case the handle is a NodeInstance) or Instances (in case the handle is a ComponentInstance)

setRoot

void setRoot(java.lang.Object handle,
             boolean isRoot)

Set the isRoot attribute of a GeneralizableElement.

Parameters:

handle - model element

isRoot - is true if it is a root ie it has no supertypes

setSources

void setSources(java.lang.Object handle,
                java.util.Collection specifications)

Parameters:

handle - Flow

specifications - the collection of ModelEvents (sourceFlow)

setSpecification

void setSpecification(java.lang.Object handle,
                      boolean isSpecification)

Set the isSpecification attribute for the ElementOwnership of a ModelElement.

Parameters:

handle - ModelElement

isSpecification - true of the element is specification

setSpecification

void setSpecification(java.lang.Object method,
                      java.lang.Object specification)

Set the specification (i.e. the Operation) of a Method.

Parameters:

method - the method

specification - the operation

setSpecification

void setSpecification(java.lang.Object operation,
                      java.lang.String specification)

Set the specification of an Operation.

Parameters:

operation - the operation

specification - the operation

setSpecifications

void setSpecifications(java.lang.Object handle,
                       java.util.Collection specifications)

Set the specifications of an AssociationEnd.

Parameters:

handle - the association end

specifications - collection

addStereotype

void addStereotype(java.lang.Object modelElement,
                   java.lang.Object stereo)

Add a stereotype to a ModelElement.

Parameters:

modelElement - model element

stereo - stereotype

addAllStereotypes

void addAllStereotypes(java.lang.Object modelElement,
                       java.util.Collection stereos)

Add a collection of stereotype to a ModelElement.

Parameters:

modelElement - model element

stereos - stereotype

removeStereotype

void removeStereotype(java.lang.Object handle,
                      java.lang.Object stereo)

Remove a stereotype from a ModelElement.

Parameters:

handle - model element

stereo - stereotype

clearStereotypes

void clearStereotypes(java.lang.Object handle)

Remove all stereotypes from a given ModelElement.

Parameters:

handle - model element

setTaggedValue

@Deprecated
void setTaggedValue(java.lang.Object handle,
                               java.lang.String tag,
                               java.lang.String value)

Deprecated. by tfmorris for 0.23.3. Use ExtensionMechanismsHelper.setType(Object, Object) and ExtensionMechanismsHelper.setValueOfTag(Object, String).

Set a tagged value of a ModelElement.

Parameters:

handle - is the model element

tag - is the tag name (a string)

value - is the value

setTargetScope

@Deprecated
void setTargetScope(java.lang.Object handle,
                               java.lang.Object targetScope)

Deprecated. for 0.25.4 by tfmorris. Target Scope has been removed from the UML 2.x spec so this should not be used.

Set the targetScope of an AssociationEnd or StructuralFeature.

Parameters:

handle - the model element

targetScope - a ScopeKind of Instance or Classifier returned from Model.getScopeKind().

setType

void setType(java.lang.Object handle,
             java.lang.Object type)

Set the type of a ModelElement.

Parameters:

handle - a ModelElement which is one of: Parameter, AssociationEnd, StructuralFeature, ClassifierInState, or ObjectFlowState.

type - a Classifier representing the type

setVisibility

void setVisibility(java.lang.Object handle,
                   java.lang.Object visibility)

Set the visibility of a ModelElement, ElementResidence, ElementImport.

Parameters:

handle - element

visibility - is the visibility

removeDeploymentLocation

void removeDeploymentLocation(java.lang.Object handle,
                              java.lang.Object node)

Remove a deployment location.

Parameters:

handle - Component from which to remove deploymentLocation

node - Node to be removed

removeConnection

void removeConnection(java.lang.Object handle,
                      java.lang.Object connection)

Remove a connection between an Association & AssociationEnd or between a Link & LinkEnd.

Parameters:

handle - Association or Link

connection - AssociationEnd or LinkEnd

addElementResidence

void addElementResidence(java.lang.Object handle,
                         java.lang.Object residence)

Add an ElementResidence.

Parameters:

handle - ModelElement

residence - ElementResidence to add

removeElementResidence

void removeElementResidence(java.lang.Object handle,
                            java.lang.Object residence)

Remove an ElementResidence.

Parameters:

handle - ModelElement

residence - ElementResidence to remove

setEnumerationLiterals

void setEnumerationLiterals(java.lang.Object enumeration,
                            java.util.List literals)

Set the (ordered) list of literals of an Enumeration.

Parameters:

enumeration - Enumeration to add EnumerationLiterals too

literals - A list of EnumerationLiterals

getAllMetatypeNames

java.util.Collection<java.lang.String> getAllMetatypeNames()

Returns names of all metatypes in metamodel. TODO: This method rightly belongs in a separate interface dealing with instances of MOF types as opposed to UML types like all the rest of the methods here do.

Returns:

Collection containing Strings with names of all metatypes

getAllMetaDatatypeNames

java.util.Collection<java.lang.String> getAllMetaDatatypeNames()

Returns names of all metamodel value elements including datatypes, enumerations, and primitive types. TODO: This method rightly belongs in a separate interface dealing with instances of MOF types as opposed to UML types like all the rest of the methods here do.

Returns:

Collection containing Strings with names of all metatypes