refactor(core): move more code from transpose flow graph into separate methods

Author: Entenwilli

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/GDPRLegalAssessmentAnalysis.java

@@ -30,10 +30,12 @@ public class GDPRLegalAssessmentAnalysis extends DataFlowConfidentialityAnalysis
     private final String modelProjectName;
 
     /**
-     * Create a new {@link GDPRLegalAssessmentAnalysis} with the given resource provider and optionally a modelling project with a plugin activator
+     * Create a new {@link GDPRLegalAssessmentAnalysis} with the given resource provider and optionally a modelling project
+     * with a plugin activator
      * <p/>
      * Note: Do not create an instance of this class manually, use the {@link GDPRLegalAssessmentAnalysisBuilder} instead
-     * @param resourceProvider {@link GDPRResourceProvider} providing a metamodel instance of the GDPR and Context Property model
+     * @param resourceProvider {@link GDPRResourceProvider} providing a metamodel instance of the GDPR and Context Property
+     * model
      * @param modelProjectActivator Optional model project activator
      * @param modelProjectName Optional model project name
      */

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/GDPRLegalAssessmentAnalysisBuilder.java

@@ -10,9 +10,8 @@
 
 /**
  * Extension of the {@link DataFlowAnalysisBuilder} responsible for creating a valid {@link GDPRLegalAssessmentAnalysis}
- * from the following:
- * - A valid path to a .gdpr metamodel instance
- * - A valid path to a .contextproperties metamodel instance
+ * from the following: - A valid path to a .gdpr metamodel instance - A valid path to a .contextproperties metamodel
+ * instance
  */
 public class GDPRLegalAssessmentAnalysisBuilder extends DataFlowAnalysisBuilder {
     private final Logger logger = Logger.getLogger(GDPRLegalAssessmentAnalysisBuilder.class);

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/UncertaintyUtils.java

@@ -2,9 +2,9 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import mdpa.gdpr.analysis.core.ContextDependentAttributeScenario;
 import mdpa.gdpr.analysis.core.ContextDependentAttributeSource;
-import mdpa.gdpr.analysis.dfd.DFDGDPRTransposeFlowGraph;
 import mdpa.gdpr.analysis.dfd.DFDGDPRVertex;
 import mdpa.gdpr.metamodel.GDPR.Data;
 import mdpa.gdpr.metamodel.GDPR.NaturalPerson;
@@ -181,17 +181,19 @@ public static Behavior createBehavior(DFDGDPRVertex impactedElement, DataDiction
             List<Label> values = UncertaintyUtils.getAppliedLabel(scenario, source, dd);
 
             List<Pin> inputPins = behaviour.getInPin();
-            Pin outputPin = behaviour.getOutPin()
+            Optional<Pin> outputPin = behaviour.getOutPin()
                     .stream()
                     .filter(it -> it.getEntityName()
                             .equals(targetData.getEntityName()))
-                    .findAny()
-                    .orElseThrow();
+                    .findAny();
+            if (outputPin.isEmpty()) {
+                return behaviour;
+            }
             Assignment attributeAssignment = datadictionaryFactory.eINSTANCE.createAssignment();
             attributeAssignment.setTerm(datadictionaryFactory.eINSTANCE.createTRUE());
             attributeAssignment.getInputPins()
                     .addAll(inputPins);
-            attributeAssignment.setOutputPin(outputPin);
+            attributeAssignment.setOutputPin(outputPin.get());
             attributeAssignment.getOutputLabels()
                     .addAll(values);
             assignments.add(attributeAssignment);

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/ContextAttributeState.java

@@ -1,19 +1,18 @@
 package mdpa.gdpr.analysis.core;
 
-import org.eclipse.jdt.annotation.NonNull;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 
 /**
- * This class models a state for a {@link mdpa.gdpr.analysis.dfd.DFDGDPRTransposeFlowGraph} that has selected the stored {@link ContextDependentAttributeScenario}
+ * This class models a state for a {@link mdpa.gdpr.analysis.dfd.DFDGDPRTransposeFlowGraph} that has selected the stored
+ * {@link ContextDependentAttributeScenario}
  */
 public record ContextAttributeState(List<ContextDependentAttributeScenario> selectedScenarios) {
     /**
-     * Creates a new {@link ContextAttributeState} using the given list of selected {@link ContextDependentAttributeScenario}
-     *
+     * Creates a new {@link ContextAttributeState} using the given list of selected
+     * {@link ContextDependentAttributeScenario}
      * @param selectedScenarios List of selected {@link ContextDependentAttributeScenario}
      */
     public ContextAttributeState(List<ContextDependentAttributeScenario> selectedScenarios) {
@@ -22,7 +21,6 @@ public ContextAttributeState(List<ContextDependentAttributeScenario> selectedSce
 
     /**
      * Returns the selected {@link ContextDependentAttributeScenario} that are selected by the {@link ContextAttributeState}
-     *
      * @return Returns selected {@link ContextDependentAttributeScenario}
      */
     @Override
@@ -31,9 +29,10 @@ public List<ContextDependentAttributeScenario> selectedScenarios() {
     }
 
     /**
-     * Create all possible {@link ContextAttributeState} that are possible to create from the given list of {@link ContextDependentAttributeSource}
-     *
-     * @param contextDependentAttributeSources Given list of {@link ContextDependentAttributeSource} that are used in finding all {@link ContextAttributeState}
+     * Create all possible {@link ContextAttributeState} that are possible to create from the given list of
+     * {@link ContextDependentAttributeSource}
+     * @param contextDependentAttributeSources Given list of {@link ContextDependentAttributeSource} that are used in
+     * finding all {@link ContextAttributeState}
      * @return Returns a list of all possible {@link ContextAttributeState}
      */
     public static List<ContextAttributeState> createAllContextAttributeStates(
@@ -50,9 +49,8 @@ public static List<ContextAttributeState> createAllContextAttributeStates(
 
     /**
      * Calculates the cartesian product between the given lists
-     *
      * @param lists List of lists that should be used when calculating the cartesian product
-     * @param <T>   Type of the list elements
+     * @param <T> Type of the list elements
      * @return Returns the cartesian product of the provided lists
      */
     private static <T> List<List<T>> cartesianProduct(List<List<T>> lists) {
@@ -78,7 +76,6 @@ private static <T> List<List<T>> cartesianProduct(List<List<T>> lists) {
     }
 
     @Override
-    @NonNull
     public String toString() {
         String scenarios = this.selectedScenarios.stream()
                 .map(ContextDependentAttributeScenario::getName)

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/ContextDependentAttributeScenario.java

@@ -13,7 +13,6 @@
  * Models a Context Dependent Attribute Scenario that applies the given list of property values.
  * <p/>
  * As a Context Dependent Attribute Scenario can occur in two scenarios we differentiate:
- *
  */
 public class ContextDependentAttributeScenario {
     private final Logger logger = Logger.getLogger(ContextDependentAttributeScenario.class);
@@ -27,8 +26,8 @@ public class ContextDependentAttributeScenario {
     private final boolean resolvedUncertainty;
 
     /**
-     * Creates a new context dependent attribute scenario that matches a specific context.
-     * Therefore, it does not resolve an uncertain CDA
+     * Creates a new context dependent attribute scenario that matches a specific context. Therefore, it does not resolve an
+     * uncertain CDA
      * @param contextAnnotation {@link ContextAnnotation} the Scenario requires
      * @param contextDependentAttributeSource Corresponding {@link ContextDependentAttributeSource}
      */
@@ -42,9 +41,9 @@ public ContextDependentAttributeScenario(ContextAnnotation contextAnnotation, Co
     }
 
     /**
-     * Creates a new {@link ContextDependentAttributeScenario} that is resolving an uncertainty.
-     * Therefore, it requires a property value that is applied, the corresponding {@link ContextDependentAttributeSource}
-     * and a list of other {@link ContextDependentAttributeSource} that contradict the uncertain CDA
+     * Creates a new {@link ContextDependentAttributeScenario} that is resolving an uncertainty. Therefore, it requires a
+     * property value that is applied, the corresponding {@link ContextDependentAttributeSource} and a list of other
+     * {@link ContextDependentAttributeSource} that contradict the uncertain CDA
      * @param propertyValue Property value that is applied, when this scenario is applied
      * @param contextDependentAttributeSource Corresponding {@link ContextDependentAttributeSource}
      * @param sources Other {@link ContextDependentAttributeSource} that must not be true
@@ -62,8 +61,7 @@ public ContextDependentAttributeScenario(PropertyValue propertyValue, ContextDep
     /**
      * Returns whether the {@link ContextDependentAttributeScenario} is applicable to the given vertex
      * @param vertex {@link DFDGDPRVertex} that is checked
-     * @return Returns true, if the scenario should be applied to the vertex.
-     *          Otherwise, the method returns false
+     * @return Returns true, if the scenario should be applied to the vertex. Otherwise, the method returns false
      */
     public boolean applicable(DFDGDPRVertex vertex) {
         logger.trace("Determining whether " + this.name + " can be applied to " + vertex);
@@ -88,10 +86,11 @@ public boolean applicable(DFDGDPRVertex vertex) {
     }
 
     /**
-     * Determines whether the {@link ContextDependentAttributeScenario} is applicable to any of the nodes in the given transpose flow graph
+     * Determines whether the {@link ContextDependentAttributeScenario} is applicable to any of the nodes in the given
+     * transpose flow graph
      * @param transposeFlowGraph {@link DFDGDPRTransposeFlowGraph} that is checked
-     * @return Returns true, if the {@link ContextDependentAttributeScenario} can be applied to any of the vertices in the TFG.
-     *          Otherwise, the method returns false
+     * @return Returns true, if the {@link ContextDependentAttributeScenario} can be applied to any of the vertices in the
+     * TFG. Otherwise, the method returns false
      */
     public boolean applicable(DFDGDPRTransposeFlowGraph transposeFlowGraph) {
         if (this.resolvedUncertainty) {

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/ContextDependentAttributeSource.java

@@ -12,8 +12,8 @@
 import mdpa.gdpr.metamodel.contextproperties.PropertyValue;
 
 /**
- * This class models an application of a context dependent attribute on an element in the GDPR model.
- * The different values it can take are saved in one or multiple child {@link ContextDependentAttributeScenario}.
+ * This class models an application of a context dependent attribute on an element in the GDPR model. The different
+ * values it can take are saved in one or multiple child {@link ContextDependentAttributeScenario}.
  */
 public class ContextDependentAttributeSource {
     private final String name;
@@ -26,8 +26,9 @@ public class ContextDependentAttributeSource {
     private final boolean resolvedUncertainty;
 
     /**
-     * Creates a new {@link ContextDependentAttributeSource} with the given property annotation containing the information about the annotated element and value
-     * and the context annotation describing the context of the {@link ContextDependentAttributeSource}
+     * Creates a new {@link ContextDependentAttributeSource} with the given property annotation containing the information
+     * about the annotated element and value and the context annotation describing the context of the
+     * {@link ContextDependentAttributeSource}
      * @param propertyAnnotation {@link PropertyAnnotation} describing where the CDA is applied
      * @param contextAnnotation {@link ContextAnnotation} describing which scenarios the source has
      */
@@ -42,10 +43,10 @@ public ContextDependentAttributeSource(PropertyAnnotation propertyAnnotation, Co
     }
 
     /**
-     * Creates a new {@link ContextDependentAttributeSource} that needs to be resolved with uncertain CDAs.
-     * Resolves an uncertainty regarding the value of an {@link ContextDependentAttributeSource} by creating a scenario for each
-     * passed {@link PropertyValue}.
-     * Additionally, the given list of other {@link ContextDependentAttributeSource} denotes where this source cannot apply
+     * Creates a new {@link ContextDependentAttributeSource} that needs to be resolved with uncertain CDAs. Resolves an
+     * uncertainty regarding the value of an {@link ContextDependentAttributeSource} by creating a scenario for each passed
+     * {@link PropertyValue}. Additionally, the given list of other {@link ContextDependentAttributeSource} denotes where
+     * this source cannot apply
      * @param propertyAnnotation {@link PropertyAnnotation} containing information about the annotated element and value
      * @param values Different {@link PropertyValue} that are resolved by the uncertainty
      * @param sources List of {@link ContextDependentAttributeSource} that cannot be applied at the same time
@@ -67,7 +68,7 @@ public ContextDependentAttributeSource(PropertyAnnotation propertyAnnotation, Li
      * Determines whether this {@link ContextDependentAttributeSource} is applicable to the given list of vertices
      * @param vertices Given list of vertices
      * @return Returns true, if this {@link ContextDependentAttributeSource} is applicable at least one of the vertices
-     *          Otherwise, the method returns false.
+     * Otherwise, the method returns false.
      */
     public boolean applicable(Collection<DFDGDPRVertex> vertices) {
         if (!vertices.stream()
@@ -84,12 +85,11 @@ public boolean applicable(Collection<DFDGDPRVertex> vertices) {
     /**
      * Determines whether the {@link ContextDependentAttributeSource} is applicable at the given vertex.
      * <p/>
-     * This is the case, it the vertex has the annotated element in its context.
-     * If this {@link ContextDependentAttributeSource} is resolving an uncertainty, the other saved sources must not match.
-     * If this source is not resolving an uncertainty, it must match at least one context definition
+     * This is the case, it the vertex has the annotated element in its context. If this
+     * {@link ContextDependentAttributeSource} is resolving an uncertainty, the other saved sources must not match. If this
+     * source is not resolving an uncertainty, it must match at least one context definition
      * @param vertex Given {@link DFDGDPRVertex} that is checked
-     * @return Returns true, if the source is applicable to the vertex.
-     *          Otherwise, the method returns false
+     * @return Returns true, if the source is applicable to the vertex. Otherwise, the method returns false
      */
     public boolean applicable(DFDGDPRVertex vertex) {
         if (!vertex.getRelatedElements()

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/TransformationManager.java

@@ -22,7 +22,8 @@
 import org.dataflowanalysis.dfd.dataflowdiagram.Node;
 
 /**
- * Manages the transformation from GDPR to DFD that is required to find {@link org.dataflowanalysis.analysis.core.AbstractTransposeFlowGraph} for the analysis.
+ * Manages the transformation from GDPR to DFD that is required to find
+ * {@link org.dataflowanalysis.analysis.core.AbstractTransposeFlowGraph} for the analysis.
  */
 public class TransformationManager {
     private final Logger logger = Logger.getLogger(TransformationManager.class);
@@ -53,8 +54,8 @@ public DataFlowDiagramAndDataDictionary transform(LegalAssessmentFacts gdprModel
     }
 
     /**
-     * Runs some postprocessing on the resulting DFD model for keeping track of the trace between nodes and processing elements
-     * TODO: This can be replaced with the tracemodel
+     * Runs some postprocessing on the resulting DFD model for keeping track of the trace between nodes and processing
+     * elements TODO: This can be replaced with the tracemodel
      * @param dataFlowDiagram Data flow diagram of the Transformation
      * @param gdprModel GDPR model of the transformation
      */
@@ -72,8 +73,8 @@ private void processTransformation(DataFlowDiagram dataFlowDiagram, LegalAssessm
     }
 
     /**
-     * Creates the {@link ContextDependentAttributeSource}s and {@link ContextDependentAttributeScenario} for the context property model.
-     * Additionally, it creates the required labels in the data dictionary.
+     * Creates the {@link ContextDependentAttributeSource}s and {@link ContextDependentAttributeScenario} for the context
+     * property model. Additionally, it creates the required labels in the data dictionary.
      * @param propertyModel Context Property Model of the transformation
      * @param dataDictionary Data Dictionary of the transformation
      */

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/resource/GDPRResourceProvider.java

@@ -9,7 +9,8 @@
 import org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl;
 
 /**
- * A {@link ResourceProvider} providing the necessary resources to run a {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysis}
+ * A {@link ResourceProvider} providing the necessary resources to run a
+ * {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysis}
  */
 public abstract class GDPRResourceProvider extends ResourceProvider {
     @Override
@@ -28,13 +29,13 @@ public void setupResources() {
 
     /**
      * Returns the loaded GDPR model
-     *
      * @return Returns the GDPR model that is loaded by the resource provider
      */
     public abstract LegalAssessmentFacts getGDPRModel();
 
     /**
-     * Returns the {@link ContextDependentProperties} metamodel that is required to run a {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysis}
+     * Returns the {@link ContextDependentProperties} metamodel that is required to run a
+     * {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysis}
      * @return Returns the loaded Context Property model
      */
     public abstract ContextDependentProperties getContextDependentProperties();

bundles/mdpa.gdpr.analysis/src/mdpa/gdpr/analysis/core/resource/GDPRURIResourceProvider.java

@@ -22,7 +22,8 @@ public class GDPRURIResourceProvider extends GDPRResourceProvider {
     /**
      * Creates a new {@link GDPRURIResourceProvider} using the provided URIs to the models
      * <p/>
-     * Usually, the resource provider will be created automatically when using {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysisBuilder}
+     * Usually, the resource provider will be created automatically when using
+     * {@link mdpa.gdpr.analysis.GDPRLegalAssessmentAnalysisBuilder}
      * @param modelURI URI path to the GDPR model
      * @param propertyURI URI path to the context property model
      */