org.andromda.cartridges.ejb3.metafacades

Class EJB3MetafacadeUtils

java.lang.Object

org.andromda.cartridges.ejb3.metafacades.EJB3MetafacadeUtils

 class EJB3MetafacadeUtils
extends Object

Contains utilities for use with EJB metafacades.

Author:

Chad Brandon, Vance Karimi

Constructor Summary

Constructors

Constructor and Description
EJB3MetafacadeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static boolean	allowSyntheticCreateMethod(ClassifierFacade classifier) Returns true/false based on whether or not synthetic or auto generated create methods should be allowed.
(package private) static String	buildAnnotationMultivalueParameter(String name, Collection<String> values) Builds a multi valued parameter string
(package private) static String	buildAnnotationMultivalueParameter(String name, Collection<String> values, boolean areStrings) Builds a multi valued parameter string
(package private) static String	buildAnnotationMultivalueParameter(String name, Collection<String> values, boolean areStrings, String suffix) Builds a multi option string Builds a multi valued parameter string
(package private) static String	buildAnnotationParameters(Collection<String> parameters) Builds an annotation parameter line
(package private) static String	convertTransactionType(String transType) Convert the transaction type from lower casing to upper casing.
(package private) static List<AttributeFacade>	getAllInstanceAttributes(ClassifierFacade classifier) Gets all instance attributes including those instance attributes belonging to the classifier and any inherited ones.
(package private) static Collection<AttributeFacade>	getConstants(ClassifierFacade classifier, boolean follow) Gets all constants for the specified classifier.
(package private) static Collection<OperationFacade>	getCreateMethods(ClassifierFacade classifier, boolean follow) Gets all create methods for the given classifier.
(package private) static Collection<AttributeFacade>	getEnvironmentEntries(ClassifierFacade classifier, boolean follow) Gets all environment entries for the specified classifier.
(package private) static String	getFullyQualifiedName(String packageName, String name, String suffix) Creates a fully qualified name from the given packageName, name, and suffix.
(package private) static String	getHomeInterfaceName(ClassifierFacade classifier) Gets the interface name for the passed in classifier.
(package private) static List<AttributeFacade>	getInheritedInstanceAttributes(ClassifierFacade classifier) Gets all the inherited instance attributes, excluding the instance attributes directory from this classifier.
(package private) static String	getSeamComponentName(ClassifierFacade classifier) Returns the Seam component name.
(package private) static String	getSeamComponentScopeType(ClassifierFacade classifier, boolean stateless) Gets the Seam component scope type for Entity and Session beans.
static String	getSqlNameFromTaggedValue(String prefix, EJB3AssociationFacade element, String name, Short nameMaxLength, String suffix, Object separator, Object shortenSqlNameMethod) Gets the SQL name.
(package private) static String	getTransactionType(ClassifierFacade classifier, String defaultTransactionType) Returns the transaction type for the specified classifier.
(package private) static String	getViewType(ClassifierFacade classifier, String defaultViewType) Gets the view type for the passed in classifier.
(package private) static boolean	isSeamComponent(ClassifierFacade classifier) Returns true if the Seam stereotype is modeled on the class.

Methods inherited from class java.lang.Object

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

Constructor Detail

EJB3MetafacadeUtils

EJB3MetafacadeUtils()

Method Detail

getCreateMethods

static Collection<OperationFacade> getCreateMethods(ClassifierFacade classifier,
                                           boolean follow)

Gets all create methods for the given classifier.

Parameters:

classifier - The classifier from which to retries the create methods

follow - if true, all super type create methods are also retrieved

Returns:

collection of create methods found.

getHomeInterfaceName

static String getHomeInterfaceName(ClassifierFacade classifier)

Gets the interface name for the passed in classifier. Returns 'LocalHome' if the mode element has the entity stereotype, returns 'Home' otherwise.

Parameters:

classifier -

Returns:

the interface name.

getViewType

static String getViewType(ClassifierFacade classifier,
                 String defaultViewType)

Gets the view type for the passed in classifier. If no view type can be retrieved from the classifier, then the defaultViewType is returned. If session ejb pojo then checks the ejb tagged value and if there is no value defined, returns 'remote'.

Parameters:

classifier - The classifier to lookup the view type tagged value

defaultViewType - The default view type if one is not found

Returns:

String the view type name.

getInheritedInstanceAttributes

static List<AttributeFacade> getInheritedInstanceAttributes(ClassifierFacade classifier)

Gets all the inherited instance attributes, excluding the instance attributes directory from this classifier.

Parameters:

classifier - the ClassifierFacade from which to retrieve the inherited attributes.

Returns:

a list of ordered attributes.

getAllInstanceAttributes

static List<AttributeFacade> getAllInstanceAttributes(ClassifierFacade classifier)

Gets all instance attributes including those instance attributes belonging to the classifier and any inherited ones.

Parameters:

classifier - the ClassifierFacade from which to retrieve the instance attributes.

Returns:

the list of all instance attributes.

getEnvironmentEntries

static Collection<AttributeFacade> getEnvironmentEntries(ClassifierFacade classifier,
                                                boolean follow)

Gets all environment entries for the specified classifier. If follow is true, then a search up the inheritance hierarchy will be performed and all super type environment entries will also be retrieved.

Parameters:

classifier - the classifier from which to retrieve the env-entries

follow - true/false on whether or not to 'follow' the inheritance hierarchy when retrieving the env-entries.

Returns:

the collection of environment entries

getTransactionType

static String getTransactionType(ClassifierFacade classifier,
                        String defaultTransactionType)

Returns the transaction type for the specified classifier.

Parameters:

classifier - the classifier from which to retrieve the transaction type.

defaultTransactionType - the default transaction type if no tagged value is specified.

Returns:

the transaction type as a String.

convertTransactionType

static String convertTransactionType(String transType)

Convert the transaction type from lower casing to upper casing. This maintains reusable tagged value enumeration from EJB implementation.

Parameters:

transType -

Returns:

transactionType

getConstants

static Collection<AttributeFacade> getConstants(ClassifierFacade classifier,
                                       boolean follow)

Gets all constants for the specified classifier. If follow is true, then a search up the inheritance hierarchy will be performed and all super type constants will also be retrieved.

Parameters:

classifier - the classifier from which to retrieve the constants

follow - true/false on whether or not to 'follow' the inheritance hierarchy when retrieving the constants.

Returns:

the collection of environment entries

allowSyntheticCreateMethod

static boolean allowSyntheticCreateMethod(ClassifierFacade classifier)

Returns true/false based on whether or not synthetic or auto generated create methods should be allowed.

Parameters:

classifier - The entity or session bean.

Returns:

true/false

getFullyQualifiedName

static String getFullyQualifiedName(String packageName,
                           String name,
                           String suffix)

Creates a fully qualified name from the given packageName, name, and suffix.

Parameters:

packageName - the name of the model element package.

name - the name of the model element.

suffix - the suffix to append.

Returns:

the new fully qualified name.

isSeamComponent

static boolean isSeamComponent(ClassifierFacade classifier)

Returns true if the Seam stereotype is modeled on the class.

Parameters:

classifier - The classifier to lookup if the stereotype is modeled

Returns:

True is stereotype exists, false otherwise

getSeamComponentScopeType

static String getSeamComponentScopeType(ClassifierFacade classifier,
                               boolean stateless)

Gets the Seam component scope type for Entity and Session beans. If no scope has been specified: If the Classifier is a stateless session bean, then returns STATELESS If the Classifier is an entity or stateful session bean, then returns CONVERSATION

Parameters:

classifier - The classifier to lookup the scope type tagged value

stateless - Whether the classifier is a stateless session bean

Returns:

The scope type as a String

getSeamComponentName

static String getSeamComponentName(ClassifierFacade classifier)

Returns the Seam component name. Can override using tagged value, otherwise just the class name.

Parameters:

classifier - The classifier to get the tagged value or the name from.

Returns:

The Seam component name

buildAnnotationParameters

static String buildAnnotationParameters(Collection<String> parameters)

Builds an annotation parameter line

Parameters:

parameters - The parameters

Returns:

The parameter line

buildAnnotationMultivalueParameter

static String buildAnnotationMultivalueParameter(String name,
                                        Collection<String> values)

Builds a multi valued parameter string

Parameters:

name - The name of the parameter

values - The values for the parameters

Returns:

The parameter string

buildAnnotationMultivalueParameter

static String buildAnnotationMultivalueParameter(String name,
                                        Collection<String> values,
                                        boolean areStrings)

Builds a multi valued parameter string

Parameters:

name - The name of the parameter

values - The values for the parameters

areStrings - If the values are strings then surround with " sign

Returns:

The parameter string

buildAnnotationMultivalueParameter

static String buildAnnotationMultivalueParameter(String name,
                                        Collection<String> values,
                                        boolean areStrings,
                                        String suffix)

Builds a multi option string Builds a multi valued parameter string

Parameters:

name - The name of the parameter

values - The values for the parameters

areStrings - If the values are strings then surround with " sign

suffix - Any suffix to add to the values

Returns:

The parameter string

getSqlNameFromTaggedValue

public static String getSqlNameFromTaggedValue(String prefix,
                               EJB3AssociationFacade element,
                               String name,
                               Short nameMaxLength,
                               String suffix,
                               Object separator,
                               Object shortenSqlNameMethod)

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

shortenSqlNameMethod - The method used to shorten the name, i.e. removeVowels

Returns:

the SQL name as a String.