See: Description
Class | Description |
---|---|
AbstractExtensionGUI |
This is the abstract GUI class for transformation extensions.
|
AbstractTransformConfigFormPage |
This is an abstract class for clients to extend if they want to contribute
a
FormPage to the transformation configuration editor. |
AbstractTransformConfigTab |
The Abstract Transform Config Tab is the base class for all tabs that are
shown in the Transformation Configuration Manager.
|
AbstractTransformExtensionConfigTab |
This is a specialized version of the standard transformation configuration
tab to be used with transformation extensions.
|
AbstractTransformGUI |
The Abstract Transform GUI class is the base class for transformation authors
to supply custom GUI that is integrated into the Transformation Configuration
Manager.
|
OpenReportRule |
This rule opens the transformation reporting dialog to display the issues
encountered by the transformation.
|
TransformProgressMonitorDialog |
This class offers customizations required by transformations to the standard
progress monitor dialog.
|
This package provides API for customizing the UI of transformations registered with the Transformation Service.
The Transformation Service provides a generic UI for running registered transformations. Only "public" transformations can be run via this UI.
To run a transformation the user must first create a transformation configuration using the new transformation configuration wizard. The data associated with a transformation configuration is presented to the user in a set of pages. These pages also appear in the transformation configuration editor as tabs. There are several default tabs associated with every transformation:
com.ibm.xtools.transform.core.AbstractMetatype
).The API defined in this package enables the transformation author to add custom tabs for a transformation configuration and to override the default tabs if desired. In addition, the author also has the ability to perform additional filtering of available objects to be shown for the source and target selection panes.
Before a transformation author can customize the UI for a transformation, he must first inform the Transformation Service. This is easily accomplished by doing the following:
AbstractTransformGUI
and override the appropriate methods, such as getConfigurationTabs()
.
Transformation extension authors can also contribute tabs in a similar way. The class must be
derived from AbstractExtensionGUI
and the XML attribute
to set is extensionGUI.
The AbstractTransformGUI method getConfigurationTabs()
returns an array of
configuration tabs to be displayed when a configuration for the associated transformation
is selected. This list should include the three default tabs, where the Target tab usually comes
first and the Common tab comes last. Instances of these default tabs can be easily
obtained by calling the appropriate static methods defined by AbstractTransformGUI. For example,
the default Target tab is obtained by calling createUML2TargetContainerTab()
.
Each custom tab should be derived from AbstractTransformConfigTab
and be in the middle of the configuration tab list returned by getConfigurationTabs()
.
There are two key methods of this class that must be implemented:
populateContext(com.ibm.xtools.transform.core.ITransformContext
)
method saves the data from the tab's UI controls by defining one or more properties in the
context with the appropriate values. These property values should be defined in the manner expected
by the transformation when it executes.populateTab(com.ibm.xtools.transform.core.ITransformContext
)
method resets the data for the tab's UI controls by examining one or more properties defined in the
context.
Although the source and target model types defined in the transformation descriptor enable the UI to filter the available source and target objects for the transformation, the author may wish to provide additional pruning of the selection tree. There are two methods in AbstractTransformGUI for deciding if an object is to be displayed in the corresponding selection tree:
showInSourceTree()
is called before an object is added to the
transformation's source selection tree. The method enables the tree to be pruned. True
should be returned if the given object is valid or if
it might contain a valid object. The method should return false if the object and all of its contained
objects are invalid.showInTargetContainerTree()
is called before an object is added to the
transformation's target selection tree. This method prunes the object in the tree in the same
manner as the source tree.
The handleEditorSave(
method provides a way for transformations to perform additional actions after a transformation
configuration has been saved in the transformation configuration editor.com.ibm.xtools.transform.core.config.ITransformConfig
)