org.andromda.metafacades.uml14

Class UML14MetafacadeUtils

java.lang.Object

org.andromda.metafacades.uml14.UML14MetafacadeUtils

public class UML14MetafacadeUtils
extends Object

Utilities for dealing with UML 1.4 metafacades

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
UML14MetafacadeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static boolean	attributeExists(Object classifier, String name) Indicates whether or not the attribute exists on the given classifier.
(package private) static org.omg.uml.foundation.core.Attribute	createAttribute(String name, String fullyQualifiedTypeName, String visibility, String separator) Creates an attribute having the give name and the type having the given fullyQualifiedTypeName, with the specified visibility, if no type can be found with the given name, no type is set.
(package private) static Object	findByFullyQualifiedName(String fullyQualifiedName, String separator, boolean modelName) Finds a given model element in the model having the specified fullyQualifiedName.
(package private) static Object	findByName(String name) Finds and returns the first model element having the given name in the modelPackage, returns null if not found.
(package private) static org.omg.uml.foundation.core.UmlClass	findClassWithTaggedValueOrHyperlink(String tag, String value) Returns the first class this method can find with the given tagged value or hyperlink.
(package private) static Collection<org.omg.uml.behavioralelements.statemachines.FinalState>	findFinalStatesWithNameOrHyperlink(org.omg.uml.behavioralelements.usecases.UseCase useCase)
(package private) static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph	findFirstActivityGraphWithName(String name) Returns the first activity graph it can find with the given name.
(package private) static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph	findFirstActivityGraphWithNameAndStereotype(String name, String stereotypeName) Returns the first activity graph it can find with the given name and stereotype, if the stereotype is not specified (it is null) it will be ignored and the returned activity graph may have any arbitrary stereotype.
(package private) static org.omg.uml.behavioralelements.usecases.UseCase	findFirstUseCaseWithName(String name) Returns the first use-case it can find with the given name.
(package private) static org.omg.uml.behavioralelements.usecases.UseCase	findFirstUseCaseWithNameAndStereotype(String name, String stereotypeName) Returns the first use-case it can find with the given name and stereotype, if the stereotype is not specified (it is null) it will be ignored and the returned use-case may have any arbitrary stereotype.
(package private) static org.omg.uml.foundation.core.Stereotype	findOrCreateStereotype(String name) Finds or creates a stereotype with the given name.
(package private) static org.omg.uml.behavioralelements.usecases.UseCase	findUseCaseWithTaggedValueOrHyperlink(String tag, String value) Returns the first use-case this method can find with the given tagged value or hyperlink.
(package private) static org.omg.uml.foundation.core.CorePackage	getCorePackage() Basically just checks to make sure the model is of type org.omg.uml.UmlPackage and retrieves the CorePackage from it.
(package private) static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph	getMetaClass(ActivityGraphFacade facade) Finds the given metafacade class for the passed in facade.
(package private) static org.omg.uml.behavioralelements.statemachines.Event	getMetaClass(EventFacade facade) Finds the given metafacade class for the passed in facade.
(package private) static org.omg.uml.foundation.core.ModelElement	getMetaClass(ModelElementFacade facade) Finds the given metafacade class for the passed in facade.
(package private) static org.omg.uml.foundation.core.Parameter	getMetaClass(ParameterFacade facade) Finds the given metafacade class for the passed in facade.
(package private) static org.omg.uml.behavioralelements.usecases.UseCase	getMetaClass(UseCaseFacade facade) Finds the given metafacade class for the passed in facade.
(package private) static org.omg.uml.UmlPackage	getModel() Returns the entire model.
(package private) static String	getPackageName(org.omg.uml.foundation.core.ModelElement metaObject, String separator, boolean modelName) Constructs the package name for the given metaObject, separating the package name by the given separator.
(package private) static org.omg.uml.modelmanagement.UmlPackage	getRootPackage() Gets the root package in the model.
static String	getSerialVersionUID(ClassifierFacade classifier) Retrieves the serial version UID by reading the tagged value UMLProfile.TAGGEDVALUE_SERIALVERSION_UID of the classifier.
(package private) static org.omg.uml.foundation.datatypes.VisibilityKind	getVisibilityKind(String visibility) Gets the correct meta model visibility kind for the given visibility string.
(package private) static boolean	isHyperlinkPresent(org.omg.uml.foundation.core.ModelElement element, Object value) Returns true if the given model element has a hyperlink with the given value, returns false otherwise.
(package private) static boolean	isStereotypePresent(org.omg.uml.foundation.core.ModelElement element, String stereotypeName)
(package private) static boolean	isTagPresent(org.omg.uml.foundation.core.ModelElement element, String tag, Object value) Returns true if the given model element has a tag with the given name and value, returns false otherwise.
static List<ModelElementFacade>	removeDuplicatesAndCopyTaggedValues(Collection<ModelElementFacade> elements) This method removes all duplicates within the elements collection while at the same time copying tagged values from duplicates to the one remaining element with the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UML14MetafacadeUtils

public UML14MetafacadeUtils()

Method Detail

findByFullyQualifiedName

static Object findByFullyQualifiedName(String fullyQualifiedName,
                              String separator,
                              boolean modelName)

Finds a given model element in the model having the specified fullyQualifiedName. If the model element can NOT be found, null will be returned instead.

Parameters:

fullyQualifiedName - the fully qualified name of the element to search for.

separator - the PSM separator used for qualifying the name (example ".").

modelName - a flag indicating whether or not a search shall be performed using the fully qualified model name or fully qualified PSM name.

Returns:

the found model element

getPackageName

static String getPackageName(org.omg.uml.foundation.core.ModelElement metaObject,
                    String separator,
                    boolean modelName)

Constructs the package name for the given metaObject, separating the package name by the given separator.

Parameters:

metaObject - the Model Element

separator - the PSM namespace separator

modelName - true/false on whether or not to get the model package name instead of the PSM package name.

Returns:

the package name.

getCorePackage

static org.omg.uml.foundation.core.CorePackage getCorePackage()

Basically just checks to make sure the model is of type org.omg.uml.UmlPackage and retrieves the CorePackage from it.

Returns:

the model as a org.omg.uml.UmlPackage

findByName

static Object findByName(String name)

Finds and returns the first model element having the given name in the modelPackage, returns null if not found.

Parameters:

name - the name to find.

Returns:

the found model element.

getRootPackage

static org.omg.uml.modelmanagement.UmlPackage getRootPackage()

Gets the root package in the model.

Returns:

the root package as a UmlPackage.

getModel

static org.omg.uml.UmlPackage getModel()

Returns the entire model.

Returns:

org.omg.uml.UmlPackage model instance.

getVisibilityKind

static org.omg.uml.foundation.datatypes.VisibilityKind getVisibilityKind(String visibility)

Gets the correct meta model visibility kind for the given visibility string.

Parameters:

visibility - the visibility to retrieve.

Returns:

the VisibilityKind

createAttribute

static org.omg.uml.foundation.core.Attribute createAttribute(String name,
                                                    String fullyQualifiedTypeName,
                                                    String visibility,
                                                    String separator)

Creates an attribute having the give name and the type having the given fullyQualifiedTypeName, with the specified visibility, if no type can be found with the given name, no type is set.

Parameters:

name - the new name

fullyQualifiedTypeName - the name of the fully qualified type

visibility - the visibility name

separator - the separator used for qualifying the name.

Returns:

the new Attribute.

attributeExists

static boolean attributeExists(Object classifier,
                      String name)

Indicates whether or not the attribute exists on the given classifier.

Parameters:

classifier - the classifier to check

name - the name of the attribute

Returns:

true/false

findOrCreateStereotype

static org.omg.uml.foundation.core.Stereotype findOrCreateStereotype(String name)

Finds or creates a stereotype with the given name. If the stereotype isn't found, it will be created.

Parameters:

name - the name of the stereotype.

Returns:

the new Stereotype.

findFirstUseCaseWithName

static org.omg.uml.behavioralelements.usecases.UseCase findFirstUseCaseWithName(String name)

Returns the first use-case it can find with the given name.

Parameters:

name -

Returns:

findFirstUseCaseWithNameAndStereotype(name, null)

findFirstUseCaseWithNameAndStereotype

static org.omg.uml.behavioralelements.usecases.UseCase findFirstUseCaseWithNameAndStereotype(String name,
                                                                                    String stereotypeName)

Returns the first use-case it can find with the given name and stereotype, if the stereotype is not specified (it is null) it will be ignored and the returned use-case may have any arbitrary stereotype.

Parameters:

name -

stereotypeName -

Returns:

useCaseWithNameAndStereotype

findFirstActivityGraphWithName

static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph findFirstActivityGraphWithName(String name)

Returns the first activity graph it can find with the given name.

Parameters:

name -

Returns:

findFirstActivityGraphWithNameAndStereotype(name, null)

findFirstActivityGraphWithNameAndStereotype

static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph findFirstActivityGraphWithNameAndStereotype(String name,
                                                                                                      String stereotypeName)

Returns the first activity graph it can find with the given name and stereotype, if the stereotype is not specified (it is null) it will be ignored and the returned activity graph may have any arbitrary stereotype.

Parameters:

name -

stereotypeName -

Returns:

graphWithNameAndStereotype

isTagPresent

static boolean isTagPresent(org.omg.uml.foundation.core.ModelElement element,
                   String tag,
                   Object value)

Returns true if the given model element has a tag with the given name and value, returns false otherwise.

Parameters:

element -

tag -

value -

Returns:

tagPresent

isHyperlinkPresent

static boolean isHyperlinkPresent(org.omg.uml.foundation.core.ModelElement element,
                         Object value)

Returns true if the given model element has a hyperlink with the given value, returns false otherwise.

Parameters:

element -

value -

Returns:

isTagPresent(element, "hyperlinkModel", value)

isStereotypePresent

static boolean isStereotypePresent(org.omg.uml.foundation.core.ModelElement element,
                          String stereotypeName)

Parameters:

element -

stereotypeName -

Returns:

stereotypePresent

findUseCaseWithTaggedValueOrHyperlink

static org.omg.uml.behavioralelements.usecases.UseCase findUseCaseWithTaggedValueOrHyperlink(String tag,
                                                                                    String value)

Returns the first use-case this method can find with the given tagged value or hyperlink. Both arguments are used to look for the tagged value but only value is used to search for the hyperlink.

Parameters:

tag -

value -

Returns:

useCaseWithTaggedValue

findClassWithTaggedValueOrHyperlink

static org.omg.uml.foundation.core.UmlClass findClassWithTaggedValueOrHyperlink(String tag,
                                                                       String value)

Returns the first class this method can find with the given tagged value or hyperlink. Both arguments are used to look for the tagged value but only value is used to search for the hyperlink.

Parameters:

tag -

value -

Returns:

classWithTaggedValue

findFinalStatesWithNameOrHyperlink

static Collection<org.omg.uml.behavioralelements.statemachines.FinalState> findFinalStatesWithNameOrHyperlink(org.omg.uml.behavioralelements.usecases.UseCase useCase)

Parameters:

useCase -

Returns:

finalStates

getMetaClass

static org.omg.uml.behavioralelements.activitygraphs.ActivityGraph getMetaClass(ActivityGraphFacade facade)

Finds the given metafacade class for the passed in facade.

Parameters:

facade - the model element facade for which to find the meta class.

Returns:

the meta model element

getMetaClass

static org.omg.uml.behavioralelements.usecases.UseCase getMetaClass(UseCaseFacade facade)

Finds the given metafacade class for the passed in facade.

Parameters:

facade - the model element facade for which to find the meta class.

Returns:

the meta model element

getMetaClass

static org.omg.uml.foundation.core.Parameter getMetaClass(ParameterFacade facade)

Finds the given metafacade class for the passed in facade.

Parameters:

facade - the model element facade for which to find the meta class.

Returns:

the meta model element

getMetaClass

static org.omg.uml.behavioralelements.statemachines.Event getMetaClass(EventFacade facade)

Finds the given metafacade class for the passed in facade.

Parameters:

facade - the model element facade for which to find the meta class.

Returns:

the meta model element

getMetaClass

static org.omg.uml.foundation.core.ModelElement getMetaClass(ModelElementFacade facade)

Finds the given metafacade class for the passed in facade.

Parameters:

facade - the model element facade for which to find the meta class.

Returns:

the meta model element

getSerialVersionUID

public static String getSerialVersionUID(ClassifierFacade classifier)

Retrieves the serial version UID by reading the tagged value UMLProfile.TAGGEDVALUE_SERIALVERSION_UID of the classifier.

Parameters:

classifier - the classifier to be inspected.

Returns:

the serial version UID of the classifier. Returns null if the tagged value cannot be found.

removeDuplicatesAndCopyTaggedValues

public static List<ModelElementFacade> removeDuplicatesAndCopyTaggedValues(Collection<ModelElementFacade> elements)

This method removes all duplicates within the elements collection while at the same time copying tagged values from duplicates to the one remaining element with the given name.

Parameters:

elements - the elements to remove duplicates and copy tagged values to.

Returns:

the elements with duplicates removed.