org.andromda.metafacades.uml

Class EntityMetafacadeUtils

java.lang.Object

org.andromda.metafacades.uml.EntityMetafacadeUtils

public class EntityMetafacadeUtils
extends Object

Utilities for dealing with entity metafacades

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
EntityMetafacadeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearForeignKeyConstraintNameCache() Clears out the foreign key cache.
static String	constructSqlTypeName(String typeName, String columnLength) Constructs a sql type name from the given mappedName and columnLength.
static String	ensureMaximumNameLength(String name, Short nameMaxLength, String method) Trims the passed in value to the maximum name length.
static String	getForeignKeyConstraintName(EntityAssociationEnd associationEnd, String suffix, String sqlNameSeparator, String maxLengthProperty, String shortenSqlNamesMethod) Constructs and returns the foreign key constraint name for the given associationEnd, suffix, sqlNameSeparator and maxLengthProperty.
static Collection<ModelElementFacade>	getIdentifierAttributes(Entity entity, boolean follow) Gets all identifier attributes for an entity.
static Collection<ModelElementFacade>	getIdentifiers(Entity entity, boolean follow) Gets all identifiers for an entity.
static int	getPriority(Entity entity) Gets the execution priority of a specific entity, based on dependency/owning relationships, so that TestNG unit tests can be put in the proper order across all entities and CRUD methods
static String	getSqlNameFromTaggedValue(ModelElementFacade element, String name, Short nameMaxLength, Object separator, Object shortenSqlNamesMethod) Gets the SQL name.
static String	getSqlNameFromTaggedValue(ModelElementFacade element, String name, Short nameMaxLength, String suffix, Object separator, Object shortenSqlNamesMethod) Gets the SQL name.
static String	getSqlNameFromTaggedValue(String prefix, ModelElementFacade element, String name, Short nameMaxLength, Object separator, Object shortenSqlNamesMethod) Gets the SQL name.
static String	getSqlNameFromTaggedValue(String prefix, ModelElementFacade element, String name, Short nameMaxLength, String suffix, Object separator, Object shortenSqlNamesMethod) Gets the SQL name.
static PackageFacade	getTopLevelPackage(LinkedHashSet<ClassifierFacade> classifiers, boolean entityOnly) Finds the top level package in the model containing any classes or entity classes.
static List<Entity>	sortEntities(Collection<Entity> entities, boolean ascending) Puts non-abstract entities in order based on associations.
static String	toSqlName(String modelElementName, Object separator) Converts a string following the Java naming conventions to a database attribute name.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityMetafacadeUtils

public EntityMetafacadeUtils()

Method Detail

toSqlName

public static String toSqlName(String modelElementName,
               Object separator)

Converts a string following the Java naming conventions to a database attribute name. For example convert customerName to CUSTOMER_NAME.

Parameters:

modelElementName - the string to convert

separator - character used to separate words

Returns:

string converted to database attribute format

getSqlNameFromTaggedValue

public static String getSqlNameFromTaggedValue(String prefix,
                               ModelElementFacade element,
                               String name,
                               Short nameMaxLength,
                               Object separator,
                               Object shortenSqlNamesMethod)

Gets the SQL name. (i.e. column name, table name, etc.). If it can't find the corresponding tagged value with the specified name, then it uses the element name by default and just returns that.

Parameters:

prefix - the optional prefix to add to the sql name (i.e. table name prefix, etc.).

element - from which to retrieve the SQL name.

name - the name of the tagged value.

nameMaxLength - if this is not null, then the name returned will be trimmed to this length (if it happens to be longer).

separator - character used to separate words

shortenSqlNamesMethod - Method of shortening SQL Names, i.e. removeVowels

Returns:

the SQL name as a String.

getSqlNameFromTaggedValue

public static String getSqlNameFromTaggedValue(ModelElementFacade element,
                               String name,
                               Short nameMaxLength,
                               String suffix,
                               Object separator,
                               Object shortenSqlNamesMethod)

Gets the SQL name. (i.e. column name, table name, etc.). If it can't find the corresponding tagged value with the specified name, then it uses the element name by default and just returns that.

Parameters:

element - from which to retrieve the SQL name.

name - the name of the tagged value.

nameMaxLength - if this is not null, then the name returned will be trimmed to this length (if it happens to be longer).

suffix - the optional suffix to add to the sql name (i.e. foreign key suffix, etc.)

separator - character used to separate words

shortenSqlNamesMethod - Method of shortening SQL Names, i.e. removeVowels

Returns:

the SQL name as a String.

getSqlNameFromTaggedValue

public static String getSqlNameFromTaggedValue(ModelElementFacade element,
                               String name,
                               Short nameMaxLength,
                               Object separator,
                               Object shortenSqlNamesMethod)

Gets the SQL name. (i.e. column name, table name, etc.). If it can't find the corresponding tagged value with the specified name, then it uses the element name by default and just returns that.

Parameters:

element - from which to retrieve the SQL name.

name - the name of the tagged value.

nameMaxLength - if this is not null, then the name returned will be trimmed to this length (if it happens to be longer).

separator - character used to separate words

shortenSqlNamesMethod - Method of shortening SQL Names, i.e. removeVowels

Returns:

the SQL name as a String.

getSqlNameFromTaggedValue

public static String getSqlNameFromTaggedValue(String prefix,
                               ModelElementFacade element,
                               String name,
                               Short nameMaxLength,
                               String suffix,
                               Object separator,
                               Object shortenSqlNamesMethod)

Gets the SQL name. (i.e. column name, table name, etc.). If it can't find the corresponding tagged value with the specified name, then it uses the element name by default and just returns that.

Parameters:

prefix - the optional prefix to add to the sql name (i.e. table name prefix, etc.).

element - from which to retrieve the SQL name.

name - the name of the tagged value.

nameMaxLength - if this is not null, then the name returned will be trimmed to this length (if it happens to be longer).

suffix - the optional suffix to add to the sql name (i.e. foreign key suffix, etc.)

separator - character used to separate words

shortenSqlNamesMethod - Method of shortening SQL Names, i.e. removeVowels

Returns:

the SQL name as a String.

sortEntities

public static List<Entity> sortEntities(Collection<Entity> entities,
                        boolean ascending)

Puts non-abstract entities in order based on associations. To be used in constructors and tests so that entities may be created and deleted in the proper order, without violating key constraints in the database

Parameters:

entities - the entity list to be sorted.

ascending - true for entities with no associations first.

Returns:

the sorted entity list.

getPriority

public static int getPriority(Entity entity)

Gets the execution priority of a specific entity, based on dependency/owning relationships, so that TestNG unit tests can be put in the proper order across all entities and CRUD methods

Parameters:

entity - the entity to be prioritized.

Returns:

int the entity priority.

ensureMaximumNameLength

public static String ensureMaximumNameLength(String name,
                             Short nameMaxLength,
                             String method)

Trims the passed in value to the maximum name length.

If no maximum length has been set then this method does nothing.

Parameters:

name - the name length to check and trim if necessary

nameMaxLength - if this is not null, then the name returned will be trimmed to this length (if it happens to be longer).

method - Method of shortening SQL Names, i.e. removeVowels

Returns:

String the string to be used as SQL type

getIdentifiers

public static Collection<ModelElementFacade> getIdentifiers(Entity entity,
                                            boolean follow)

Gets all identifiers for an entity. If 'follow' is true, and if no identifiers can be found on the entity, a search up the inheritance chain will be performed, and the identifiers from the first super class having them will be used. If no identifiers exist, a default identifier will be created if the allowDefaultIdentifiers property is set to true.

Parameters:

entity - the entity for which to retrieve the identifiers

follow - a flag indicating whether or not the inheritance hierarchy should be followed

Returns:

the collection of entity identifier attributes.

getIdentifierAttributes

public static Collection<ModelElementFacade> getIdentifierAttributes(Entity entity,
                                                     boolean follow)

Gets all identifier attributes for an entity. If 'follow' is true, and if no identifiers can be found on the entity, a search up the inheritance chain will be performed, and the identifiers from the first super class having them will be used. All identifier association relationships are traversed to find the identifying attributes of the related associationEnd classifiers, in addition to the primitive/wrapped identifiers on the Entity itself.

Parameters:

entity - the entity for which to retrieve the identifiers

follow - a flag indicating whether or not the inheritance hierarchy should be followed

Returns:

the collection of entity identifier attributes.

constructSqlTypeName

public static String constructSqlTypeName(String typeName,
                          String columnLength)

Constructs a sql type name from the given mappedName and columnLength.

Parameters:

typeName - the actual type name (usually retrieved from a mappings file, i.e. NUMBER(19).

columnLength - the length of the column.

Returns:

the new name construct

getForeignKeyConstraintName

public static String getForeignKeyConstraintName(EntityAssociationEnd associationEnd,
                                 String suffix,
                                 String sqlNameSeparator,
                                 String maxLengthProperty,
                                 String shortenSqlNamesMethod)

Constructs and returns the foreign key constraint name for the given associationEnd, suffix, sqlNameSeparator and maxLengthProperty.

Parameters:

associationEnd - the association end for which to construct the constraint name.

suffix - the suffix appended to the constraint name (if not limited by length).

sqlNameSeparator - the SQL name separator to use (i.e. '_').

maxLengthProperty - the numeric value stored as a string indicating the max length the constraint may be.

shortenSqlNamesMethod - Method of shortening SQL Names, i.e. removeVowels

Returns:

the constructed foreign key constraint name.

clearForeignKeyConstraintNameCache

public static void clearForeignKeyConstraintNameCache()

Clears out the foreign key cache.

getTopLevelPackage

public static PackageFacade getTopLevelPackage(LinkedHashSet<ClassifierFacade> classifiers,
                               boolean entityOnly)

Finds the top level package in the model containing any classes or entity classes. Can be used to define a groupId for a model, or in code generation scripts where top level package is the starting point for further operations.

Parameters:

classifiers - Entities in the current model

entityOnly - true to find the top package containing entities

Returns:

Package at the top level