Extractor for nested models

Jenkinsfile

@@ -314,23 +314,36 @@ if (env.BRANCH_NAME == "master") {
     getFeatureBranchProps()
 
     node {
-        // curl the api to get debugging details
-        def jsonObj = getGithubPRJsonObj(env.CHANGE_ID, orgNames.get(0), projects.get(0))
 
-        // This displays colors using the 'xterm' ansi color map.
+        def repoName = ""
+        // init variables depending of this build is triggered by a branch with PR or without PR
+        if (env.CHANGE_ID == null) {
+            // no PR exists
+            featureBranchName = env.BRANCH_NAME
+            repoName = orgNames.get(0) + "/" + projects.get(0)
+        } else {
+            // PR exists
+            /// curl the api to get debugging details
+            def jsonObj = getGithubPRJsonObj(env.CHANGE_ID, orgNames.get(0), projects.get(0))
+
+            featureBranchName = jsonObj.head.ref
+            repoName = jsonObj.head.repo.full_name
+
+        }
+
+
         ansiColor('xterm') {
             try {
                 // set java version
                 setJavaVersion(javaVersionId)
 
                 /// set the build name
-                featureBranchName = jsonObj.head.ref
                 currentBuild.displayName = featureBranchName + " (" + currentBuild.displayName + ")"
 
                 // notify rocket chat about the started feature branch run
                 rocketSend channel: rocketChatChannel, emoji: ':jenkins_triggered:',
                         message: "feature branch build triggered:\n" +
-                                "*repo:* ${jsonObj.head.repo.full_name}\n" +
+                                "*repo:* ${repoName}\n" +
                                 "*branch:* ${featureBranchName}\n"
                 rawMessage: true
 
@@ -383,7 +396,7 @@ if (env.BRANCH_NAME == "master") {
                     // notify rocket chat
                     rocketSend channel: rocketChatChannel, emoji: ':jenkins_party:',
                             message: "feature branch test successful!\n" +
-                                    "*repo:* ${jsonObj.head.repo.full_name}\n" +
+                                    "*repo:* ${repoName}\n" +
                                     "*branch:* ${featureBranchName}\n"
                     rawMessage: true
                 }
@@ -401,7 +414,7 @@ if (env.BRANCH_NAME == "master") {
                 // notify rocket chat
                 rocketSend channel: rocketChatChannel, emoji: ':jenkins_explode:',
                         message: "feature branch test failed!\n" +
-                                "*repo:* ${jsonObj.head.repo.full_name}\n" +
+                                "*repo:* ${repoName}\n" +
                                 "*branch:* ${featureBranchName}\n"
                 rawMessage: true
             }

docs/uml/main/InputDatamodelConcept.puml

@@ -1,5 +1,23 @@
 @startuml
 
+'extractor interface information
+
+interface Nested
+
+interface Node
+Node --|> Nested
+
+interface Nodes
+Nodes --|> Nested
+
+interface NodeC
+NodeC --|> Nested
+
+interface Type
+Type --|> Nested
+
+
+
 abstract Class UniqueEntity {
 + uuid: UUID
 }
@@ -24,6 +42,7 @@ abstract Class SystemParticipantInput {
 - qCharacteristics: String
 }
 SystemParticipantInput --|> AssetInput
+SystemParticipantInput --|> Node
 
 Class OperatorInput {
 + name: String
@@ -35,6 +54,7 @@ abstract Class ConnectorInput {
 + nodeB: NodeInput
 }
 ConnectorInput --|> AssetInput
+ConnectorInput --|> Nodes
 
 abstract Class AssetCharacteristicsInput<T extends AssetTypeInput> {
     - type: T
@@ -208,12 +228,14 @@ Class WecInput{
 - marketReaction: Boolean
 }
 WecInput --|> SystemParticipantInput
+WecInput --|> Type
 
 Class ChpInput {
 - type: ChpTypeInput
 - marketReaction: Boolean
 }
 ChpInput --|> SystemParticipantInput
+ChpInput --|> Type
 
 Class BmInput {
 - type: BmTypeInput
@@ -223,11 +245,13 @@ Class BmInput {
 - costControlled: Boolean
 }
 BmInput --|> SystemParticipantInput
+BmInput --|> Type
 
 Class EvInput {
 - type: EvTypeInput
 }
 EvInput --|> SystemParticipantInput
+EvInput --|> Type
 
 Class LoadInput {
 - scenario: String
@@ -242,11 +266,13 @@ Class StorageInput {
 - behaviour: String
 }
 StorageInput --|> SystemParticipantInput
+StorageInput --|> Type
 
 Class HpInput {
 - type: HpTypeInput
 }
 HpInput --|> SystemParticipantInput
+HpInput --|> Type
 
 Abstract Class ThermalUnitInput {
  - uuid: UUID
@@ -314,6 +340,7 @@ Class LineInput {
 + geoPosition: LineString
 }
 LineInput --|> ConnectorInput
+LineInput --|> Type
 
 Class SwitchInput {
 + closed: Boolean
@@ -331,12 +358,15 @@ Class Transformer2WInput {
 + type: Transformer2WTypeInput
 }
 Transformer2WInput --|> TransformerInput
+Transformer2WInput --|> Type
 
 Class Transformer3WInput {
 + nodeC: NodeInput
 + type: Transformer3WTypeInput
 }
 Transformer3WInput --|> TransformerInput
+Transformer3WInput --|> NodeC
+Transformer3WInput --|> Type
 
 abstract Class GraphicInput {
 + graphicLayer: String

gradle/scripts/tests.gradle

@@ -5,7 +5,7 @@ test {
 	}
 	useJUnitPlatform()
 	testLogging {
-		events "passed", "skipped", "failed"
+		events "skipped", "failed"
 	}
 }
 
@@ -24,7 +24,7 @@ task allTests(type: Test) {
 
 	useJUnitPlatform()
 	testLogging {
-		events "passed", "skipped", "failed"
+		events "skipped", "failed"
 	}
 
 	filter {

src/main/java/edu/ie3/datamodel/exceptions/ExtractorException.java

@@ -0,0 +1,28 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.exceptions;
+
+/**
+ * Exception that should be used whenevery something invalid happens in a implementation of a {@link
+ * edu.ie3.datamodel.io.connectors.DataConnector}
+ *
+ * @version 0.1
+ * @since 20.03.20
+ */
+public class ExtractorException extends Exception {
+
+  public ExtractorException(final String message, final Throwable cause) {
+    super(message, cause);
+  }
+
+  public ExtractorException(final Throwable cause) {
+    super(cause);
+  }
+
+  public ExtractorException(final String message) {
+    super(message);
+  }
+}

src/main/java/edu/ie3/datamodel/io/extractor/Extractor.java

@@ -0,0 +1,59 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.exceptions.ExtractorException;
+import edu.ie3.datamodel.models.input.InputEntity;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * A simple utility class that can be used by sinks to extract nested elements (e.g. nodes, types)
+ * that should be persisted.
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public class Extractor {
+
+  private final List<InputEntity> extractedEntities;
+
+  public Extractor(Nested nestedEntity) throws ExtractorException {
+    this.extractedEntities = extractElements(nestedEntity);
+  }
+
+  private List<InputEntity> extractElements(Nested nestedEntity) throws ExtractorException {
+    List<InputEntity> resultingList = new ArrayList<>();
+    if (nestedEntity instanceof Node) {
+      resultingList.add(((Node) nestedEntity).getNode());
+    }
+    if (nestedEntity instanceof NodeC) {
+      resultingList.add(((NodeC) nestedEntity).getNodeC());
+    }
+    if (nestedEntity instanceof Nodes) {
+      resultingList.addAll(
+          Arrays.asList(((Nodes) nestedEntity).getNodeA(), ((Nodes) nestedEntity).getNodeB()));
+    }
+    if (nestedEntity instanceof Type) {
+      resultingList.add(((Type) nestedEntity).getType());
+    }
+    if (resultingList.isEmpty()) {
+      throw new ExtractorException(
+          "The interface 'Nested' is not meant to be extended. The provided entity of class '"
+              + nestedEntity.getClass().getSimpleName()
+              + "' and cannot be processed by "
+              + "the extractor! Currently only the interfaces 'Node', 'NodeC', ‘Nodes‘ and ‘Type' are supported!");
+    }
+
+    return Collections.unmodifiableList(resultingList);
+  }
+
+  public List<InputEntity> getExtractedEntities() {
+    return extractedEntities;
+  }
+}

src/main/java/edu/ie3/datamodel/io/extractor/Nested.java

@@ -0,0 +1,17 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+/**
+ * This interface should be implemented only by other interfaces that should be used by the {@link
+ * Extractor} It provides the entry point for the extraction method in the {@link Extractor}. If
+ * this interface is implemented by other interfaces one has to take care about, that the
+ * corresponding method {@link Extractor.extractElements()} is extended accordingly.
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Nested {}

src/main/java/edu/ie3/datamodel/io/extractor/Node.java

@@ -0,0 +1,20 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.models.input.NodeInput;
+
+/**
+ * Interface that should be implemented by all elements holding a {@link NodeInput} and should be
+ * processable by the {@link Extractor}
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Node extends Nested {
+
+  NodeInput getNode();
+}

src/main/java/edu/ie3/datamodel/io/extractor/NodeC.java

@@ -0,0 +1,21 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.models.input.NodeInput;
+
+/**
+ * Interface that should be implemented by all elements holding a third {@link NodeInput} and should
+ * be processable by the {@link Extractor}. For now, this only holds true by the {@link
+ * edu.ie3.datamodel.models.input.connector.Transformer3WInput}
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface NodeC extends Nested {
+
+  NodeInput getNodeC();
+}

src/main/java/edu/ie3/datamodel/io/extractor/Nodes.java

@@ -0,0 +1,24 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.models.input.NodeInput;
+
+/**
+ * Interface that should be implemented by all elements holding a two {@link NodeInput} elements and
+ * should be processable by the {@link Extractor}. For now, this only holds true by all {@link
+ * edu.ie3.datamodel.models.input.connector.ConnectorInput} and {@link
+ * edu.ie3.datamodel.models.input.connector.TransformerInput}
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Nodes extends Nested {
+
+  NodeInput getNodeA();
+
+  NodeInput getNodeB();
+}

src/main/java/edu/ie3/datamodel/io/extractor/Type.java

@@ -0,0 +1,20 @@
+/*
+ * © 2020. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.models.input.AssetTypeInput;
+
+/**
+ * Interface that should be implemented by all elements holding a {@link AssetTypeInput} and should
+ * be processable by the {@link Extractor}.
+ *
+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Type extends Nested {
+
+  AssetTypeInput getType();
+}

src/main/java/edu/ie3/datamodel/io/processor/ProcessorProvider.java

@@ -130,12 +130,12 @@ private Collection<EntityProcessor<? extends UniqueEntity>> allProcessors() {
     Collection<EntityProcessor<? extends UniqueEntity>> resultingProcessors = new ArrayList<>();
 
     // todo add missing processors here
-    // AssetInput
+    // Input Entity Processor
     for (Class<? extends InputEntity> cls : InputEntityProcessor.eligibleEntityClasses) {
       resultingProcessors.add(new InputEntityProcessor(cls));
     }
 
-    // SystemParticipantResults
+    // Result Entity Processor
     for (Class<? extends ResultEntity> cls : ResultEntityProcessor.eligibleEntityClasses) {
       resultingProcessors.add(new ResultEntityProcessor(cls));
     }