Extractor for nested models #92

johanneshiry · 2020-03-31T12:15:23Z

resolves #78

codecov · 2020-03-31T12:40:39Z

Codecov Report

Merging #92 into master will increase coverage by 0.29%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master      #92      +/-   ##
============================================
+ Coverage     61.52%   61.82%   +0.29%     
- Complexity      777      793      +16     
============================================
  Files           182      184       +2     
  Lines          3413     3455      +42     
  Branches        430      436       +6     
============================================
+ Hits           2100     2136      +36     
  Misses         1188     1188              
- Partials        125      131       +6

Impacted Files	Coverage Δ	Complexity Δ
...in/java/edu/ie3/datamodel/io/sink/CsvFileSink.java	`87.09% <0%> (-6.09%)`	`19% <0%> (+4%)`
...3/datamodel/models/input/MeasurementUnitInput.java	`40% <0%> (ø)`	`6% <0%> (ø)`	⬇️
...el/models/input/system/SystemParticipantInput.java	`33.33% <0%> (ø)`	`3% <0%> (ø)`	⬇️
...del/models/input/connector/Transformer3WInput.java	`46.87% <0%> (ø)`	`8% <0%> (ø)`	⬇️
...ava/edu/ie3/datamodel/models/input/AssetInput.java	`57.89% <0%> (ø)`	`7% <0%> (+1%)`	⬆️
...del/models/input/connector/Transformer2WInput.java	`35.71% <0%> (ø)`	`4% <0%> (ø)`	⬇️
...edu/ie3/datamodel/models/input/system/EvInput.java	`28.57% <0%> (ø)`	`2% <0%> (ø)`	⬇️
...e3/datamodel/models/input/system/StorageInput.java	`35.29% <0%> (ø)`	`3% <0%> (ø)`	⬇️
...e3/datamodel/models/input/connector/LineInput.java	`38.46% <0%> (ø)`	`5% <0%> (ø)`	⬇️
...du/ie3/datamodel/models/input/system/ChpInput.java	`40% <0%> (ø)`	`5% <0%> (ø)`	⬇️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 40f93a1...f6d8106. Read the comment docs.

- adaptions in Extractor processing to throw an exception for unknown elements - integrate Extractor into CsvFileSink - extended DataSink interface with methods for nested and unnested elements for performance purposes

ckittl

Despite my comments, your and my approach in #89 differ, especially in terms of the role of the DataSink. Let's discuss to get the best solution.

ckittl · 2020-04-01T07:34:09Z

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

+ * @version 0.1
+ * @since 31.03.20
+ */
+public class Extractor {


I would suggest to have a simple static class. So then you could save the instantiation.

Suggested change

public class Extractor {

public class NestedEntityUtils {

public NestedEntityUtils() {

throw new IllegalStateException("Do not instantiate static utility class");

}

ckittl · 2020-04-01T07:45:12Z

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

+    this.extractedEntities = extractElements(nestedEntity);
+  }
+
+  private List<InputEntity> extractElements(Nested nestedEntity) throws ExtractorException {


Suggested change

private List<InputEntity> extractElements(Nested nestedEntity) throws ExtractorException {

private Set<InputEntity> extractElements(Collection<Nested> nestedEntities) throws ExtractorException {

return Collections.unmodifiableSet(nestedEntities.stream().map(nested -> {

if (nestedEntities instanceof Node) {

return Collections.singletonList(((Node) nestedEntities).getNode());

} else if (nestedEntities instanceof NodeC) {

return Collections.singletonList(((NodeC) nestedEntities).getNodeC());

} else if (nestedEntities instanceof Nodes) {

return Arrays.asList(((Nodes) nestedEntities).getNodeA(), ((Nodes) nestedEntities).getNodeB());

} else if (nestedEntities instanceof Type) {

return Collections.singletonList(((Type) nestedEntities).getType());

} else {

return new ArrayList<InputEntity>();

}

}).flatMap(List::stream).collect(Collectors.toSet()));

}

This automatically would ensure, that duplicated nodes etc. are only apparent once.

ckittl · 2020-04-01T07:46:00Z

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

+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Nested {}


Suggested change

public interface Nested {}

public interface NestedEntity {}

ckittl · 2020-04-01T07:47:04Z

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

+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Node extends Nested {


What about pimpin the Nodes interface and letting go Node and NodeC? See comments below.

ckittl · 2020-04-01T07:48:01Z

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

+ * @version 0.1
+ * @since 31.03.20
+ */
+public interface Nodes extends Nested {


Suggested change

public interface Nodes extends Nested {

public interface WithNestedNodes extends Nested {

It is not really an Interface describing nodes conceptually, but an entity, that has nodes.

ckittl · 2020-04-01T07:48:28Z

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

+  NodeInput getNodeA();
+
+  NodeInput getNodeB();


Suggested change

NodeInput getNodeA();

NodeInput getNodeB();

Collection<NodeInput> getNodes();

fixed documentation

b5fb4fd

johanneshiry added the enhancement New feature or request label Mar 31, 2020

johanneshiry added this to the Version 1.0 milestone Mar 31, 2020

johanneshiry requested a review from ckittl March 31, 2020 12:15

johanneshiry self-assigned this Mar 31, 2020

adapted Jenkinsfile for builds without PR

86c54e4

johanneshiry added 10 commits March 31, 2020 15:06

added interfaces for classes holding nodes or types

ce6a95a

added Nodes interface to corresponding classes

4cb0463

added Extractor for nested models

6bfa59f

moved extractor and new interfaces to own class

8b50db6

- added ExtractorException

795fcc3

- adaptions in Extractor processing to throw an exception for unknown elements - integrate Extractor into CsvFileSink - extended DataSink interface with methods for nested and unnested elements for performance purposes

fmt

7e1a634

disabled passed tests login in tests.gradle

bddcb0e

disabled passed tests logging for allTests()

2c07caf

introduced new interfaces to avoid model adaptions for Extractor

8869594

added type interface to classes that hold a type

39e83f7

johanneshiry changed the title ~~fixed documentation~~ Extractor for nested models Mar 31, 2020

johanneshiry added 7 commits March 31, 2020 19:32

added ExtractorTest + minor adaptions

27cc3bd

extended tests for CsvFileSink

1376151

reduced constructor complexity in CsvFileSink

5547b54

fmt

c47866f

addressing codacy issues

d45c2a9

added new interfaces to InputDatamodelConcept.puml

7b484fb

added missing documentation + fmt

25008b0

johanneshiry marked this pull request as ready for review April 1, 2020 07:41

fix a wrong cast in CsvFileSink

17e7438

ckittl suggested changes Apr 1, 2020

View reviewed changes

johanneshiry and others added 2 commits April 1, 2020 10:08

fmt

65040e1

Merge branch 'master' into jh/#78-nested-model-extractor

f6d8106

ckittl approved these changes Apr 1, 2020

View reviewed changes

ckittl merged commit ae69cc9 into master Apr 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Extractor for nested models #92

Extractor for nested models #92

Uh oh!

johanneshiry commented Mar 31, 2020

Uh oh!

codecov bot commented Mar 31, 2020 •

edited

Loading

Uh oh!

ckittl left a comment

Uh oh!

ckittl Apr 1, 2020

Uh oh!

ckittl Apr 1, 2020

Uh oh!

ckittl Apr 1, 2020

Uh oh!

ckittl Apr 1, 2020

Uh oh!

ckittl Apr 1, 2020

Uh oh!

ckittl Apr 1, 2020

Uh oh!

Uh oh!

-public class Extractor {
+public class NestedEntityUtils {
+public NestedEntityUtils() {
+    throw new IllegalStateException("Do not instantiate static utility class");
+}

-  private List<InputEntity> extractElements(Nested nestedEntity) throws ExtractorException {
+private Set<InputEntity> extractElements(Collection<Nested> nestedEntities) throws ExtractorException {
+    return Collections.unmodifiableSet(nestedEntities.stream().map(nested -> {
+      if (nestedEntities instanceof Node) {
+        return Collections.singletonList(((Node) nestedEntities).getNode());
+      } else if (nestedEntities instanceof NodeC) {
+        return Collections.singletonList(((NodeC) nestedEntities).getNodeC());
+      } else if (nestedEntities instanceof Nodes) {
+        return Arrays.asList(((Nodes) nestedEntities).getNodeA(), ((Nodes) nestedEntities).getNodeB());
+      } else if (nestedEntities instanceof Type) {
+        return Collections.singletonList(((Type) nestedEntities).getType());
+      } else {
+        return new ArrayList<InputEntity>();
+      }
+    }).flatMap(List::stream).collect(Collectors.toSet()));
+  }

	public interface Nodes extends Nested {
	public interface WithNestedNodes extends Nested {

Extractor for nested models #92

Extractor for nested models #92

Uh oh!

Conversation

johanneshiry commented Mar 31, 2020

Uh oh!

codecov bot commented Mar 31, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ckittl left a comment

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

ckittl Apr 1, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Mar 31, 2020 •

edited

Loading