Merge branch 'cleanup-and-refactoring' into 'main'

Cleanup and refactoring

See merge request oceandsl/oceandsl-tools!11

Author: Reiner Jung

analysis/build.gradle

@@ -3,3 +3,11 @@ plugins {
     id 'java-library'
 }
 
+dependencies {
+	implementation project(':common')
+
+	implementation 'org.eclipse.emf:org.eclipse.emf.ecore:2.23.0'
+	implementation 'org.eclipse.emf:org.eclipse.emf.ecore.xmi:2.16.0'
+	
+	implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.0'
+}

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/ArchitectureModelManagementFactory.java analysis/src/main/java/org/oceandsl/analysis/architecture/model/ArchitectureModelManagementUtils.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model;
+package org.oceandsl.analysis.architecture.model;
 
 import java.io.File;
 import java.io.IOException;
@@ -56,12 +56,16 @@
 import kieker.model.analysismodel.type.TypePackage;
 
 /**
+ * Reading and storing model repositories.
+ *
+ * Note: This should be merged with the repository class.
+ *
  * @author Reiner Jung
  * @since 1.1
  */
-public final class ArchitectureModelManagementFactory {
+public final class ArchitectureModelManagementUtils {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(ArchitectureModelManagementFactory.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(ArchitectureModelManagementUtils.class);
 
     public static final String TYPE_MODEL_NAME = "type-model.xmi";
 
@@ -75,12 +79,12 @@ public final class ArchitectureModelManagementFactory {
 
     public static final String SOURCES_MODEL_NAME = "sources-model.xmi";
 
-    private ArchitectureModelManagementFactory() {
+    private ArchitectureModelManagementUtils() {
         // TODO Auto-generated constructor stub
     }
 
     public static ModelRepository createModelRepository(final String experimentName, final boolean mapFile) {
-        return ArchitectureModelManagementFactory
+        return ArchitectureModelManagementUtils
                 .createModelRepository(String.format("%s-%s", experimentName, mapFile ? "map" : "file"));
     }
 
@@ -110,37 +114,37 @@ public static ModelRepository loadModelRepository(final Path path) throws Config
         packageRegistry.put(AssemblyPackage.eNS_URI, AssemblyPackage.eINSTANCE);
         packageRegistry.put(DeploymentPackage.eNS_URI, DeploymentPackage.eINSTANCE);
         packageRegistry.put(ExecutionPackage.eNS_URI, ExecutionPackage.eINSTANCE);
-        packageRegistry.put(StatisticsPackage.eNS_URI, ArchitectureModelManagementFactory.STATISTICS_MODEL_NAME);
-        packageRegistry.put(SourcesPackage.eNS_URI, ArchitectureModelManagementFactory.SOURCES_MODEL_NAME);
-
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, TypeModel.class, path,
-                ArchitectureModelManagementFactory.TYPE_MODEL_NAME);
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, AssemblyModel.class, path,
-                ArchitectureModelManagementFactory.ASSEMBLY_MODEL_NAME);
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, DeploymentModel.class, path,
-                ArchitectureModelManagementFactory.DEPLOYMENT_MODEL_NAME);
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, ExecutionModel.class, path,
-                ArchitectureModelManagementFactory.EXECUTION_MODEL_NAME);
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, StatisticsModel.class, path,
-                ArchitectureModelManagementFactory.STATISTICS_MODEL_NAME);
-        ArchitectureModelManagementFactory.readModel(resourceSet, repository, SourceModel.class, path,
-                ArchitectureModelManagementFactory.SOURCES_MODEL_NAME);
+        packageRegistry.put(StatisticsPackage.eNS_URI, ArchitectureModelManagementUtils.STATISTICS_MODEL_NAME);
+        packageRegistry.put(SourcesPackage.eNS_URI, ArchitectureModelManagementUtils.SOURCES_MODEL_NAME);
+
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, TypeModel.class, path,
+                ArchitectureModelManagementUtils.TYPE_MODEL_NAME);
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, AssemblyModel.class, path,
+                ArchitectureModelManagementUtils.ASSEMBLY_MODEL_NAME);
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, DeploymentModel.class, path,
+                ArchitectureModelManagementUtils.DEPLOYMENT_MODEL_NAME);
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, ExecutionModel.class, path,
+                ArchitectureModelManagementUtils.EXECUTION_MODEL_NAME);
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, StatisticsModel.class, path,
+                ArchitectureModelManagementUtils.STATISTICS_MODEL_NAME);
+        ArchitectureModelManagementUtils.readModel(resourceSet, repository, SourceModel.class, path,
+                ArchitectureModelManagementUtils.SOURCES_MODEL_NAME);
 
         return repository;
     }
 
     private static <T extends EObject> void readModel(final ResourceSet resourceSet, final ModelRepository repository,
             final Class<T> type, final Path path, final String filename) throws ConfigurationException {
-        ArchitectureModelManagementFactory.LOGGER.info("Loading model {}", filename);
-        final File modelFile = ArchitectureModelManagementFactory.createReadModelFileHandle(path, filename);
+        ArchitectureModelManagementUtils.LOGGER.info("Loading model {}", filename);
+        final File modelFile = ArchitectureModelManagementUtils.createReadModelFileHandle(path, filename);
         if (modelFile.exists()) {
             final Resource resource = resourceSet.getResource(URI.createFileURI(modelFile.getAbsolutePath()), true);
             for (final Diagnostic error : resource.getErrors()) {
-                ArchitectureModelManagementFactory.LOGGER.error("Error loading '{}' of {}:{}  {}", filename,
+                ArchitectureModelManagementUtils.LOGGER.error("Error loading '{}' of {}:{}  {}", filename,
                         error.getLocation(), error.getLine(), error.getMessage());
             }
             for (final Diagnostic error : resource.getWarnings()) {
-                ArchitectureModelManagementFactory.LOGGER.error("Warning loading '{}' of {}:{}  {}", filename,
+                ArchitectureModelManagementUtils.LOGGER.error("Warning loading '{}' of {}:{}  {}", filename,
                         error.getLocation(), error.getLine(), error.getMessage());
             }
             repository.register(type, resource.getContents().get(0));
@@ -149,7 +153,7 @@ private static <T extends EObject> void readModel(final ResourceSet resourceSet,
                 i.next().eCrossReferences();
             }
         } else {
-            ArchitectureModelManagementFactory.LOGGER.error("Error reading model file {}. File does not exist.",
+            ArchitectureModelManagementUtils.LOGGER.error("Error reading model file {}. File does not exist.",
                     modelFile.getAbsoluteFile());
             throw new ConfigurationException(
                     String.format("Error reading model file %s. File does not exist.", modelFile.getAbsoluteFile()));
@@ -170,33 +174,33 @@ public static void writeModelRepository(final Path outputDirectory, final ModelR
             Files.createDirectory(outputDirectory);
         }
 
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.TYPE_MODEL_NAME, repository.getModel(TypeModel.class));
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.ASSEMBLY_MODEL_NAME, repository.getModel(AssemblyModel.class));
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.DEPLOYMENT_MODEL_NAME, repository.getModel(DeploymentModel.class));
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.EXECUTION_MODEL_NAME, repository.getModel(ExecutionModel.class));
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.STATISTICS_MODEL_NAME, repository.getModel(StatisticsModel.class));
-        ArchitectureModelManagementFactory.writeModel(resourceSet, outputDirectory,
-                ArchitectureModelManagementFactory.SOURCES_MODEL_NAME, repository.getModel(SourceModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.TYPE_MODEL_NAME, repository.getModel(TypeModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.ASSEMBLY_MODEL_NAME, repository.getModel(AssemblyModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.DEPLOYMENT_MODEL_NAME, repository.getModel(DeploymentModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.EXECUTION_MODEL_NAME, repository.getModel(ExecutionModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.STATISTICS_MODEL_NAME, repository.getModel(StatisticsModel.class));
+        ArchitectureModelManagementUtils.writeModel(resourceSet, outputDirectory,
+                ArchitectureModelManagementUtils.SOURCES_MODEL_NAME, repository.getModel(SourceModel.class));
     }
 
     private static <T extends EObject> void writeModel(final ResourceSet resourceSet, final Path outputDirectory,
             final String filename, final T model) {
-        ArchitectureModelManagementFactory.LOGGER.info("Saving model {}", filename);
+        ArchitectureModelManagementUtils.LOGGER.info("Saving model {}", filename);
 
-        final File modelFile = ArchitectureModelManagementFactory.createWriteModelFileHandle(outputDirectory, filename);
+        final File modelFile = ArchitectureModelManagementUtils.createWriteModelFileHandle(outputDirectory, filename);
 
         final Resource resource = resourceSet.createResource(URI.createURI(modelFile.getAbsolutePath()));
         resource.getContents().add(model);
 
         try {
             resource.save(Collections.EMPTY_MAP);
         } catch (final IOException e) {
-            ArchitectureModelManagementFactory.LOGGER.error("Cannot write {} model to storage. Cause: {}",
+            ArchitectureModelManagementUtils.LOGGER.error("Cannot write {} model to storage. Cause: {}",
                     modelFile.getAbsoluteFile(), e.getLocalizedMessage());
         }
     }

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/utils/RepositoryUtils.java analysis/src/main/java/org/oceandsl/analysis/architecture/model/RepositoryUtils.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages.utils;
+package org.oceandsl.analysis.architecture.model;
 
 import java.util.List;
 

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/data/table/package-info.java analysis/src/main/java/org/oceandsl/analysis/architecture/model/package-info.java

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.data.table;
+package org.oceandsl.analysis.architecture.model;

analysis/src/main/java/org/oceandsl/analysis/RewriteBeforeAndAfterEventsStage.java analysis/src/main/java/org/oceandsl/analysis/stages/dynamic/RewriteBeforeAndAfterEventsStage.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.analysis;
+package org.oceandsl.analysis.stages.dynamic;
 
 import java.io.BufferedReader;
 import java.io.File;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/package-info.java analysis/src/main/java/org/oceandsl/analysis/stages/dynamic/package-info.java

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.dynamic;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/CountEventsStage.java analysis/src/main/java/org/oceandsl/analysis/stages/generic/CountEventsStage.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.generic;
 
 import teetime.stage.basic.AbstractFilter;
 

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/sinks/TableCSVSink.java analysis/src/main/java/org/oceandsl/analysis/stages/generic/TableCSVSink.java

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages.sinks;
+package org.oceandsl.analysis.stages.generic;
 
 import java.io.BufferedWriter;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import org.oceandsl.architecture.model.data.table.Table;
+import org.oceandsl.analysis.stages.staticdata.data.Table;
 
 import teetime.framework.AbstractConsumerStage;
 

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/utils/package-info.java analysis/src/main/java/org/oceandsl/analysis/stages/generic/package-info.java

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages.utils;
+package org.oceandsl.analysis.stages.generic;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/CountUniqueCallsStage.java analysis/src/main/java/org/oceandsl/analysis/stages/model/CountUniqueCallsStage.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.model;
 
 import java.util.Map.Entry;
 import java.util.function.Function;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/ModelRepositoryProducerStage.java analysis/src/main/java/org/oceandsl/analysis/stages/model/ModelRepositoryProducerStage.java

@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.model;
 
 import java.nio.file.Path;
 
-import org.oceandsl.architecture.model.ArchitectureModelManagementFactory;
+import org.oceandsl.analysis.architecture.model.ArchitectureModelManagementUtils;
 
 import kieker.analysis.stage.model.ModelRepository;
 import teetime.framework.AbstractProducerStage;
@@ -36,7 +36,7 @@ public ModelRepositoryProducerStage(final Path path) {
 
     @Override
     protected void execute() throws Exception {
-        this.outputPort.send(ArchitectureModelManagementFactory.loadModelRepository(this.path));
+        this.outputPort.send(ArchitectureModelManagementUtils.loadModelRepository(this.path));
         this.workCompleted();
     }
 

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/ModelSerializerStage.java analysis/src/main/java/org/oceandsl/analysis/stages/model/ModelSerializerStage.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.model;
 
 import java.io.File;
 import java.io.IOException;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/TriggerToModelSnapshotStage.java analysis/src/main/java/org/oceandsl/analysis/stages/model/TriggerToModelSnapshotStage.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.model;
 
 import java.util.Map.Entry;
 

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/data/table/OperationCall.java analysis/src/main/java/org/oceandsl/analysis/stages/model/data/OperationCall.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.data.table;
+package org.oceandsl.analysis.stages.model.data;
 
 import kieker.model.analysismodel.deployment.DeployedOperation;
 

analysis/src/main/java/org/oceandsl/analysis/stages/model/data/package-info.java

@@ -0,0 +1,16 @@
+/***************************************************************************
+ * Copyright (C) 2021 OceanDSL (https://oceandsl.uni-kiel.de)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ***************************************************************************/
+package org.oceandsl.analysis.stages.model.data;

analysis/src/main/java/org/oceandsl/analysis/stages/model/package-info.java

@@ -0,0 +1,16 @@
+/***************************************************************************
+ * Copyright (C) 2021 OceanDSL (https://oceandsl.uni-kiel.de)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ***************************************************************************/
+package org.oceandsl.analysis.stages.model;

tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/stages/CSVReaderStage.java analysis/src/main/java/org/oceandsl/analysis/stages/staticdata/CSVComponentMapReaderStage.java

@@ -13,28 +13,45 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ***************************************************************************/
-package org.oceandsl.architecture.model.stages;
+package org.oceandsl.analysis.stages.staticdata;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import org.oceandsl.architecture.model.data.table.StringValueHandler;
-import org.oceandsl.architecture.model.data.table.Table;
+import org.oceandsl.analysis.stages.staticdata.data.StringValueHandler;
+import org.oceandsl.analysis.stages.staticdata.data.Table;
 
 import teetime.framework.AbstractProducerStage;
 
 /**
+ * Read a CSV file containing a component map.
+ *
+ * Note: Should use a generic CSV reader parent class.
+ *
  * @author Reiner Jung
  * @since 1.0
  */
-public class CSVReaderStage extends AbstractProducerStage<Table> {
+public class CSVComponentMapReaderStage extends AbstractProducerStage<Table> {
 
     private final BufferedReader reader;
+    private final String seperator;
 
-    public CSVReaderStage(final Path path) throws IOException {
+    /**
+     * Create reader stage.
+     *
+     * @param path
+     *            path to file
+     * @param separator
+     *            separator character
+     *
+     * @throws IOException
+     *             on io exceptions
+     */
+    public CSVComponentMapReaderStage(final Path path, final String separator) throws IOException {
         this.reader = Files.newBufferedReader(path);
+        this.seperator = separator;
     }
 
     @Override
@@ -43,7 +60,7 @@ protected void execute() throws Exception {
                 new StringValueHandler("File"), new StringValueHandler("Function"));
         String line;
         while ((line = this.reader.readLine()) != null) {
-            final String[] values = line.split(",");
+            final String[] values = line.split(this.seperator);
             if (values.length == 3) {
                 resultTable.addRow(values[0].trim(), values[1].trim().toLowerCase(), values[2].trim().toLowerCase());
             } else {