Modify diagram apis

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

@@ -9,19 +9,15 @@
 import com.powsybl.iidm.network.Network;
 import com.powsybl.iidm.network.VoltageLevel;
 import com.powsybl.nad.build.iidm.IdProvider;
-import com.powsybl.nad.build.iidm.IntIdProvider;
 import com.powsybl.nad.build.iidm.NetworkGraphBuilder;
 import com.powsybl.nad.build.iidm.VoltageLevelFilter;
-import com.powsybl.nad.layout.BasicForceLayoutFactory;
 import com.powsybl.nad.layout.LayoutFactory;
 import com.powsybl.nad.layout.LayoutParameters;
 import com.powsybl.nad.model.Graph;
 import com.powsybl.nad.svg.LabelProvider;
 import com.powsybl.nad.svg.StyleProvider;
 import com.powsybl.nad.svg.SvgParameters;
 import com.powsybl.nad.svg.SvgWriter;
-import com.powsybl.nad.svg.iidm.DefaultLabelProvider;
-import com.powsybl.nad.svg.iidm.TopologicalStyleProvider;
 
 import java.io.IOException;
 import java.io.StringWriter;
@@ -35,116 +31,91 @@
 /**
  * @author Florian Dupuy <florian.dupuy at rte-france.com>
  */
-public class NetworkAreaDiagram {
+public final class NetworkAreaDiagram {
 
-    private final Network network;
-    private final Predicate<VoltageLevel> voltageLevelFilter;
-
-    public NetworkAreaDiagram(Network network) {
-        this(network, VoltageLevelFilter.NO_FILTER);
-    }
-
-    public NetworkAreaDiagram(Network network, String voltageLevelId, int depth) {
-        this(network, VoltageLevelFilter.createVoltageLevelDepthFilter(network, voltageLevelId, depth));
-    }
-
-    public NetworkAreaDiagram(Network network, List<String> voltageLevelIds) {
-        this(network, VoltageLevelFilter.createVoltageLevelsFilter(network, voltageLevelIds));
-    }
-
-    public NetworkAreaDiagram(Network network, List<String> voltageLevelIds, int depth) {
-        this(network, VoltageLevelFilter.createVoltageLevelsDepthFilter(network, voltageLevelIds, depth));
-    }
-
-    public NetworkAreaDiagram(Network network, Predicate<VoltageLevel> voltageLevelFilter) {
-        this.network = Objects.requireNonNull(network);
-        this.voltageLevelFilter = Objects.requireNonNull(voltageLevelFilter);
+    private NetworkAreaDiagram() {
     }
 
-    public Network getNetwork() {
-        return network;
-    }
+    /* ------------------------------------------------------------------------------------------------ */
+    // Network, Path and different options of filtering
+    /* ------------------------------------------------------------------------------------------------ */
 
-    public void draw(Path svgFile) {
-        draw(svgFile, new SvgParameters());
+    public static void draw(Network network, Path svgFile) {
+        draw(network, svgFile, new ParamBuilder().build(), VoltageLevelFilter.NO_FILTER);
     }
 
-    public void draw(Path svgFile, SvgParameters svgParameters) {
-        draw(svgFile, svgParameters, new LayoutParameters());
+    public static void draw(Network network, Path svgFile, String voltageLevelId, int depth) {
+        draw(network, svgFile, new ParamBuilder().build(), VoltageLevelFilter.createVoltageLevelDepthFilter(network, voltageLevelId, depth));
     }
 
-    public void draw(Path svgFile, SvgParameters svgParameters, LayoutParameters layoutParameters) {
-        draw(svgFile, svgParameters, layoutParameters, new TopologicalStyleProvider(network));
+    public static void draw(Network network, Path svgFile, List<String> voltageLevelIds) {
+        draw(network, svgFile, new ParamBuilder().build(), VoltageLevelFilter.createVoltageLevelsFilter(network, voltageLevelIds));
     }
 
-    public void draw(Path svgFile, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                                   StyleProvider styleProvider) {
-        draw(svgFile, svgParameters, layoutParameters, styleProvider, new DefaultLabelProvider(network, svgParameters));
+    public static void draw(Network network, Path svgFile, List<String> voltageLevelIds, int depth) {
+        draw(network, svgFile, new ParamBuilder().build(), VoltageLevelFilter.createVoltageLevelsDepthFilter(network, voltageLevelIds, depth));
     }
 
-    public void draw(Path svgFile, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                                   StyleProvider styleProvider, LabelProvider labelProvider) {
-        draw(svgFile, svgParameters, layoutParameters, styleProvider, labelProvider, new BasicForceLayoutFactory());
-    }
+    /* ---------------------------------------------------------------- */
+    // Network, Path, Param, Predicate
+    /* ---------------------------------------------------------------- */
 
-    public void draw(Path svgFile, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                                   StyleProvider styleProvider, LabelProvider labelProvider, LayoutFactory layoutFactory) {
-        draw(svgFile, svgParameters, layoutParameters, styleProvider, labelProvider, layoutFactory, new IntIdProvider());
-    }
+    public static void draw(Network network, Path svgFile, Param param, Predicate<VoltageLevel> voltageLevelFilter) {
 
-    public void draw(Path svgFile, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                                   StyleProvider styleProvider, LabelProvider labelProvider, LayoutFactory layoutFactory,
-                                   IdProvider idProvider) {
+        Objects.requireNonNull(network);
         Objects.requireNonNull(svgFile);
+        LayoutParameters layoutParameters = param.getLayoutParameters();
+        SvgParameters svgParameters = param.getSvgParameters();
+        StyleProvider styleProvider = param.createStyleProvider(network);
+        LayoutFactory layoutFactory = param.getLayoutFactory();
+        IdProvider idProvider = param.createIdProvider();
+        LabelProvider labelProvider = param.createLabelProvider(network);
         Objects.requireNonNull(layoutParameters);
         Objects.requireNonNull(svgParameters);
         Objects.requireNonNull(styleProvider);
         Objects.requireNonNull(layoutFactory);
         Objects.requireNonNull(idProvider);
+        Objects.requireNonNull(voltageLevelFilter);
 
         Graph graph = new NetworkGraphBuilder(network, voltageLevelFilter, idProvider).buildGraph();
         layoutFactory.create().run(graph, layoutParameters);
         new SvgWriter(svgParameters, styleProvider, labelProvider).writeSvg(graph, svgFile);
     }
 
-    public void draw(Writer writer) {
-        draw(writer, new SvgParameters());
-    }
+    /* ------------------------------------------------------------------------------------------------ */
+    // Network, Writer and different options of filtering
+    /* ------------------------------------------------------------------------------------------------ */
 
-    public void draw(Writer writer, SvgParameters svgParameters) {
-        draw(writer, svgParameters, new LayoutParameters());
+    public static void draw(Network network, Writer writer) {
+        draw(network, writer, new ParamBuilder().build(), VoltageLevelFilter.NO_FILTER);
     }
 
-    public void draw(Writer writer, SvgParameters svgParameters, LayoutParameters layoutParameters) {
-        draw(writer, svgParameters, layoutParameters, new TopologicalStyleProvider(network));
+    public static void draw(Network network, Writer writer, String voltageLevelId, int depth) {
+        draw(network, writer, new ParamBuilder().build(), VoltageLevelFilter.createVoltageLevelDepthFilter(network, voltageLevelId, depth));
     }
 
-    public void draw(Writer writer, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                     StyleProvider styleProvider) {
-        draw(writer, svgParameters, layoutParameters, styleProvider, new DefaultLabelProvider(network, svgParameters));
+    public static void draw(Network network, Writer writer, List<String> voltageLevelIds) {
+        draw(network, writer, new ParamBuilder().build(), VoltageLevelFilter.createVoltageLevelsFilter(network, voltageLevelIds));
     }
 
-    public void draw(Writer writer, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                     StyleProvider styleProvider, LabelProvider labelProvider) {
-        draw(writer, svgParameters, layoutParameters, styleProvider, labelProvider, new BasicForceLayoutFactory());
+    public void draw(Network network, Writer writer, Predicate<VoltageLevel> voltageLevelFilter) {
+        draw(network, writer, new ParamBuilder().build(), voltageLevelFilter);
     }
 
-    public void draw(Writer writer, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                     StyleProvider styleProvider, LabelProvider labelProvider, LayoutFactory layoutFactory) {
-        draw(writer, svgParameters, layoutParameters, styleProvider, labelProvider, layoutFactory, new IntIdProvider());
-    }
+    /* ----------------------------------------------------------------------------------------------- */
+    // Network, Writer, Param, Predicate
+    /* ----------------------------------------------------------------------------------------------- */
 
-    public void draw(Writer writer, SvgParameters svgParameters, LayoutParameters layoutParameters,
-                     StyleProvider styleProvider, LabelProvider labelProvider, LayoutFactory layoutFactory,
-                     IdProvider idProvider) {
-        Graph graph = new NetworkGraphBuilder(network, voltageLevelFilter, idProvider).buildGraph();
-        layoutFactory.create().run(graph, layoutParameters);
-        new SvgWriter(svgParameters, styleProvider, labelProvider).writeSvg(graph, writer);
+    public static void draw(Network network, Writer writer, Param param, Predicate<VoltageLevel> voltageLevelFilter) {
+        Graph graph = new NetworkGraphBuilder(network, voltageLevelFilter, param.createIdProvider()).buildGraph();
+        param.getLayoutFactory().create().run(graph, param.getLayoutParameters());
+        new SvgWriter(param.getSvgParameters(), param.createStyleProvider(network), param.createLabelProvider(network)).writeSvg(graph, writer);
     }
 
-    public String drawToString(SvgParameters svgParameters) {
+    public String drawToString(Network network, SvgParameters svgParameters) {
         try (StringWriter writer = new StringWriter()) {
-            draw(writer, svgParameters);
+            Param param = new ParamBuilder().withSvgParameters(svgParameters).build();
+            draw(network, writer, param, VoltageLevelFilter.NO_FILTER);
             return writer.toString();
         } catch (IOException e) {
             throw new UncheckedIOException(e);

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

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2023, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.nad;
+
+import com.powsybl.iidm.network.Network;
+import com.powsybl.nad.build.iidm.IdProvider;
+import com.powsybl.nad.layout.LayoutFactory;
+import com.powsybl.nad.layout.LayoutParameters;
+import com.powsybl.nad.svg.LabelProvider;
+import com.powsybl.nad.svg.StyleProvider;
+import com.powsybl.nad.svg.SvgParameters;
+
+/**
+ *
+ * @author Sophie Frasnedo <sophie.frasnedo at rte-france.com>
+ */
+public class Param {
+
+    SvgParameters svgParameters;
+    LayoutParameters layoutParameters;
+    ParamBuilder.StyleProviderFactory styleProviderFactory;
+    ParamBuilder.LabelProviderFactory labelProviderFactory;
+    LayoutFactory layoutFactory;
+    ParamBuilder.IdProviderFactory idProviderFactory;
+
+    public Param(SvgParameters svgParameters, LayoutParameters layoutParameters, ParamBuilder.StyleProviderFactory styleProviderFactory, ParamBuilder.LabelProviderFactory labelProviderFactory, LayoutFactory layoutFactory, ParamBuilder.IdProviderFactory idProviderFactory) {
+        this.svgParameters = svgParameters;
+        this.layoutParameters = layoutParameters;
+        this.styleProviderFactory = styleProviderFactory;
+        this.labelProviderFactory = labelProviderFactory;
+        this.layoutFactory = layoutFactory;
+        this.idProviderFactory = idProviderFactory;
+    }
+
+    public SvgParameters getSvgParameters() {
+        return svgParameters;
+    }
+
+    public LayoutParameters getLayoutParameters() {
+        return layoutParameters;
+    }
+
+    public StyleProvider createStyleProvider(Network network) {
+        return styleProviderFactory.create(network);
+    }
+
+    public LabelProvider createLabelProvider(Network network) {
+        return labelProviderFactory.create(network, svgParameters);
+    }
+
+    public LayoutFactory getLayoutFactory() {
+        return layoutFactory;
+    }
+
+    public IdProvider createIdProvider() {
+        return idProviderFactory.create();
+    }
+
+}

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

@@ -0,0 +1,86 @@
+/**
+ * Copyright (c) 2023, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.nad;
+
+import com.powsybl.iidm.network.Network;
+import com.powsybl.nad.build.iidm.IdProvider;
+import com.powsybl.nad.build.iidm.IntIdProvider;
+import com.powsybl.nad.layout.BasicForceLayoutFactory;
+import com.powsybl.nad.layout.LayoutFactory;
+import com.powsybl.nad.layout.LayoutParameters;
+import com.powsybl.nad.svg.LabelProvider;
+import com.powsybl.nad.svg.StyleProvider;
+import com.powsybl.nad.svg.SvgParameters;
+import com.powsybl.nad.svg.iidm.DefaultLabelProvider;
+import com.powsybl.nad.svg.iidm.TopologicalStyleProvider;
+
+/**
+ *
+ * @author Sophie Frasnedo <sophie.frasnedo at rte-france.com>
+ */
+public class ParamBuilder {
+    SvgParameters svgParameters = new SvgParameters();
+    LayoutParameters layoutParameters = new LayoutParameters();
+    StyleProviderFactory styleProviderFactory = TopologicalStyleProvider::new;
+    LabelProviderFactory labelProviderFactory = DefaultLabelProvider::new;
+    LayoutFactory layoutFactory = new BasicForceLayoutFactory();
+    IdProviderFactory idProviderFactory = IntIdProvider::new;
+
+    @FunctionalInterface
+    public interface LabelProviderFactory {
+        LabelProvider create(Network network, SvgParameters svgParameters);
+    }
+
+    @FunctionalInterface
+    public interface IdProviderFactory {
+        IdProvider create();
+    }
+
+    @FunctionalInterface
+    public interface StyleProviderFactory {
+        StyleProvider create(Network network);
+    }
+
+    public ParamBuilder() {
+        /* This builder is network-agnostic */
+    }
+
+    public ParamBuilder withSvgParameters(SvgParameters svgParameters) {
+        this.svgParameters = svgParameters;
+        return this;
+    }
+
+    public ParamBuilder withLayoutParameters(LayoutParameters layoutParameters) {
+        this.layoutParameters = layoutParameters;
+        return this;
+    }
+
+    public ParamBuilder withStyleProviderFactory(StyleProviderFactory styleProviderFactory) {
+        this.styleProviderFactory = styleProviderFactory;
+        return this;
+    }
+
+    public ParamBuilder withLabelProviderFactory(LabelProviderFactory labelProviderFactory) {
+        this.labelProviderFactory = labelProviderFactory;
+        return this;
+    }
+
+    public ParamBuilder withLayoutFactory(LayoutFactory layoutFactory) {
+        this.layoutFactory = layoutFactory;
+        return this;
+    }
+
+    public ParamBuilder withIdProviderFactory(IdProviderFactory idProviderFactory) {
+        this.idProviderFactory = idProviderFactory;
+        return this;
+    }
+
+    public Param build() {
+        return new Param(svgParameters, layoutParameters, styleProviderFactory, labelProviderFactory, layoutFactory, idProviderFactory);
+    }
+
+}

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

@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package com.powsybl.nad.layout;
 
 import com.powsybl.nad.model.*;
@@ -6,6 +12,10 @@
 import java.util.*;
 import java.util.stream.Stream;
 
+/**
+ *
+ * @author Florian Dupuy <florian.dupuy at rte-france.com>
+ */
 public abstract class AbstractLayout implements Layout {
 
     private Map<String, Point> initialNodePositions = Collections.emptyMap();

network-area-diagram/src/main/java/com/powsybl/nad/svg/metadata/BusNodeMetadata.java

@@ -1,7 +1,18 @@
 package com.powsybl.nad.svg.metadata;
 
+/**
+ * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 import javax.xml.stream.XMLStreamReader;
 
+/**
+ *
+ * @author Florian Dupuy <florian.dupuy at rte-france.com>
+ */
+
 public class BusNodeMetadata extends AbstractMetadataItem {
     private static final String ELEMENT_NAME = "busNode";
 

network-area-diagram/src/main/java/com/powsybl/nad/utils/iidm/IidmUtils.java

@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 package com.powsybl.nad.utils.iidm;
 
 import com.powsybl.iidm.network.*;
@@ -7,6 +13,12 @@
 
 import java.util.Objects;
 
+/**
+ *
+ * @author Florian Dupuy <florian.dupuy at rte-france.com>
+ * @author Luma Zamarreño <zamarrenolm at aia.es>
+ */
+
 public final class IidmUtils {
 
     private IidmUtils() {