Wiki source code of Transformation Mapping (KTM)
Version 23.10 by Alexander Schulz-Rosengarten on 2023/09/11 16:17
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
5.1 | 1 | = KTM - KIELER Transformation Mapping = |
| 2 | |||
| |
22.1 | 3 | {{panel bgColor="orange" title="Deprecated since 0.12"}} |
| |
21.1 | 4 | This article is deprecated. The described features are no longer available in current releases. |
| 5 | |||
| 6 | KTM was redesigned is now available as KiTT included in KiCool. | ||
| |
17.1 | 7 | {{/panel}} |
| 8 | |||
| |
18.1 | 9 | \\ |
| |
6.1 | 10 | |
| |
7.1 | 11 | === Topics === |
| |
6.1 | 12 | |
| 13 | |||
| |
7.1 | 14 | |
| |
6.1 | 15 | {{toc maxLevel="2" minLevel="2"/}} |
| 16 | |||
| 17 | This subproject provides a tracing mechanism for arbitary model-elements across multiple model transformations, based on EMF. | ||
| 18 | |||
| |
8.1 | 19 | The main propose of KTM is to allow bidirectional information transfer between abstract models and their resultant transformed models. |
| |
6.1 | 20 | |
| 21 | ---- | ||
| 22 | |||
| 23 | == Transformation Tree Model == | ||
| 24 | |||
| |
18.1 | 25 | \\ |
| |
6.1 | 26 | |
| 27 | To offer a mapping between model-elements during multiple transformations KTM introduces a model called TransformationTree to represent these relations. | ||
| 28 | |||
| 29 | It is based on an EMF-Metamodel. | ||
| 30 | |||
| |
7.1 | 31 | [[image:attach:als-ktmt-metamodel.png]] |
| |
6.1 | 32 | |
| 33 | The structure of the model can be separated into two parts. | ||
| 34 | |||
| |
11.1 | 35 | **First part** (upper half) is a tree of transformations. Each ModelWrapper-class is a representation of a model which is transformed. So ModelWrapper are nodes and ModelTransformations are edges. Thus the ModelWrapper representing the initial-source-model of all transformation is also the root of a TransformationTree-model. |
| |
6.1 | 36 | |
| |
11.1 | 37 | **Second part** (lower half) is object-mapping. Instances of models contain EObjects as their elements, which are represented by EObjectWrapper-class in this metamodel. The EObjectWrapper of two models are connected with EObjectTransformations-class to express their origination relationship in corresponding model transformation. |
| |
6.1 | 38 | |
| |
18.1 | 39 | \\ |
| |
6.1 | 40 | |
| 41 | An abstract example of an instance of this model: | ||
| 42 | |||
| |
7.1 | 43 | [[image:attach:abstract_example_tree.png]] |
| |
6.1 | 44 | |
| 45 | ---- | ||
| 46 | |||
| 47 | == Extensions == | ||
| 48 | |||
| 49 | Two classes are provided by this project to extend functionality of the core model. | ||
| 50 | |||
| |
7.1 | 51 | === TransformationMapping ([[JavaDoc>>attach:TransformationMapping.html]]) === |
| |
6.1 | 52 | |
| |
8.1 | 53 | The main propose of this class is generation of a object-mapping during transformation process. |
| |
6.1 | 54 | |
| |
8.1 | 55 | Therefor it provides different functions for incremental registering of single parent-child-relations between EObjects. |
| |
6.1 | 56 | |
| 57 | Furthermore, the extension allows to extract the mapping and check completeness of mapped elements against content of transformed models. | ||
| 58 | |||
| |
7.1 | 59 | === TransformationTreeExtensions ([[JavaDoc>>attach:TransformationTreeExtensions.html]]) === |
| |
6.1 | 60 | |
| |
7.1 | 61 | This class provides all functionalities to easily traverse and search in a TransformationTree. |
| |
6.1 | 62 | |
| 63 | Furthermore, it allows to modify trees by creating, deleting or appending new transformations and transformed models. | ||
| 64 | |||
| |
8.1 | 65 | Additionally this extension provides functionality to extract a concrete mapping between two arbitary model intances from a TransformationTree. |
| 66 | |||
| |
6.1 | 67 | ---- |
| 68 | |||
| 69 | == Implementation Details == | ||
| 70 | |||
| |
11.1 | 71 | * All references to EObjects in EObjectWrapper are references to a copy of the original EObject. This allows to represent immutable mapping. To reidentify corresponding EObjects TransformationTreeExtensions provides search functions which will check for structural matching models. |
| 72 | * Models in TransformationTrees may be transient. This indicates that all references to EObjects in all Elements of the transient model are removed. Thus these models can't be source of a new appended transformation and can not be associated with it's original model. The main propose of this feature is to improve scalability of TransformationTrees by removing unnecessary references to internal model, but preserve traversing functionality of the object-mapping. | ||
| |
9.1 | 73 | * Mappings can be incomplete causing resulting transfromation tree to be incomplete. A incomplete tree does not represent every object in a model with a corresponding Element. This may break some paths of element transformations, but allows to omit model-immanent objects like annotations from mapping. TranformationMapping extension provies a function to check completeness of mapping against its models. |
| |
6.1 | 74 | |
| |
7.1 | 75 | ---- |
| |
6.1 | 76 | |
| 77 | == Example == | ||
| 78 | |||
| |
12.1 | 79 | In this example we will perform some transformations on SCCharts. |
| 80 | |||
| 81 | The source chart is a ABO, the "Hello World" of SCCharts. | ||
| 82 | |||
| 83 | ABO is already a CoreSCChart, so we will perform normalization and a transformation to SCG. | ||
| 84 | |||
| |
10.1 | 85 | === Creating Mapping during Transformation === |
| 86 | |||
| |
12.1 | 87 | In order to note every single element transformation of a model transformation, we use the TransformationMapping extension. |
| |
10.1 | 88 | |
| |
12.1 | 89 | After each creation of new Objects for transformed model the mapping must be updated with it's origin information. |
| 90 | |||
| 91 | The codeblock blow show a snipped of SCChartCoreTransformation with additional mapping registration. | ||
| 92 | |||
| |
18.1 | 93 | \\ |
| |
12.1 | 94 | |
| |
18.1 | 95 | {{code language="java" theme="Eclipse" firstline="1" title="transformTriggerEffect CodeSnipped" linenumbers="true" collapse="true"}} |
| |
12.1 | 96 | ... |
| 97 | @Inject | ||
| |
10.1 | 98 | extension TransformationMapping |
| |
12.1 | 99 | |
| 100 | ... | ||
| 101 | |||
| |
11.1 | 102 | // NEW - Mapping access delegation |
| |
10.1 | 103 | def extractMapping() { |
| 104 | extractMappingData; | ||
| 105 | } | ||
| |
12.1 | 106 | |
| 107 | ... | ||
| 108 | |||
| |
10.1 | 109 | //------------------------------------------------------------------------- |
| 110 | //-- S P L I T T R A N S I T I O N -- | ||
| 111 | //------------------------------------------------------------------------- | ||
| 112 | // For every transition T that has both, a trigger and an effect do the following: | ||
| 113 | // For every effect: | ||
| 114 | // Create a conditional C and add it to the parent of T's source state S_src. | ||
| 115 | // create a new true triggered immediate effect transition T_eff and move all effects of T to T_eff. | ||
| 116 | // Set the T_eff to have T's target state. Set T to have the target C. | ||
| 117 | // Add T_eff to C's outgoing transitions. | ||
| 118 | def Region transformTriggerEffect(Region rootRegion) { | ||
| |
11.1 | 119 | clearMapping; //NEW - clear previous mapping information to assure a single consistent mapping |
| |
10.1 | 120 | // Clone the complete SCCharts region |
| 121 | var targetRootRegion = rootRegion.mappedCopy; //NEW - mapping information (changed copy to mappedCopy) | ||
| 122 | // Traverse all transitions | ||
| 123 | for (targetTransition : targetRootRegion.getAllContainedTransitions) { | ||
| 124 | targetTransition.transformTriggerEffect(targetRootRegion); | ||
| 125 | } | ||
| |
12.1 | 126 | val completeness = checkMappingCompleteness(rootRegion, targetRootRegion); //NEW - DEBUG |
| 127 | targetRootRegion; | ||
| |
10.1 | 128 | } |
| 129 | def void transformTriggerEffect(Transition transition, Region targetRootRegion) { | ||
| |
12.1 | 130 | // Only apply this to transition that have both, a trigger (or is a termination) and one or more effects |
| 131 | if (((transition.trigger != null || !transition.immediate || transition.typeTermination) && !transition.effects.nullOrEmpty) || | ||
| |
11.1 | 132 | transition.effects.size > 1) { |
| |
10.1 | 133 | val targetState = transition.targetState |
| 134 | val parentRegion = targetState.parentRegion | ||
| 135 | val transitionOriginalTarget = transition.targetState | ||
| 136 | var Transition lastTransition = transition | ||
| |
12.1 | 137 | val firstEffect = transition.effects.head |
| |
10.1 | 138 | for (effect : transition.effects.immutableCopy) { |
| |
12.1 | 139 | // Optimization: Prevent transitions without a trigger |
| 140 | if(transition.immediate && transition.trigger == null && firstEffect == effect) { | ||
| 141 | // skip | ||
| 142 | } else { | ||
| 143 | val effectState = parentRegion.createState(GENERATED_PREFIX + "S") | ||
| 144 | effectState.mapParents(transition.mappedParents); //NEW - mapping information | ||
| 145 | effectState.uniqueName | ||
| 146 | val effectTransition = createImmediateTransition.addEffect(effect) | ||
| 147 | effectTransition.mapParents(transition.mappedParents); //NEW - mapping information | ||
| 148 | |||
| 149 | effectTransition.setSourceState(effectState) | ||
| 150 | lastTransition.setTargetState(effectState) | ||
| 151 | lastTransition = effectTransition | ||
| 152 | } | ||
| |
10.1 | 153 | } |
| 154 | lastTransition.setTargetState(transitionOriginalTarget) | ||
| 155 | } | ||
| 156 | } | ||
| 157 | {{/code}} | ||
| 158 | |||
| |
12.1 | 159 | === Create TransformationTree === |
| |
10.1 | 160 | |
| |
12.1 | 161 | The following code will now perform each transformation stepwise and updates a transformation tree each step. |
| |
10.1 | 162 | |
| |
18.1 | 163 | \\ |
| |
10.1 | 164 | |
| |
18.1 | 165 | {{code language="java" theme="Eclipse" firstline="1" title="Transform and create TranformationTree" linenumbers="true" collapse="true"}} |
| |
12.1 | 166 | aboSplitTE = SCCtransformation.transformTriggerEffect(abo); |
| |
10.1 | 167 | |
| |
12.1 | 168 | ModelWrapper aboSplitTEModel = |
| 169 | transformationTree.initializeTransformationTree(SCCtransformation.extractMapping(), "TriggerEffect", abo, "coreSCChart", aboSplitTE, "coreSCChart-splitTriggerEffect"); | ||
| |
10.1 | 170 | |
| |
12.1 | 171 | aboNormalized = SCCtransformation.transformSurfaceDepth(aboSplitTE); |
| 172 | |||
| 173 | ModelWrapper aboNormalizedModel = | ||
| 174 | transformationTree.addTransformationToTree(SCCtransformation.extractMapping(), aboSplitTEModel, "SurfaceDepth", aboSplitTE, aboNormalized, "normalizedCoreSCChart"); | ||
| 175 | |||
| 176 | aboSCG = SCGtransformation.transformSCG(aboNormalized); | ||
| 177 | |||
| 178 | ModelWrapper aboSCGModel = | ||
| 179 | transformationTree.addTransformationToTree(SCGtransformation.extractMapping(), aboNormalizedModel, "SCC2SCG", aboNormalized, aboSCG,"SCG"); | ||
| 180 | |||
| 181 | tree = transformationTree.root(aboSCGModel); | ||
| |
10.1 | 182 | {{/code}} |
| 183 | |||
| |
18.1 | 184 | \\ |
| |
10.1 | 185 | |
| |
12.1 | 186 | The resulting TransformationTree has following structure and representing each step and model of the transformation. |
| |
10.1 | 187 | |
| |
18.1 | 188 | \\ |
| |
10.1 | 189 | |
| |
18.1 | 190 | (% class="wrapped" %) |
| 191 | |=(% style="text-align: center;" colspan="4" %)(% style="text-align: center;" colspan="4" %) | ||
| |
12.1 | 192 | ((( |
| |
18.1 | 193 | (% class="content-wrapper" %) |
| 194 | ((( | ||
| |
10.1 | 195 | [[image:attach:example_tree.jpeg]] |
| |
12.1 | 196 | ))) |
| |
18.1 | 197 | ))) |
| 198 | |(% style="text-align: center;" colspan="1" %)(% style="text-align: center;" colspan="1" %) | ||
| |
12.1 | 199 | ((( |
| |
18.1 | 200 | (% class="content-wrapper" %) |
| 201 | ((( | ||
| |
12.1 | 202 | [[image:attach:example_abo.jpeg]] |
| |
18.1 | 203 | ))) |
| 204 | )))|(% style="text-align: center;" colspan="1" %)(% style="text-align: center;" colspan="1" %) | ||
| |
12.1 | 205 | ((( |
| |
18.1 | 206 | (% class="content-wrapper" %) |
| 207 | ((( | ||
| |
12.1 | 208 | [[image:attach:example_abo_splitTE.jpeg]] |
| |
18.1 | 209 | ))) |
| 210 | )))|(% style="text-align: center;" colspan="1" %)(% style="text-align: center;" colspan="1" %) | ||
| |
12.1 | 211 | ((( |
| |
18.1 | 212 | (% class="content-wrapper" %) |
| 213 | ((( | ||
| |
12.1 | 214 | [[image:attach:example_abo_norm.jpeg]] |
| |
18.1 | 215 | ))) |
| 216 | )))|(% style="text-align: center;" colspan="1" %)(% style="text-align: center;" colspan="1" %) | ||
| |
12.1 | 217 | ((( |
| |
18.1 | 218 | (% class="content-wrapper" %) |
| 219 | ((( | ||
| |
12.1 | 220 | [[image:attach:example_abo_scg.jpeg]] |
| 221 | ))) | ||
| |
18.1 | 222 | ))) |
| |
10.1 | 223 | |
| |
18.1 | 224 | \\ |
| |
10.1 | 225 | |
| |
12.1 | 226 | Furthermore the TransformationTree now contains mapping information for the whole transformation chain. |
| |
10.1 | 227 | |
| |
12.1 | 228 | Now we can use an additional feature of KTM, the resolving of mappings between arbitary models. |
| |
11.1 | 229 | |
| |
12.1 | 230 | The following code has starts with an instance of the initial ABO SCChart and SCG, along with the TranformationTree above. |
| 231 | |||
| |
18.1 | 232 | \\ |
| |
12.1 | 233 | |
| |
18.1 | 234 | {{code language="java" theme="Eclipse" firstline="1" title="resolveMapping" linenumbers="true" collapse="true"}} |
| |
12.1 | 235 | @Inject |
| 236 | extension TransformationTreeExtensions | ||
| 237 | |||
| 238 | //Find nodes of model instances in tree | ||
| 239 | val aboSCCModelWrapper = transformationTree.findModel(aboSCC,"coreSCChart"); | ||
| 240 | val aboSCGModelWrapper = transformationTree.findModel(aboSCG,"SCG"); | ||
| 241 | |||
| 242 | //resolve | ||
| 243 | val mapping = resolvemapping(aboSCCModelWrapper, aboSCC, aboSCGModelWrapper, aboSCG); | ||
| 244 | {{/code}} | ||
| 245 | |||
| |
18.1 | 246 | \\ |
| |
12.1 | 247 | |
| 248 | The returned mapping is a multi mapping between all object in aboSCC and their resulting objects in aboSCG. | ||
| |
13.1 | 249 | |
| |
14.1 | 250 | This mapping can now displayed in models or used for various information propagation between elements of the models. |
| |
13.1 | 251 | |
| 252 | [[image:attach:example_abo_resolved.jpeg]] | ||
| 253 | |||
| |
18.1 | 254 | \\ |
| |
13.1 | 255 | |
| |
14.1 | 256 | Also a more detailed view is available, showing all EObjects relation. |
| |
13.1 | 257 | |
| |
18.1 | 258 | \\ |
| |
13.1 | 259 | |
| 260 | [[image:attach:example_abo_resolved_elements.jpeg]] | ||
| 261 | |||
| |
16.1 | 262 | == Visualisation == |
| 263 | |||
| 264 | If you have a TransformationTree file (.ktmt) you can open a KLighD visualisation by right-clicking on file in project-tree and selecting //'Open Transformation Tree//'. | ||
| 265 | |||
| 266 | === Diagram Options === | ||
| 267 | |||
| 268 | //Model Visualisation//: If enabled tries to visaulize selected models with KLighD else a EObject-represenation is created. | ||
| 269 | |||
| 270 | //EObject Attributes//: If enabled shows Attributes of EObject in EObject-represenation. | ||
| 271 | |||
| 272 | //Selective mapping edges//: If enabled shows only selected mapping edges. | ||
| 273 | |||
| 274 | === Interaction === | ||
| 275 | |||
| 276 | //CTRL+CLICK//: Selects a Node in TransformationTree as source and displays its represented model. | ||
| 277 | |||
| 278 | //SHIFT+CLICK//: Selects a Node in TransformationTree as target, displays both models and the resolved mapping as edges (currenly only between States/Regions). | ||
| 279 | |||
| 280 | If Selective selective mapping edge is enabled no mapping edges are displayed. If you select (//CLICK//) an element in one of the two model its relation to corresponding element is displayed. You can multi-select with //CTRL+CLICK// or deselect by clicking on an edge. | ||
| 281 | |||
| |
18.1 | 282 | \\ |