org.andromda.cartridges.ejb3

Class EJB3ScriptHelper

java.lang.Object

org.andromda.cartridges.ejb3.EJB3ScriptHelper

public class EJB3ScriptHelper
extends Object

Transform class for the EJB3 cartridge.

Author:

Richard Kunze, Chad Brandon, Vance Karimi, Michail Plushnikov

Constructor Summary

Constructors

Constructor and Description
EJB3ScriptHelper()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<EJB3EntityAttributeFacade>	filterAuditAttributes(Collection<EJB3EntityAttributeFacade> list, boolean jpaFramework) Filter a list of EntityAttributes by removing all audit attributes.
Collection<ModelElementFacade>	filterByVisibility(Collection<ModelElementFacade> list, String visibility) Filter a list of model elements by visibility.
Collection<EJB3AssociationEndFacade>	filterRequiredAssociations(Collection<EJB3AssociationEndFacade> list, boolean isCompositePKPresent) Filter a list of EntityAssociationEnds by removing all non-required AssociationEnds.
Collection<EJB3EntityAttributeFacade>	filterRequiredAttributes(Collection<EJB3EntityAttributeFacade> list, boolean isCompositePKPresent) Filter a list of EntityAttributes by removing all non-required attributes.
Collection<EJB3EntityAttributeFacade>	filterUpdatableAttributes(Collection<EJB3EntityAttributeFacade> list, boolean isCompositePKPresent) Filter a list of EntityAttributes by removing all non-updatable attributes.
Collection<String>	getArgumentsAsList(String args) Create a collection of String objects representing the argument names.
String	getInterceptorsAsList(Collection<ModelElementFacade> interceptors, String prepend) Returns the comma separated list of interceptor classes.
String	removeQuotationmarks(String pValue) Removes instances of the quotation marks (" and ') at the beginning and end of the value argument
static String	reversePackage(String packageName) Reverses the packageName.
String	toUnderscoreName(String name) Replaces all instances of the dot (.) in the name argument with an underscore (_) and returns the string response.

Methods inherited from class java.lang.Object

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

Constructor Detail

EJB3ScriptHelper

public EJB3ScriptHelper()

Method Detail

getArgumentsAsList

public Collection<String> getArgumentsAsList(String args)

Create a collection of String objects representing the argument names.

Parameters:

args - A comma separated list of arguments

Returns:

Collection A collection of of Strings representing the arguments

filterByVisibility

public Collection<ModelElementFacade> filterByVisibility(Collection<ModelElementFacade> list,
                                                String visibility)

Filter a list of model elements by visibility.

Parameters:

list - the original list

visibility - the visibility - "public" "protected", "private" or the empty string (for package visibility)

Returns:

a list with all elements from the original list that have a matching visibility.

filterUpdatableAttributes

public Collection<EJB3EntityAttributeFacade> filterUpdatableAttributes(Collection<EJB3EntityAttributeFacade> list,
                                                              boolean isCompositePKPresent)

Filter a list of EntityAttributes by removing all non-updatable attributes. This filter currently removes all attributes that are of stereotype Version It also removes identifier attributes for an entity with a composite primary key class or if the identifier attribute has a specified generator.

Parameters:

list - The original list

isCompositePKPresent - True if entity has a composite primary key

Returns:

Collection A list of EntityAttributes from the original list that are updatable

filterAuditAttributes

public Collection<EJB3EntityAttributeFacade> filterAuditAttributes(Collection<EJB3EntityAttributeFacade> list,
                                                          boolean jpaFramework)

Filter a list of EntityAttributes by removing all audit attributes. This filter currently removes all attributes that are of stereotype Version It also removes identifier attributes for an entity with a composite primary key class or if the identifier attribute have a specified generator.

Parameters:

list - The original list

jpaFramework - If using a JPA auditing framework. Filter none if not using it.

Returns:

Collection A list of EntityAttributes from the original list that are updatable

filterRequiredAttributes

public Collection<EJB3EntityAttributeFacade> filterRequiredAttributes(Collection<EJB3EntityAttributeFacade> list,
                                                             boolean isCompositePKPresent)

Filter a list of EntityAttributes by removing all non-required attributes. This filter currently removes all attributes that are of stereotype Version It also removes identifier attributes for an entity with a composite primary key class or if the identifier attribute have a specified generator.

Parameters:

list - The original list

isCompositePKPresent - True if entity has a composite primary key

Returns:

Collection A list of EntityAttributes from the original list that are updatable

filterRequiredAssociations

public Collection<EJB3AssociationEndFacade> filterRequiredAssociations(Collection<EJB3AssociationEndFacade> list,
                                                              boolean isCompositePKPresent)

Filter a list of EntityAssociationEnds by removing all non-required AssociationEnds. It also removes identifier AssociationEnds for an entity with a composite primary key class

Parameters:

list - The original list

isCompositePKPresent - True if entity has a composite primary key

Returns:

Collection A list of EntityAssociationEnds from the original list that are updatable

toUnderscoreName

public String toUnderscoreName(String name)

Replaces all instances of the dot (.) in the name argument with an underscore (_) and returns the string response.

Parameters:

name - The name, typically a fully qualified name with dot notation

Returns:

The string with all dots replaced with underscore.

removeQuotationmarks

public String removeQuotationmarks(String pValue)

Removes instances of the quotation marks (" and ') at the beginning and end of the value argument

Parameters:

pValue - The value, which can contains leading and trailing quotation marks

Returns:

The string without quotation marks

getInterceptorsAsList

public String getInterceptorsAsList(Collection<ModelElementFacade> interceptors,
                           String prepend)

Returns the comma separated list of interceptor classes.

Parameters:

interceptors - The collection ModelElementFacade elements representing the interceptors

prepend - Prefix any interceptors to the comma separated list

Returns:

String containing the comma separated fully qualified class names

reversePackage

public static String reversePackage(String packageName)

Reverses the packageName.

Parameters:

packageName - the package name to reverse.

Returns:

the reversed package name.