Use the new SVG legend writer

pom.xml

@@ -52,6 +52,8 @@
         <liquibase-hibernate-package>com.powsybl.sld.server</liquibase-hibernate-package>
         <powsybl-ws-dependencies.version>2.29.0</powsybl-ws-dependencies.version>
         <supercsv.version>2.4.0</supercsv.version>
+        <!-- FIXME to remove at next upgrade of powsybl-ws-dependencies -->
+        <powsybl-diagram.version>5.1.0</powsybl-diagram.version>
     </properties>
 
     <build>
@@ -123,14 +125,24 @@
         <dependency>
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-network-area-diagram</artifactId>
+            <!-- FIXME to remove at next upgrade of powsybl-ws-dependencies -->
+            <version>${powsybl-diagram.version}</version>
         </dependency>
         <dependency>
             <groupId>com.powsybl</groupId>
-            <artifactId>powsybl-network-store-client</artifactId>
+            <artifactId>powsybl-single-line-diagram-core</artifactId>
+            <!-- FIXME to remove at next upgrade of powsybl-ws-dependencies -->
+            <version>${powsybl-diagram.version}</version>
         </dependency>
+        <!-- FIXME to remove at next upgrade of powsybl-ws-dependencies -->
         <dependency>
             <groupId>com.powsybl</groupId>
-            <artifactId>powsybl-single-line-diagram-core</artifactId>
+            <artifactId>powsybl-diagram-util</artifactId>
+            <version>${powsybl-diagram.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.powsybl</groupId>
+            <artifactId>powsybl-network-store-client</artifactId>
         </dependency>
         <dependency>
             <groupId>com.powsybl</groupId>

src/main/java/com/powsybl/sld/server/CommonLabelProvider.java

@@ -1,71 +1,30 @@
+/**
+ * Copyright (c) 2025, 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.sld.server;
 
 import com.powsybl.iidm.network.*;
 import com.powsybl.iidm.network.extensions.OperatingStatus;
 import com.powsybl.sld.layout.LayoutParameters;
 import com.powsybl.sld.library.SldComponentLibrary;
 import com.powsybl.sld.model.coordinate.Direction;
-import com.powsybl.sld.model.graphs.VoltageLevelGraph;
 import com.powsybl.sld.model.nodes.*;
-import com.powsybl.sld.svg.BusLegendInfo;
 import com.powsybl.sld.svg.DefaultLabelProvider;
-import com.powsybl.sld.svg.LabelProviderFactory;
 import com.powsybl.sld.svg.SvgParameters;
 
-import java.util.*;
-import java.util.stream.DoubleStream;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
 
 public class CommonLabelProvider extends DefaultLabelProvider {
-    private static final String UNIT_MW = "MW";
-    private static final String UNIT_KV = "kV";
-    private static final String UNIT_KA = "kA";
-
-    private static final String PREFIX_VOLTAGE = "U = ";
-    private static final String PREFIX_ANGLE = "θ = ";
-    private static final String PREFIX_PRODUCTION = "P = ";
-    private static final String PREFIX_CONSUMPTION = "C = ";
-    private static final String PREFIX_ICC = "ICC = ";
-
-    private static final String KEY_BUS_ID = "busId";
-    public static final String KEY_VOLTAGE = "v";
-    public static final String KEY_ANGLE = "angle";
-    public static final String KEY_CONSUMPTION = "consumption-sum";
-    public static final String KEY_PRODUCTION = "production-sum";
-    public static final String KEY_ICC = "icc";
-
     private static final String PLANNED_OUTAGE_BRANCH_NODE_DECORATOR = "LOCK";
     private static final String FORCED_OUTAGE_BRANCH_NODE_DECORATOR = "FLASH";
 
-    private final Map<String, Double> busIdToIccMap;
-
     public CommonLabelProvider(Network network, SldComponentLibrary componentLibrary, LayoutParameters layoutParameters, SvgParameters svgParameters) {
         super(network, componentLibrary, layoutParameters, svgParameters);
-        this.busIdToIccMap = null;
-    }
-
-    public CommonLabelProvider(Network network, SldComponentLibrary componentLibrary, LayoutParameters layoutParameters, SvgParameters svgParameters, Map<String, Double> busIdToIccMap) {
-        super(network, componentLibrary, layoutParameters, svgParameters);
-        this.busIdToIccMap = busIdToIccMap;
-    }
-
-    public static LabelProviderFactory newCommonLabelProviderFactory(Map<String, Double> busIdToIccMap) {
-        return (network, compLibrary, layoutParameters, svgParameters) -> new CommonLabelProvider(network, compLibrary, layoutParameters, svgParameters, busIdToIccMap);
-    }
-
-    @Override
-    public List<BusLegendInfo> getBusLegendInfos(VoltageLevelGraph graph) {
-        VoltageLevel vl = network.getVoltageLevel(graph.getVoltageLevelInfos().getId());
-        return vl.getBusView().getBusStream()
-            .map(b ->
-                new BusLegendInfo(b.getId(), List.of(
-                    new BusLegendInfo.Caption(b.getId(), KEY_BUS_ID),
-                    new BusLegendInfo.Caption(PREFIX_VOLTAGE + valueFormatter.formatVoltage(b.getV(), UNIT_KV), KEY_VOLTAGE),
-                    new BusLegendInfo.Caption(PREFIX_ANGLE + valueFormatter.formatAngleInDegrees(b.getAngle()), KEY_ANGLE),
-                    new BusLegendInfo.Caption(PREFIX_PRODUCTION + formatPowerSum(b.getGeneratorStream().mapToDouble(g -> g.getTerminal().getP())), KEY_CONSUMPTION),
-                    new BusLegendInfo.Caption(PREFIX_CONSUMPTION + formatPowerSum(b.getLoadStream().mapToDouble(l -> l.getTerminal().getP())), KEY_PRODUCTION),
-                    new BusLegendInfo.Caption(PREFIX_ICC + getFormattedBusIcc(b.getId()), KEY_ICC)
-                ))
-            ).toList();
     }
 
     @Override
@@ -161,29 +120,4 @@ private NodeDecorator addOperatingStatusDecorator(Node node, Direction direction
             case null, default -> new NodeDecorator(decoratorType, getGenericDecoratorPosition());
         };
     }
-
-    private String getFormattedBusIcc(String busId) {
-        Double iccInA = busIdToIccMap == null ? null : busIdToIccMap.get(busId);
-
-        String value = iccInA != null
-            ? String.format(Locale.US, "%.1f", iccInA / 1000.0)
-            : svgParameters.getUndefinedValueSymbol();
-
-        return value + " " + UNIT_KA;
-    }
-
-    private String formatPowerSum(DoubleStream stream) {
-        OptionalDouble sum = sumDoubleStream(stream);
-        String value = sum.isPresent()
-            ? String.valueOf(Math.round(Math.abs(sum.getAsDouble())))
-            : svgParameters.getUndefinedValueSymbol();
-        return value + " " + UNIT_MW;
-    }
-
-    private static OptionalDouble sumDoubleStream(DoubleStream stream) {
-        DoubleSummaryStatistics stats = stream.summaryStatistics();
-        return stats.getCount() == 0
-            ? OptionalDouble.empty()
-            : OptionalDouble.of(stats.getSum());
-    }
 }

src/main/java/com/powsybl/sld/server/CommonLegendWriter.java

@@ -0,0 +1,86 @@
+/**
+ * Copyright (c) 2025, 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.sld.server;
+
+import com.powsybl.iidm.network.Network;
+import com.powsybl.iidm.network.VoltageLevel;
+import com.powsybl.sld.model.graphs.VoltageLevelGraph;
+import com.powsybl.sld.svg.*;
+
+import java.util.*;
+import java.util.stream.DoubleStream;
+
+public class CommonLegendWriter extends DefaultSVGLegendWriter {
+    private static final String UNIT_MW = "MW";
+    private static final String UNIT_KV = "kV";
+    private static final String UNIT_KA = "kA";
+
+    private static final String PREFIX_VOLTAGE = "U = ";
+    private static final String PREFIX_ANGLE = "θ = ";
+    private static final String PREFIX_PRODUCTION = "P = ";
+    private static final String PREFIX_CONSUMPTION = "C = ";
+    private static final String PREFIX_ICC = "ICC = ";
+
+    private static final String KEY_BUS_ID = "busId";
+    public static final String KEY_VOLTAGE = "v";
+    public static final String KEY_ANGLE = "angle";
+    public static final String KEY_CONSUMPTION = "consumption-sum";
+    public static final String KEY_PRODUCTION = "production-sum";
+    public static final String KEY_ICC = "icc";
+
+    private final Map<String, Double> iccByBusId;
+
+    public static LegendWriterFactory createFactory(Map<String, Double> iccByBusId) {
+        return (network, svgParameters) -> new CommonLegendWriter(network, svgParameters, iccByBusId);
+    }
+
+    public CommonLegendWriter(Network network, SvgParameters svgParameters, Map<String, Double> iccByBusId) {
+        super(network, svgParameters);
+        this.iccByBusId = iccByBusId;
+    }
+
+    @Override
+    protected List<BusLegendInfo> getBusLegendInfos(VoltageLevelGraph graph) {
+        VoltageLevel vl = network.getVoltageLevel(graph.getVoltageLevelInfos().getId());
+        return vl.getBusView().getBusStream()
+            .map(b ->
+                new BusLegendInfo(b.getId(), List.of(
+                    new BusLegendInfo.Caption(b.getId(), KEY_BUS_ID),
+                    new BusLegendInfo.Caption(PREFIX_VOLTAGE + valueFormatter.formatVoltage(b.getV(), UNIT_KV), KEY_VOLTAGE),
+                    new BusLegendInfo.Caption(PREFIX_ANGLE + valueFormatter.formatAngleInDegrees(b.getAngle()), KEY_ANGLE),
+                    new BusLegendInfo.Caption(PREFIX_PRODUCTION + formatPowerSum(b.getGeneratorStream().mapToDouble(g -> g.getTerminal().getP())), KEY_CONSUMPTION),
+                    new BusLegendInfo.Caption(PREFIX_CONSUMPTION + formatPowerSum(b.getLoadStream().mapToDouble(l -> l.getTerminal().getP())), KEY_PRODUCTION),
+                    new BusLegendInfo.Caption(PREFIX_ICC + getFormattedBusIcc(b.getId()), KEY_ICC)
+                ))
+            ).toList();
+    }
+
+    private String getFormattedBusIcc(String busId) {
+        Double iccInA = iccByBusId == null ? null : iccByBusId.get(busId);
+
+        String value = iccInA != null
+            ? String.format(Locale.US, "%.1f", iccInA / 1000.0)
+            : svgParameters.getUndefinedValueSymbol();
+
+        return value + " " + UNIT_KA;
+    }
+
+    private String formatPowerSum(DoubleStream stream) {
+        OptionalDouble sum = sumDoubleStream(stream);
+        String value = sum.isPresent()
+            ? String.valueOf(Math.round(Math.abs(sum.getAsDouble())))
+            : svgParameters.getUndefinedValueSymbol();
+        return value + " " + UNIT_MW;
+    }
+
+    private static OptionalDouble sumDoubleStream(DoubleStream stream) {
+        DoubleSummaryStatistics stats = stream.summaryStatistics();
+        return stats.getCount() == 0
+            ? OptionalDouble.empty()
+            : OptionalDouble.of(stats.getSum());
+    }
+}

src/main/java/com/powsybl/sld/server/SingleLineDiagramService.java

@@ -103,7 +103,8 @@ SvgAndMetadata generateSvgAndMetadata(UUID networkUuid, String variantId, String
                     break;
                 case SldDisplayMode.STATE_VARIABLE:
                     svgParameters.setBusesLegendAdded(true);
-                    sldParameters.setLabelProviderFactory(CommonLabelProvider.newCommonLabelProviderFactory(sldRequestInfos.getBusIdToIccValues()));
+                    sldParameters.setLabelProviderFactory(CommonLabelProvider::new);
+                    sldParameters.setLegendWriterFactory(CommonLegendWriter.createFactory(sldRequestInfos.getBusIdToIccValues()));
                     break;
                 default:
                     throw new PowsyblException(String.format("Given sld display mode %s doesn't exist", sldRequestInfos.getSldDisplayMode()));

src/main/java/com/powsybl/sld/server/utils/BusLegendStyleProvider.java

@@ -13,7 +13,7 @@
 import java.util.Collections;
 import java.util.List;
 
-import static com.powsybl.sld.server.CommonLabelProvider.*;
+import static com.powsybl.sld.server.CommonLegendWriter.*;
 
 /**
  * @author Kevin Le Saulnier <kevin.lesaulnier at rte-france.com>