SoSYM - Submission "Returning from the Past, Back to the Future"

This repository provides the dataset and results for the evaluation of the paper "Returning from the Past back to the Future: Incrementally Reconstructing and Recommending a Metamodel History" Contents Evaluation Content metamodels.zip: contains the used metamodels used in the evaulation evaluation.zip: contains the data received by our evaluation. It contains the ChangeTrees created for each of the given metamodels, the real changes applied to the metamodel, and the time and memory used during the generation of the metamodel. For more information, consider the AdditionalInformation.pdf. results.zip: contains the summerized results for each of ChangeTrees for the metamodels RQ_results.zip: contains evaulated results from each of the RQs Additional Information Meta-MetamodelExample.pdf: contains additional information on how the meta-metamodel works. It shows the metamodel of our motivating example in our meta-metamodel representation. SoSym-Tool-Demo.mov: A video showing how the Interactive Reconstruction Tool works based on the motivating example from the paper Tool and Source Code Tools.zip: Contains the tools used for the evaluation. For an explanation on how to use it, see below or contact the authors. source_code.zip: Contains the source code of our prototype tool and name similarity service. You need to have Lombok installed. In launchers, you find the main for both the interactive and evaluation mode. Type-refactor contains the code for the change reconstruction. evaluation.py: Contains the Python script that extracts the values received by performing the evaluation. i.e., see evaluation tool Running the tool Requirements Windows 10/11JDK 21 or above Instructions The tools consist of two main programs: Interactive Reconstruction ToolThis one allows users to interactively reconstruct the changes between two metamodel versions. Either use the preloaded metamodels (fhir,benchmark,types) or upload two emf files where you want to reconstruct the metamodel history step by-step (see Tools.zip) for an example java -jar interactiveTool.jar fhir // to run the interactive tool with the FHIR metamodel preloaded java -jar interactiveTool.jar benchmark //to run the interactive tool with the benchmark metamodel preloaded java -jar interactiveTool.jar type // to types to run the interactive tool with Papyrus Types metamodel preloaded java -jar interactiveTool.jar metamodel pathToVersion1 pathTOVersion2 // to import to .ecore metamodel and compare them interactively Example java -jar interactiveTool.jar metamodel mergeTypeAndAttribute1.ecore mergeTypeAndAttribute2.ecore Evaluation ToolThis is the tool used for the evaluation it either compares the preloaded metamodels or uses a provided metamodel (where it applies random changes) to create the change trees and extract the metrics needed for the RQs. java -jar evaluationTool.jar benchmark // to run the evaluation with the benchmark metamodel preloaded java -jar evaluationTool.jar type // to run the evaluation with the Papyrus types metamodel preloaded java -jar evaluationTool.jar fhir STU3 // to run the evaluation with the FHIR STU3 preloaded java -jar evaluationTool.jar fhir custom1 // to run the evaluation with the FHIR custom1 version preloaded java -jar evaluationTool.jar fhir custom2 // to run the evaluation with the FHIR custom2 version preloaded java -jar evaluationTool.jar metamodel <pathToTheMetamodel> // to run the evaluation on a metamodel (applying random changes and detecting them) java -jar evaluationTool.jar metamodel <pathToTheMetamodel> <pathToTheMetamodel2> // to run the evaluation on two given metamodel versions java -jar evaluationTool.jar edapt <pathToEdaptHistory> // to run the evaluation on a given edapt history Running the WordVector name similarity serverjava "-Dmodel.path=glove.2024.dolma.300d.zip" -jar WordVectorRest.jar Important: To run both the Interactive Reconstruction or the Evaluation Tool, the WordVector Server has to be running first. Just run the server in a terminal by calling java "-Dmodel.path=glove.2024.dolma.300d.zip" -jar WordVectorRest.jar. After the word vector model is successfully loaded, Ready should appear in the terminal. Then both other tools can be started.本仓库提供了论文《回溯过往，迈向未来：增量重构与推荐元模型历史》的评测数据集与实验结果。 ### 评测内容 metamodels.zip：包含评测所用的元模型。 evaluation.zip：包含评测过程中获取的全部数据，涵盖为各目标元模型生成的变更树（ChangeTrees）、应用于元模型的实际变更，以及元模型生成阶段消耗的时间与内存资源。更多细节请参阅AdditionalInformation.pdf。 results.zip：包含各元模型变更树的汇总实验结果。 RQ_results.zip：包含针对各研究问题（Research Questions, RQs）的评测结果。 ### 补充说明 Meta-MetamodelExample.pdf：包含元元模型工作原理的补充说明，展示了本文示例场景在元元模型表示下的元模型结构。 SoSym-Tool-Demo.mov：一段演示视频，展示了如何基于本文示例场景运行交互式重构工具。 ### 工具与源代码 Tools.zip：包含评测所用的工具集。使用方法详见下文或联系作者。 source_code.zip：包含原型工具与名称相似度服务的源代码，需预先安装Lombok。启动器目录中集成了交互式模式与评测模式的主类；type-refactor目录存放变更重构相关的核心代码。 evaluation.py：包含用于提取评测指标的Python脚本，具体说明详见评测工具文档。 ### 工具运行指南 #### 运行环境要求 Windows 10/11，JDK 21及以上版本。 #### 使用说明 本工具套件包含两个核心程序： 1. **交互式重构工具**：支持用户交互式重构两个元模型版本间的变更历史。可直接使用预加载的元模型（fhir、benchmark、types），或上传两份Eclipse建模框架（Eclipse Modeling Framework, EMF）文件，逐步完成元模型历史的重构（示例详见Tools.zip）。 运行命令示例： java -jar interactiveTool.jar fhir // 加载快速医疗保健互操作性资源（Fast Healthcare Interoperability Resources, FHIR）元模型以启动交互式工具 java -jar interactiveTool.jar benchmark // 加载基准元模型以启动交互式工具 java -jar interactiveTool.jar type // 加载Papyrus Types元模型以启动交互式工具 java -jar interactiveTool.jar metamodel pathToVersion1 pathTOVersion2 // 导入两份.ecore格式元模型并进行交互式对比 完整使用示例： java -jar interactiveTool.jar metamodel mergeTypeAndAttribute1.ecore mergeTypeAndAttribute2.ecore 2. **评测工具**：用于开展系统性评测，可对比预加载的元模型，或使用用户提供的元模型（通过随机生成变更以构建变更树并提取研究问题所需的各项指标）。 运行命令示例： java -jar evaluationTool.jar benchmark // 加载基准元模型开展评测 java -jar evaluationTool.jar type // 加载Papyrus Types元模型开展评测 java -jar evaluationTool.jar fhir STU3 // 加载预定义的FHIR STU3版本开展评测 java -jar evaluationTool.jar fhir custom1 // 加载预定义的FHIR custom1版本开展评测 java -jar evaluationTool.jar fhir custom2 // 加载预定义的FHIR custom2版本开展评测 java -jar evaluationTool.jar metamodel <pathToTheMetamodel> // 针对单个元模型开展评测（生成随机变更并完成检测） java -jar evaluationTool.jar metamodel <pathToTheMetamodel> <pathToTheMetamodel2> // 针对两个指定元模型版本开展评测 java -jar evaluationTool.jar edapt <pathToEdaptHistory> // 针对指定Edapt历史文件开展评测 #### 启动词向量名称相似度服务器 java "-Dmodel.path=glove.2024.dolma.300d.zip" -jar WordVectorRest.jar #### 重要提示 运行交互式重构工具或评测工具前，需先启动词向量服务器。在终端中执行上述服务器启动命令，待词向量模型加载完成后，终端将显示「Ready」字样，此时即可启动其余两款工具。