SpringUtils (AndroMDA Spring Cartridge 3.5-SNAPSHOT API)

java.lang.Object
- org.andromda.cartridges.spring.SpringUtils

```
public class SpringUtils
extends Object
```
Contains utilities used within the Spring cartridge.

Author:

Chad Brandon, Joel Kozikowski

Constructor Summary

Constructors
Constructor and Description

SpringUtils()

Constructors
Constructor and Description
`SpringUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`concatNamesCamelCase(Collection<String> names)` Takes the given `names` and concatenates them in camel case form.
`List<ModelElementFacade>`	`filterUniqueByName(Collection<ModelElementFacade> modelElements)` Returns an ordered set containing the argument model elements, model elements with a name that is already used by another model element in the argument collection will not be returned.
`String`	`formatHibernateQueryParameterValue(ClassifierFacade type, String value)` Formats the given type to the appropriate Hibernate query parameter value.
`Collection<Role>`	`getAllRoles(Collection<Service> services)` Retrieves all roles from the given `services` collection.
`String`	`getClassName(String fullyQualifiedName)` Returns the class name part of a fully qualified name
`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`	`getFullyQualifiedClassName(String packageName, String name)` Constructs the fully qualified class name from the packageName and name.
`String`	`getPackageName(String fullyQualifiedName)` Returns the package name part of a fully qualified name
`static List<String>`	`getRooClass(ClassifierFacade facade)` Constructs the fully qualified class definition from the facade.
`static List<String>`	`getRooEntity(Entity entity, String recordType)` Constructs the fully qualified class name from the packageName and name.
`static String`	`getRooEntityName(Entity entity)` Constructs the fully qualified class name from the packageName and name.
`static List<String>`	`getRooEnum(EnumerationFacade facade)` Constructs the fully qualified class definition from the facade.
`static String`	`getRooField(ModelElementFacade facade)` Constructs the fully qualified class name from the packageName and name.
`String`	`getSpringPropertyValue(String value)` Based on the given `value`, this method will return a formatted Spring property (including the handling of 'null').
`boolean`	`isRichClient()` Returns TRUE if code is being generated for a rich client environment
`boolean`	`lingoRemotableServicesPresent(Collection<Service> services)` Indicates if any remotable services using Lingo are present.
`boolean`	`localEjbsPresent(Collection<Service> services)` Indicates if any local EJBs are present in the collection of services.
`boolean`	`privateServicesPresent(Collection<Service> services)` Indicates if any private services are present.
`boolean`	`publicServicesPresent(Collection<Service> services)` Indicates if any public (non private) services are present.
`boolean`	`remotableServicesPresent(Collection<Service> services)` Indicates if any Spring remotable services are present.
`boolean`	`remoteEjbsPresent(Collection<Service> services)` Indicates if any remote EJBs are present in the collection of services.
`String`	`removeGenerics(String parameter)` Removes generics from string.
`void`	`setRichClient(boolean richClientProperty)` Sets if code is being generated for a rich client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpringUtils
```
public SpringUtils()
```
- Method Detail
  - getAllRoles
```
public Collection<Role> getAllRoles(Collection<Service> services)
```
    Retrieves all roles from the given services collection.
    
    Parameters:
    services - the collection services.
    
    Returns:
    all roles from the collection.
  - remoteEjbsPresent
```
public boolean remoteEjbsPresent(Collection<Service> services)
```
    Indicates if any remote EJBs are present in the collection of services.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - localEjbsPresent
```
public boolean localEjbsPresent(Collection<Service> services)
```
    Indicates if any local EJBs are present in the collection of services.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - remotableServicesPresent
```
public boolean remotableServicesPresent(Collection<Service> services)
```
    Indicates if any Spring remotable services are present.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - lingoRemotableServicesPresent
```
public boolean lingoRemotableServicesPresent(Collection<Service> services)
```
    Indicates if any remotable services using Lingo are present.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - privateServicesPresent
```
public boolean privateServicesPresent(Collection<Service> services)
```
    Indicates if any private services are present.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - publicServicesPresent
```
public boolean publicServicesPresent(Collection<Service> services)
```
    Indicates if any public (non private) services are present.
    
    Parameters:
    services - the collection of services to check.
    
    Returns:
    true/false.
  - getSpringPropertyValue
```
public String getSpringPropertyValue(String value)
```
    Based on the given value, this method will return a formatted Spring property (including the handling of 'null').
    
    Parameters:
    value - the value from which to create the spring value.
    
    Returns:
    the spring value.
  - removeGenerics
```
public String removeGenerics(String parameter)
```
    Removes generics from string. Currently used to strip generics from ejb-jar.xml method parameters.
    
    Parameters:
    parameter - String containing generics
    
    Returns:
    String with generics stripped
  - setRichClient
```
public void setRichClient(boolean richClientProperty)
```
    Sets if code is being generated for a rich client.
    
    Parameters:
    richClientProperty -
  - isRichClient
```
public boolean isRichClient()
```
    Returns TRUE if code is being generated for a rich client environment
    
    Returns:
    richClient
  - getClassName
```
public String getClassName(String fullyQualifiedName)
```
    Returns the class name part of a fully qualified name
    
    Parameters:
    fullyQualifiedName -
    
    Returns:
    just the "class name" part of the fully qualified name
  - getPackageName
```
public String getPackageName(String fullyQualifiedName)
```
    Returns the package name part of a fully qualified name
    
    Parameters:
    fullyQualifiedName -
    
    Returns:
    just the "package" part of the fully qualified name
  - filterUniqueByName
```
public List<ModelElementFacade> filterUniqueByName(Collection<ModelElementFacade> modelElements)
```
    Returns an ordered set containing the argument model elements, model elements with a name that is already used by another model element in the argument collection will not be returned. The first operation with a name not already encountered will be returned, the order inferred by the argument's iterator will determine the order of the returned list.
    
    Parameters:
    modelElements - a collection of model elements, elements that are not model elements will be ignored
    
    Returns:
    the argument model elements without, elements with a duplicate name will only be recorded once
  - formatHibernateQueryParameterValue
```
public String formatHibernateQueryParameterValue(ClassifierFacade type,
                                        String value)
```
    Formats the given type to the appropriate Hibernate query parameter value.
    
    Parameters:
    type - the type of the Hibernate query parameter.
    value - the current value to format.
    
    Returns:
    the formatted value.
  - concatNamesCamelCase
```
public static String concatNamesCamelCase(Collection<String> names)
```
    Takes the given names and concatenates them in camel case form.
    
    Parameters:
    names - the names to concatenate.
    
    Returns:
    the result of the concatenation
  - getFullyQualifiedClassName
```
public static String getFullyQualifiedClassName(String packageName,
                                String name)
```
    Constructs the fully qualified class name from the packageName and name.
    
    Parameters:
    packageName - the package name to which the class belongs.
    name - the name of the class.
    
    Returns:
    the fully qualified name.
  - getRooEnum
```
public static List<String> getRooEnum(EnumerationFacade facade)
```
    Constructs the fully qualified class definition from the facade. Used for ValueObject, EmbeddedValue
    
    Parameters:
    facade - the class to construct the roo field definition.
    
    Returns:
    the Roo class definition.
  - getRooClass
```
public static List<String> getRooClass(ClassifierFacade facade)
```
    Constructs the fully qualified class definition from the facade. Used for ValueObject, EmbeddedValue
    
    Parameters:
    facade - the class to construct the roo field definition.
    
    Returns:
    the Roo class definition.
  - getRooEntityName
```
public static String getRooEntityName(Entity entity)
```
    Constructs the fully qualified class name from the packageName and name. Removes the words 'Test' and 'TestCase' because Roo cannot create tests for Entities with those names.
    
    Parameters:
    entity - the entity to construct the roo script definition.
    
    Returns:
    the Roo field definition.
  - getRooEntity
```
public static List<String> getRooEntity(Entity entity,
                        String recordType)
```
    Constructs the fully qualified class name from the packageName and name.
    
    Parameters:
    entity - the entity to construct the roo script definition.
    recordType - Either 'dao' or 'repository'
    
    Returns:
    the Roo field definition.
  - getRooField
```
public static String getRooField(ModelElementFacade facade)
```
    Constructs the fully qualified class name from the packageName and name.
    
    Parameters:
    facade - the property (attribute or associationEnd) to construct the roo field definition.
    
    Returns:
    the Roo field definition.
  - getDate
```
public static String getDate(String format)
```
    Returns the current Date in the specified format. $conversionUtils does not seem to work in vsl.
    
    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 .

Class SpringUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpringUtils

Method Detail

getAllRoles

remoteEjbsPresent

localEjbsPresent

remotableServicesPresent

lingoRemotableServicesPresent

privateServicesPresent

publicServicesPresent

getSpringPropertyValue

removeGenerics

setRichClient

isRichClient

getClassName

getPackageName

filterUniqueByName

formatHibernateQueryParameterValue

concatNamesCamelCase

getFullyQualifiedClassName

getRooEnum

getRooClass

getRooEntityName

getRooEntity

getRooField

getDate

getDate