Modify diagram apis #522

So-Fras · 2023-06-05T14:10:11Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?
#469
There is another PR on the same topic (#475). This old PR has diverged too much from main and it was easier to start afresh than to rebase or merge.
Developments on the old PR were added to this new PR.
New developments have been added afterwards on the new branch:

Config and ConfigBuilder have been renamed in Param and ParamBuilder
Param and ParamBuilder have become network agnostic, both for SLD and NAD (whereas it was only the case for NAD on the old PR)

What kind of change does this PR introduce?
Modification and standardization of SLD and NAD APIs

Does this PR introduce a breaking change or deprecate an API?

The Breaking Change or Deprecated label has been added
The migration guide has been updated in the github wiki (What changes might users need to make in their application due to this PR?)

Signed-off-by: Sophie Frasnedo <[email protected]>

* Remove executions goals from sld-cgmes-dl-iidm-extensions * Add new module powsybl-single-line-diagram-cgmes-iidm-extensions-test * Import Networks class from powsybl-single-line-diagram-cgmes-iidm-extensions-test * Use new module powsybl-single-line-diagram-cgmes-iidm-extensions-test instead of using test-jars * Rename & move module powsybl-single-line-diagram-cgmes-iidm-extensions-test to diagram-test * Fix sonar bug * Use Networks class instead of duplication code * Merge NetworkTestFactory into Networks class * Fix code smells on Networks class * Replace CreateNetworksUtil & NetworkFactory by Networks class * Fix code smells on Netorks * Taking into account PR comments * Fix code smells on Networks class Signed-off-by: Thomas ADAM <[email protected]>

Signed-off-by: Sophie Frasnedo <[email protected]>

network-area-diagram/src/main/java/com/powsybl/nad/NetworkAreaDiagram.java

network-area-diagram/src/main/java/com/powsybl/nad/Param.java

flo-dup · 2023-06-12T17:49:53Z

...iagram/single-line-diagram-core/src/test/java/com/powsybl/sld/iidm/AbstractTestCaseIidm.java

@@ -36,11 +39,12 @@ public abstract class AbstractTestCaseIidm extends AbstractTestCase {

    @Override
    public String toSVG(Graph g, String filename) {
-        return toSVG(g, filename, getDefaultDiagramLabelProvider(), getDefaultDiagramStyleProvider());
+        DefaultSVGWriter defaultSVGWriter = new DefaultSVGWriter(componentLibrary, layoutParameters, svgParameters);


Couldn't the SingleLineDiagram class create the SvgWriter like it used to be?

flo-dup · 2023-06-13T08:03:37Z

...e-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/SingleLineDiagram.java

-    public static void draw(Graph graph, Writer writerForSvg, Writer metadataWriter, LayoutParameters layoutParameters, ComponentLibrary componentLibrary,
-                            DiagramLabelProvider initProvider, StyleProvider styleProvider, String prefixId) {


You removed this method, but it was used in unit tests. Removing it forced you to instantiate a DefaultSvgWriter in all the unit tests. We don't want this, as this leads to always the same code in all the tests.

With the new design the equivalent would be a draw(graph, writerForSvg, metadataWriter, param) method.

flo-dup · 2023-06-13T08:04:23Z

...e-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/SingleLineDiagram.java

    }

-    public static void draw(Graph graph, Writer writerForSvg, Writer metadataWriter, DefaultSVGWriter svgWriter,
-                            DiagramLabelProvider initProvider, StyleProvider styleProvider, String prefixId) {
+    public static void draw(Graph graph, Writer writerForSvg, Writer metadataWriter, SVGWriter svgWriter, LabelProvider labelProvider, StyleProvider styleProvider, String prefixId) {


I think we should hide the svgWriter and therefore remove this method. Besides, exposing the providers is against the new design.

This a utility class, hence we want to keep methods simple (simpler than they were!), an advanced user who wants to use a custom SvgWriter can still do it, without using this class.

I did not wish to expose the providers but the LabelProvider and the StyleProvider cannot be retrieved using an SldParameters object only. I need a Network object too. That is why I had to "build" those providers earlier, when I could still have access to the Network object.

...ine-diagram-core/src/test/java/com/powsybl/sld/iidm/TestCase15GraphWithVoltageIndicator.java

...line-diagram/single-line-diagram-core/src/test/resources/TestSldClassSubstationMetadata.json

...ine-diagram-core/src/test/java/com/powsybl/sld/iidm/TestCase15GraphWithVoltageIndicator.java

Signed-off-by: Sophie Frasnedo <[email protected]>

…orship on recently created factory interfaces Signed-off-by: Sophie Frasnedo <[email protected]>

Signed-off-by: Sophie Frasnedo <[email protected]>

…ybl-diagram into modify_diagram_apis

Signed-off-by: Sophie Frasnedo <[email protected]>

…ybl-diagram into modify_diagram_apis

Signed-off-by: Sophie Frasnedo <[email protected]>

…s in a different way Signed-off-by: Sophie Frasnedo <[email protected]>

Signed-off-by: Sophie Frasnedo <[email protected]>

Signed-off-by: Geoffroy Jamgotchian <[email protected]>

sonarqubecloud · 2023-09-27T19:45:37Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
13 Code Smells

92.6% Coverage
0.9% Duplication

So-Fras and others added 7 commits April 6, 2023 16:20

Bump to v4.0.0-SNAPSHOT

39b4eb0

Signed-off-by: Sophie Frasnedo <[email protected]>

change on network-area-diagram

472c544

Signed-off-by: Sophie Frasnedo <[email protected]>

change in single-line-diagram-cgmes

90ed0a8

Signed-off-by: Sophie Frasnedo <[email protected]>

changes on single line diagram

e541a67

Signed-off-by: Sophie Frasnedo <[email protected]>

make Config network agnostic (for SLD, already done for NAD)

7a32a6d

Signed-off-by: Sophie Frasnedo <[email protected]>

rename Config in Param

919a381

Signed-off-by: Sophie Frasnedo <[email protected]>

So-Fras added Breaking change NAD SLD labels Jun 5, 2023

So-Fras requested a review from flo-dup June 5, 2023 14:12

So-Fras added 2 commits June 5, 2023 16:24

fix omissions in Config -> Param renaming

79b6b66

Signed-off-by: Sophie Frasnedo <[email protected]>

decrease code smell number

c7f2ad1

Signed-off-by: Sophie Frasnedo <[email protected]>

flo-dup force-pushed the main branch 2 times, most recently from 1a28286 to 0248753 Compare June 7, 2023 15:43

flo-dup force-pushed the modify_diagram_apis branch from c7f2ad1 to a32ca14 Compare June 7, 2023 19:57

So-Fras added 7 commits June 7, 2023 22:05

change on network-area-diagram

ca8a44c

Signed-off-by: Sophie Frasnedo <[email protected]>

change in single-line-diagram-cgmes

1b7e1d1

Signed-off-by: Sophie Frasnedo <[email protected]>

changes on single line diagram

a44deed

Signed-off-by: Sophie Frasnedo <[email protected]>

make Config network agnostic (for SLD, already done for NAD)

6941f1c

Signed-off-by: Sophie Frasnedo <[email protected]>

rename Config in Param

4c3ebd1

Signed-off-by: Sophie Frasnedo <[email protected]>

fix omissions in Config -> Param renaming

e9bcd3f

Signed-off-by: Sophie Frasnedo <[email protected]>

decrease code smell number

34a8f9c

Signed-off-by: Sophie Frasnedo <[email protected]>

flo-dup force-pushed the modify_diagram_apis branch from a32ca14 to 34a8f9c Compare June 7, 2023 20:05

fix problems following rebase of main

1d31539

Signed-off-by: Sophie Frasnedo <[email protected]>

flo-dup requested changes Jun 13, 2023

View reviewed changes

flo-dup reviewed Jun 13, 2023

View reviewed changes

...ine-diagram-core/src/test/java/com/powsybl/sld/iidm/TestCase15GraphWithVoltageIndicator.java Outdated Show resolved Hide resolved

So-Fras added 3 commits June 19, 2023 15:25

changes following review

bcab707

Signed-off-by: Sophie Frasnedo <[email protected]>

update test references following svgParameters addition in metadata

1628b6a

Signed-off-by: Sophie Frasnedo <[email protected]>

add @FunctionalInterface annotations + add missing ownership and auth…

7a0547e

…orship on recently created factory interfaces Signed-off-by: Sophie Frasnedo <[email protected]>

So-Fras mentioned this pull request Jul 13, 2023

[WIP] Allow the use of units on single-line diagram feeder info #533

Closed

3 tasks

So-Fras and others added 21 commits July 21, 2023 13:48

add a StyleProviderFactory to be used in pypowsybl

eea4c52

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'main' into modify_diagram_apis

9d163fe

Merge branch 'main' into modify_diagram_apis

575db17

Merge branch 'modify_diagram_apis' of https://github.com/powsybl/pows…

8691940

…ybl-diagram into modify_diagram_apis

Merge branch 'main' into modify_diagram_apis

4869f4a

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'modify_diagram_apis' of https://github.com/powsybl/pows…

d924398

…ybl-diagram into modify_diagram_apis

fix remaining problems following merge

bfbb02a

Signed-off-by: Sophie Frasnedo <[email protected]>

classify functions in SingleLineDiagram and NetworkAreaDiagram classe…

7cb337c

…s in a different way Signed-off-by: Sophie Frasnedo <[email protected]>

add license identifier

616165f

Signed-off-by: Sophie Frasnedo <[email protected]>

add non null checks in SLD SvgParameters

cc17f7d

Signed-off-by: Sophie Frasnedo <[email protected]>

factorize preDrawVoltageLevel and preDrawSubstation functions

d8a1a43

Signed-off-by: Sophie Frasnedo <[email protected]>

remove the builder classes for SldParameters and NadParameters

f5943b5

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'main' into modify_diagram_apis

ba52595

Signed-off-by: Sophie Frasnedo <[email protected]>

create DefaultSvgWriter inside draw function to clean test code

4e971ca

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'main' into modify_diagram_apis

f881c80

Signed-off-by: Sophie Frasnedo <[email protected]>

fix new test in TieLineTest to fit with new API design

32a66b8

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'main' into modifyd-iagram_apis

7478e4e

Signed-off-by: Sophie Frasnedo <[email protected]>

Add multi substation draw functions to API

4935442

Signed-off-by: Sophie Frasnedo <[email protected]>

Improve VoltageLevelLayoutFactoryCreator user-friendliness

5762046

Signed-off-by: Sophie Frasnedo <[email protected]>

Merge branch 'main' into modify_diagram_apis

b659685

Merge branch 'main' into modify_diagram_apis

71ab128

So-Fras mentioned this pull request Sep 27, 2023

Modify nad and sld api for better consistency #475

Closed

5 tasks

geofjamg added 2 commits September 27, 2023 21:34

Clean

9fe2fa8

Signed-off-by: Geoffroy Jamgotchian <[email protected]>

Clean

0e505fd

Signed-off-by: Geoffroy Jamgotchian <[email protected]>

geofjamg approved these changes Sep 28, 2023

View reviewed changes

So-Fras merged commit 07edea0 into main Sep 28, 2023

So-Fras deleted the modify_diagram_apis branch September 28, 2023 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modify diagram apis #522

Modify diagram apis #522

So-Fras commented Jun 5, 2023 •

edited

Loading

flo-dup Jun 12, 2023

flo-dup Jun 13, 2023

flo-dup Jun 13, 2023

So-Fras Jun 16, 2023

sonarqubecloud bot commented Sep 27, 2023

		public static void draw(Graph graph, Writer writerForSvg, Writer metadataWriter, LayoutParameters layoutParameters, ComponentLibrary componentLibrary,
		DiagramLabelProvider initProvider, StyleProvider styleProvider, String prefixId) {

Modify diagram apis #522

Modify diagram apis #522

Conversation

So-Fras commented Jun 5, 2023 • edited Loading

flo-dup Jun 12, 2023

Choose a reason for hiding this comment

flo-dup Jun 13, 2023

Choose a reason for hiding this comment

flo-dup Jun 13, 2023

Choose a reason for hiding this comment

So-Fras Jun 16, 2023

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 27, 2023

So-Fras commented Jun 5, 2023 •

edited

Loading