org.andromda.metafacades.uml

Class MetafacadeUtils

java.lang.Object

org.andromda.metafacades.uml.MetafacadeUtils

public class MetafacadeUtils
extends Object

A class containing utilities for metafacade manipulation.

Author:

Chad Brandon, Wouter Zoons, Bob Fields

Constructor Summary

Constructors

Constructor and Description
MetafacadeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static long	calculateDefaultSUID(ClassifierFacade object) Calculates the serial version UID of this classifier based on the signature of the classifier (name, visibility, attributes and methods).
static void	filterByNotType(Collection modelElements, Class type) Filters out the model elements from the modelElements collection that are of (or inherit from) the specified type type
static void	filterByStereotype(Collection modelElements, String stereotype) Filters out the model elements from the modelElements collection that don't have the specified stereotype
static void	filterByType(Collection modelElements, Class type) Filters out the model elements from the modelElements collection that are not of (or do not inherit from) the specified type type
static Object	getElementAsType(Object element, Class type) Checks to see if the element is the specified type and if so casts it to the object and returns it, otherwise it returns null.
static String	getEmfTaggedValue(String name) Changes andromda standard tag format Strings to EMF standard format Strings (must be a valid Java identifier).
static String	getSignature(String name, Collection<ParameterFacade> arguments, boolean withArgumentNames, String argumentModifier) Creates a typed argument list with the given arguments.
static String	getTypedArgumentList(Collection<ParameterFacade> arguments, boolean withArgumentNames, String modifier) Creates a typed argument list with the given arguments.
static String	getUml14TaggedValue(String name) Changes EMF standard tag format Strings to AndroMDA standard format Strings.
static void	sortByFullyQualifiedName(List metafacades) Sorts given metafacades by their fully qualified name.
static String	toRelationName(String roleName, String targetRoleName, String separator) Returns a consistent name for a relation, independent from the end of the relation one is looking at.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetafacadeUtils

public MetafacadeUtils()

Method Detail

getElementAsType

public static Object getElementAsType(Object element,
                      Class type)

Checks to see if the element is the specified type and if so casts it to the object and returns it, otherwise it returns null.

Parameters:

element - the element to check.

type - the Class type.

Returns:

the element has the given type or null.

filterByStereotype

public static void filterByStereotype(Collection modelElements,
                      String stereotype)

Filters out the model elements from the modelElements collection that don't have the specified stereotype

Parameters:

modelElements - the model elements to filter.

stereotype - the stereotype that a model element must have in order to stay remain within the modelElements collection.

filterByType

public static void filterByType(Collection modelElements,
                Class type)

Filters out the model elements from the modelElements collection that are not of (or do not inherit from) the specified type type

Parameters:

modelElements - the model elements to filter.

type - the type of Class.

filterByNotType

public static void filterByNotType(Collection modelElements,
                   Class type)

Filters out the model elements from the modelElements collection that are of (or inherit from) the specified type type

Parameters:

modelElements - the model elements to filter.

type - the type of Class.

toRelationName

public static String toRelationName(String roleName,
                    String targetRoleName,
                    String separator)

Returns a consistent name for a relation, independent from the end of the relation one is looking at.

In order to guarantee consistency with relation names, they must appear the same whichever angle (ie entity) that you come from. For example, if you are at Customer end of a relationship to an Address then your relation may appear with the name Customer-Address. But if you are in the Address entity looking at the Customer then you will get an error because the relation will be called Address-Customer. A simple way to guarantee that both ends of the relationship have the same name is merely to use alphabetical ordering.

Parameters:

roleName - name of role in relation

targetRoleName - name of target role in relation

separator - character used to separate words

Returns:

uniform mapping name (in alphabetical order)

sortByFullyQualifiedName

public static void sortByFullyQualifiedName(List metafacades)

Sorts given metafacades by their fully qualified name.

Parameters:

metafacades - the collection of model elements to sort.

getTypedArgumentList

public static String getTypedArgumentList(Collection<ParameterFacade> arguments,
                          boolean withArgumentNames,
                          String modifier)

Creates a typed argument list with the given arguments. If the withArgumentNames flag is true, the argument names are included in the list.

Parameters:

arguments - the arguments from which to create the list.

withArgumentNames - whether or not to include the argument names.

modifier -

Returns:

arguments.iterator().getGetterSetterTypeName()

getSignature

public static String getSignature(String name,
                  Collection<ParameterFacade> arguments,
                  boolean withArgumentNames,
                  String argumentModifier)

Creates a typed argument list with the given arguments. If the withArgumentNames flag is true, the argument names are included in the list.

Parameters:

name -

arguments - the arguments from which to create the list.

withArgumentNames - whether or not to include the argument names.

argumentModifier -

Returns:

getTypedArgumentList(arguments, withArgumentNames, argumentModifier)

getEmfTaggedValue

public static String getEmfTaggedValue(String name)

Changes andromda standard tag format Strings to EMF standard format Strings (must be a valid Java identifier). Used for backwards compatibility with UML14 conventions. For example, @andromda.whatever becomes andromda_whatever.

Parameters:

name -

Returns:

getTypedArgumentList(arguments, withArgumentNames, argumentModifier)

getUml14TaggedValue

public static String getUml14TaggedValue(String name)

Changes EMF standard tag format Strings to AndroMDA standard format Strings. Used for backwards compatibility with UML14 conventions. For example, andromda_whatever becomes @andromda.whatever.

Parameters:

name -

Returns:

getTypedArgumentList(arguments, withArgumentNames, argumentModifier)

calculateDefaultSUID

public static long calculateDefaultSUID(ClassifierFacade object)

Calculates the serial version UID of this classifier based on the signature of the classifier (name, visibility, attributes and methods). The algorithm is inspired by ObjectStreamClass.getSerialVersionUID(). The value should be stable as long as the classifier remains unchanged and should change as soon as there is any change in the signature of the classifier.

Parameters:

object -

Returns:

the serial version UID of this classifier.