org.andromda.metafacades.uml

Class UMLMetafacadeUtils

java.lang.Object

org.andromda.metafacades.uml.UMLMetafacadeUtils

public class UMLMetafacadeUtils
extends Object

Contains utilities that are common to the UML metafacades.

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
UMLMetafacadeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
String	createConstructor(ModelElementFacade facade) Supplies a result for type = ; initialization for all types
String	createConstructor(ModelElementFacade facade, boolean useMany) Supplies a result for type = ; initialization for all types
String	createConstructor(ModelElementFacade facade, boolean useMany, ModelElementFacade parent) Supplies a result for type = ; initialization for all types
static String	getClassDeclaration(ModelElementFacade facade, boolean enableTemplating) Get the classname without the package name and without additional template<> parameters.
static String	getClassDeclaration(ModelElementFacade facade, String className, boolean enableTemplating) Get the classname without the package name and without additional template<> parameters.
static String	getDate() Returns the current Date in the specified format.
static String	getDate(String format) Returns the current Date in the specified format.
static String	getFQNameWithoutTemplate(ModelElementFacade facade) Get the fully-qualified classname without the additional template<> parameters.
static String	getGenericTemplate(ModelElementFacade facade, boolean enableTemplating) Get the generic template declaration.
static String	getGetterPrefix(ClassifierFacade type) Gets the getter prefix for a getter operation given the type.
static String	getGetterPrefix(ClassifierFacade type, int lowerBound) Gets the getter prefix for a getter operation given the type, taking multiplicity into account for booleans
static String	getImplCollection(String input) Transforms the declared type to implementation type for a declared Collection.
static boolean	isConstraintKind(String expression, String kind) Returns true if the passed in constraint expression is of type kind, false otherwise.
static boolean	isOwningEnd(AssociationEndFacade associationEnd) TODO Reference this logic from AssociationEnd Determine if this association end owns the relationship.
static boolean	isReservedWord(String name) Returns true if the value is a reserved keyword in Java or C#, or cannot be used as a name
static boolean	isType(ClassifierFacade classifier, String typeName) Returns true or false depending on whether or not this Classifier or any of its specializations is of the given type having the specified typeName
static boolean	shouldOutput(ModelElementFacade mef) Determines if the class/package should be generated.
static boolean	shouldOutput(ModelElementFacade mef, String outletFile, boolean refOutput) Returns the number of methods without stereotypes or with SimpleClass stereotype.

Methods inherited from class java.lang.Object

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

Constructor Detail

UMLMetafacadeUtils

public UMLMetafacadeUtils()

Method Detail

isType

public static boolean isType(ClassifierFacade classifier,
             String typeName)

Returns true or false depending on whether or not this Classifier or any of its specializations is of the given type having the specified typeName

Parameters:

classifier -

typeName - the name of the type (i.e. datatype::Collection)

Returns:

true/false

isReservedWord

public static boolean isReservedWord(String name)

Returns true if the value is a reserved keyword in Java or C#, or cannot be used as a name

Parameters:

name - the String to check if a keyword

Returns:

true/false

getGetterPrefix

public static String getGetterPrefix(ClassifierFacade type)

Gets the getter prefix for a getter operation given the type.

Parameters:

type - the type from which to determine the prefix.

Returns:

the getter prefix.

getGetterPrefix

public static String getGetterPrefix(ClassifierFacade type,
                     int lowerBound)

Gets the getter prefix for a getter operation given the type, taking multiplicity into account for booleans

Parameters:

type - the type from which to determine the prefix.

lowerBound - If > 0 then type is not optional, thus primitive isBoolean()

Returns:

the getter prefix.

isConstraintKind

public static boolean isConstraintKind(String expression,
                       String kind)

Returns true if the passed in constraint expression is of type kind, false otherwise.

Parameters:

expression - the expression to check.

kind - the constraint kind (i.e. inv,pre, body, etc).

Returns:

true/false

getImplCollection

public static String getImplCollection(String input)

Transforms the declared type to implementation type for a declared Collection. Default: Collection=LinkedList, List=ArrayList, Set=HashSet, SortedSet=TreeSet. Retains the generics and package in the template declaration, if any

Parameters:

input - the declared Collection type to be transformed into an implementation type

Returns:

the Collection implementation declaration.

shouldOutput

public static boolean shouldOutput(ModelElementFacade mef)

Determines if the class/package should be generated. Will not be generated if it has any stereotypes: documentation, docOnly, Future, Ignore, analysis, perspective, or any invalid package identifier characters ` ~!@#%^&*()-+={}[]:;<>,?/|

Parameters:

mef - ModelElementFacade class to check for stereotypes.

Returns:

false if it has any Stereotypes DocOnly, Future, Ignore configured in UMLProfile

getClassDeclaration

public static String getClassDeclaration(ModelElementFacade facade,
                         boolean enableTemplating)

Get the classname without the package name and without additional template<> parameters.

Parameters:

facade -

enableTemplating -

Returns:

getNameWithoutPackage

getClassDeclaration

public static String getClassDeclaration(ModelElementFacade facade,
                         String className,
                         boolean enableTemplating)

Get the classname without the package name and without additional template<> parameters.

Parameters:

facade -

className - Class name to use in the class declaration, overrides facade.getName()

enableTemplating - Whether template declaration should be created.

Returns:

getNameWithoutPackage

getGenericTemplate

public static String getGenericTemplate(ModelElementFacade facade,
                        boolean enableTemplating)

Get the generic template declaration.

Parameters:

facade -

enableTemplating -

Returns:

getGenericTemplate

getFQNameWithoutTemplate

public static String getFQNameWithoutTemplate(ModelElementFacade facade)

Get the fully-qualified classname without the additional template<> parameters.

Parameters:

facade -

Returns:

getFQNameWithoutTemplate

shouldOutput

public static boolean shouldOutput(ModelElementFacade mef,
                   String outletFile,
                   boolean refOutput)

Returns the number of methods without stereotypes or with SimpleClass stereotype. .

Parameters:

mef - ModelElementFacade class to check for stereotypes.

outletFile - Name of output file currently being processed. How do we get this in template?

refOutput - Should .ref files be output?

Returns:

false if it has any Stereotypes DocOnly, Future, Ignore configured in UMLProfile

createConstructor

public String createConstructor(ModelElementFacade facade)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

Returns:

Constructor String with facade name

createConstructor

public String createConstructor(ModelElementFacade facade,
                       boolean useMany)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

useMany - Return constructor with multiplicity type instead of underlying type

Returns:

Constructor String with facade name

createConstructor

public String createConstructor(ModelElementFacade facade,
                       boolean useMany,
                       ModelElementFacade parent)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

useMany - Return constructor with multiplicity type instead of underlying type

parent - Object containing this facade, which may have an attribute named dependency to a different type

Returns:

Constructor String with facade name

isOwningEnd

public static boolean isOwningEnd(AssociationEndFacade associationEnd)

TODO Reference this logic from AssociationEnd Determine if this association end owns the relationship. i.e. if the associationEnd property belonging to the Entity on the opposite end owns the relationship. Based on tagged value, multiplicity, aggregation/composition. If all else fails, the longest name owns the association, or else the alphabetically first name. One side of a relationship must always own the association and be created and deleted first.

Parameters:

associationEnd - the association end

Returns:

true if the associationEnd (property of the entity on the other end) is owned by the entity on the other end

getDate

public static String getDate(String format)

Returns the current Date in the specified format.

Parameters:

format - The format for the output date

Returns:

the current date in the specified format.

getDate

public static String getDate()

Returns the current Date in the specified format.

Returns:

the current date with the default format .