Configuring UML-to-Java transformations

• In the Pattern Explorer view, right-click a transformation; then click New Configuration.
• In other views, click File > New > Transformation Configuration. If Transformation Configuration is not a menu item, click File > New > Other > Transformations > Transformation Configuration.

1. In the Name field, specify a name for the configuration.
2. In the Configuration file destination field, specify the destination for the transformation configuration file. The destination is a relative path in your current workspace. You can specify a fully qualified project name or folder name. If you specify a folder in a project, you must prefix the folder name with a forward slash (/).
3. From the Transformation list, select a transformation.
   Note: To display the transformations that are installed, but not enabled, click Show all transformations. A transformation must be bound to a capability to be displayed in this list.

• If the source model is the primary engineering artifact, select Conceptual. Any changes to the source model are propagated to the target model.
• If the target model is the primary engineering artifact, click Mixed. The transformation converts the source artifacts to visual representations that are directly connected to the target artifact. Select this option to work in the target domain instead of with the source model, or to retain the artifacts for analysis. The transformation output becomes the primary engineering artifact.
• If the architecture that the source artifacts represent evolves independently from the target, select Reconciled. Selecting this option enables the reverse transformation, which you can use to compare the source and target, and to reconcile changes. You might also select this option if different teams implement, develop, or maintain the architecture.
  Note: When you select this option, additional properties become available in the "Reverse transformation" section of the Main page. For some transformations, additional options or pages become available in the transformation configuration editor. For information about configuring the reverse transformation, see the related link below.

1. In the Selected source pane, select the source element for the transformation to transform.
2. In the Selected target pane, select the destination of the transformation output. To create a new destination for the output, click Create Target Container.

• To generate getter and setter methods in the transformation output, select the Generate getter and setter methods check box. Whether the transformation generates a setter method for a UML property depends on specific values of the property in the source model.
  You can check the values of the UML property in the Properties view:

  • On the General page, if you select the property's Leaf or Read Only check box, no setter is generated. If you select the property's Derived check box, the setter implementation is empty.
  • On the Advanced page, if you set the property's Is Leaf or Is Read Only value to true, no setter is generated. If you set the property's Is Derived value to true, the setter implementation is empty.
• To generate code that is compatible with Java™ 2 Platform, Standard Edition (J2SE) 5.0, select the Generate code that is compatible with J2SE 5.0 check box. If you clear this option, the transformation generates code that is compatible with versions of J2SE 1.4. This check box is available only when you configure a UML-to-Java transformation.
• To save only the files that change after you run the transformations, select the Write only the updated files to disk check box.

  If you select this option and are working with large models, you might experience a decrease in performance because the transformation must determine the files that it updated, and remove the files that it did not update from its in-memory list. If you work in a team environment, you might also select this check box to eliminate unnecessary checkout operations and the reversal of checkout operations.

  If you clear this check box, the transformation does not remove the unchanged files from its in-memory list. After the transformation runs, it attempts to write the changed and unchanged files to disk. In a team environment, you might have to manually reverse the checkout operations for files that the transformation did not update.

• To add a Java project dependency to the target project, select the Generate Java project dependencies check box.

  This option is available when you create a Java-to-UML association file on the Java-to-UML Associations page. If you select this check box, when the UML-to-Java transformation encounters a UML reference, the transformation compares the reference to the Java-to-UML association model. If the UML reference maps to a Java project that is not the current target of the transformation, the transformation adds a Java project dependency to the target project.

• If you are editing a UML-to-Java transformation configuration, select an option in the Delete obsolete generated files section.
• If you are editing a UML-to-Java (deprecated) transformation configuration, on the Properties page, select an option in the Delete obsolete generated files section.

When the UML-to-Java transformation generates classes, operations, and fields, it assigns the @generated tag to these elements. The next time that you run the transformation, the transformation overwrites these elements. When you delete elements from the source model and rerun the UML-to-Java transformation, the transformation deletes previously generated fields and methods that still have the @generated tag and that no longer have a corresponding source model element. However, for files that the transformation generates, you can specify whether or not to delete files.

The log file provides information about the source elements, the target elements, and the rules that the transformation applies to transform the source elements. If the transformation transforms many elements, you might experience decreased performance while the transformation generates the log file; therefore, you should only generate a log file for debugging purposes.

Running a transformation in silent mode suppresses all dialog boxes that the transformation generates. The transformation applies default rules and behavior, which might generate unexpected or incorrect transformation output. You should only run a transformation in silent mode to validate that the transformation runs, instead of validating the transformation output. For example, you might run a transformation in silent mode as part of an automated task or automated test suite.

Setting the transformation to run in silent mode overrides the file-overwrite options that you specify, and overwrites files if necessary.

If the Java-to-UML transformation is available, you can select the Run the reverse transformation silently check box. Specifying that the Java-to-UML, or reverse transformation runs in silent mode suppresses the merge editor. If a conflict occurs during the merge, the transformation stops and you must rerun the transformation with the silent options cleared.

You can use trace relationships and the visual development tools to understand the relationships between source model elements and transformation output. This function is useful in large projects that might contain multiple models and transformation configurations. The transformation does not alter the source model.

• On the Extensions page, select or clear the check boxes for the transformation extensions to enable or disable.

  To generate Java enumerations that preserve the name and values of the enumeration literals, select the com.ibm.xtools.transform.java.enumext.u2j.transform check box. The names and values of the enumeration literals are generated as strings that can be retrieved.

  To generate Java code for passive class state machines, select the com.ibm.xtools.transform.uml2.java.sm.PassiveClassStatemachine check box. After the transformation runs, you can run the generated state machine code as a Java application.

• On the Collections page, from each list of UML collection types, select a Java collection type. To specify a custom value, type the value in the appropriate collection field. For more information about UML collection types, see the related concept topic for this transformation.

1. In the Java-to-UML association file name field, specify a file name.
2. In the Java-to-UML Associations section, beside the table, click the buttons to add or remove an association from the file.

1. In the transformation configuration editor, on the Mapping page, select the Enable the mapping functionality for this configuration check box.
2. In the Mapping model file name field, specify the name of a new or existing mapping model.