[NAD] Move some svg parmeters from SvgWriter to the DefaultLabelProvider (#692)

CBiasuzzi · web-flow · commit 9d06de7addeb · 2025-04-08T13:54:49.000+02:00
* moves some NAD svg parameters checking from svgwriter to the LabelProvider
* removes the simple rendering mode for VL text nodes

Signed-off-by: Christian Biasuzzi &lt;christian.biasuzzi@soft.it&gt;
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java b/network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java
@@ -39,7 +39,6 @@ public class SvgWriter {
     private static final String PATH_ELEMENT_NAME = "path";
     private static final String CIRCLE_ELEMENT_NAME = "circle";
     private static final String TEXT_ELEMENT_NAME = "text";
-    private static final String TSPAN_ELEMENT_NAME = "tspan";
     private static final String FOREIGN_OBJECT_ELEMENT_NAME = "foreignObject";
     private static final String DIV_ELEMENT_NAME = "div";
     private static final String TABLE_ELEMENT_NAME = "table";
@@ -58,7 +57,6 @@ public class SvgWriter {
     private static final String PATH_D_ATTRIBUTE = "d";
     private static final String X_ATTRIBUTE = "x";
     private static final String Y_ATTRIBUTE = "y";
-    private static final String DY_ATTRIBUTE = "dy";
     private static final String POINTS_ATTRIBUTE = "points";
     private static final String HREF_ATTRIBUTE = "href";
 
@@ -158,9 +156,7 @@ private void drawHighlightBranchEdges(Graph graph, XMLStreamWriter writer) throw
         writer.writeEndElement();
     }
 
-    private void drawEdgeLabel(XMLStreamWriter writer, BranchEdge edge) throws XMLStreamException {
-
-        String edgeLabel = labelProvider.getLabel(edge);
+    private void drawEdgeLabel(XMLStreamWriter writer, BranchEdge edge, String edgeLabel) throws XMLStreamException {
 
         if (edgeLabel == null || edgeLabel.isEmpty()) {
             return;
@@ -204,11 +200,11 @@ private void drawEdgeCenter(XMLStreamWriter writer, BranchEdge edge) throws XMLS
         if (BranchEdge.DANGLING_LINE_EDGE.equals(edge.getType())) {
             return;
         }
-        if (!BranchEdge.LINE_EDGE.equals(edge.getType()) || svgParameters.isEdgeNameDisplayed()) {
+        String edgeLabel = labelProvider.getLabel(edge);
+        if (!BranchEdge.LINE_EDGE.equals(edge.getType()) || !StringUtils.isEmpty(edgeLabel)) {
             writer.writeStartElement(GROUP_ELEMENT_NAME);
             switch (edge.getType()) {
-                case BranchEdge.PST_EDGE:
-                case BranchEdge.TWO_WT_EDGE:
+                case BranchEdge.PST_EDGE, BranchEdge.TWO_WT_EDGE:
                     draw2Wt(writer, edge);
                     break;
                 case BranchEdge.HVDC_LINE_EDGE:
@@ -217,9 +213,7 @@ private void drawEdgeCenter(XMLStreamWriter writer, BranchEdge edge) throws XMLS
                 default:
                     break;
             }
-            if (svgParameters.isEdgeNameDisplayed()) {
-                drawEdgeLabel(writer, edge);
-            }
+            drawEdgeLabel(writer, edge, edgeLabel);
             writer.writeEndElement();
         }
     }
@@ -661,15 +655,6 @@ private void writeTextNode(XMLStreamWriter writer, TextNode textNode, VoltageLev
             return;
         }
 
-        List<String> content = labelProvider.getVoltageLevelDescription(vlNode);
-        if (content.size() > 1 || svgParameters.isBusLegend() || svgParameters.isVoltageLevelDetails()) {
-            writeDetailedTextNode(writer, textNode, vlNode, content);
-        } else {
-            writeSimpleTextNode(writer, textNode, content);
-        }
-    }
-
-    private void writeDetailedTextNode(XMLStreamWriter writer, TextNode textNode, VoltageLevelNode vlNode, List<String> content) throws XMLStreamException {
         writer.writeStartElement(FOREIGN_OBJECT_ELEMENT_NAME);
         writeId(writer, textNode);
         writer.writeAttribute(Y_ATTRIBUTE, getFormattedValue(textNode.getY()));
@@ -684,15 +669,13 @@ private void writeDetailedTextNode(XMLStreamWriter writer, TextNode textNode, Vo
         writer.writeDefaultNamespace(XHTML_NAMESPACE_URI);
         writer.writeAttribute(CLASS_ATTRIBUTE, StyleProvider.LABEL_BOX_CLASS);
 
-        writeLines(content, writer);
+        List<String> vlDescription = labelProvider.getVoltageLevelDescription(vlNode);
+        writeLines(vlDescription, writer);
 
-        if (svgParameters.isBusLegend()) {
-            writeBusNodeLegend(writer, vlNode);
-        }
+        writeBusNodeLegend(writer, vlNode);
 
-        if (svgParameters.isVoltageLevelDetails()) {
-            writeLines(labelProvider.getVoltageLevelDetails(vlNode), writer);
-        }
+        List<String> vlDetails = labelProvider.getVoltageLevelDetails(vlNode);
+        writeLines(vlDetails, writer);
 
         writer.writeEndElement();
         writer.writeEndElement();
@@ -707,43 +690,26 @@ private void writeLines(List<String> lines, XMLStreamWriter writer) throws XMLSt
     }
 
     private void writeBusNodeLegend(XMLStreamWriter writer, VoltageLevelNode vlNode) throws XMLStreamException {
-        writer.writeStartElement(TABLE_ELEMENT_NAME);
-
-        for (BusNode busNode : vlNode.getBusNodes()) {
-            writer.writeStartElement(TABLE_ROW_ELEMENT_NAME);
-            writer.writeStartElement(TABLE_DATA_ELEMENT_NAME);
-            writer.writeEmptyElement(DIV_ELEMENT_NAME);
-            writeStyleClasses(writer, styleProvider.getBusNodeStyleClasses(busNode), StyleProvider.LEGEND_SQUARE_CLASS);
-            writeStyleAttribute(writer, styleProvider.getBusNodeStyle(busNode));
-            writer.writeEndElement();
-            writer.writeStartElement(TABLE_DATA_ELEMENT_NAME);
-            writer.writeCharacters(labelProvider.getBusDescription(busNode));
-            writer.writeEndElement();
-            writer.writeEndElement();
-        }
-        writer.writeEndElement();
-    }
-
-    private void writeSimpleTextNode(XMLStreamWriter writer, TextNode textNode, List<String> content) throws XMLStreamException {
-        writer.writeStartElement(TEXT_ELEMENT_NAME);
-        writeId(writer, textNode);
-        writer.writeAttribute(Y_ATTRIBUTE, getFormattedValue(textNode.getEdgeConnection().getY()));
-        if (content.size() == 1) {
-            writer.writeAttribute(X_ATTRIBUTE, getFormattedValue(textNode.getEdgeConnection().getX()));
-            writer.writeCharacters(content.get(0));
-        } else {
-            for (int i = 0; i < content.size(); i++) {
-                String line = content.get(i);
-                writer.writeStartElement(TSPAN_ELEMENT_NAME);
-                writer.writeAttribute(X_ATTRIBUTE, getFormattedValue(textNode.getEdgeConnection().getX()));
-                if (i > 0) {
-                    writer.writeAttribute(DY_ATTRIBUTE, "1.1em");
-                }
-                writer.writeCharacters(line);
+        List<BusNode> notEmptyDescrBusNodes = vlNode.getBusNodeStream()
+                .filter(busNode -> StringUtils.isNotEmpty(labelProvider.getBusDescription(busNode)))
+                .toList();
+
+        if (!notEmptyDescrBusNodes.isEmpty()) {
+            writer.writeStartElement(TABLE_ELEMENT_NAME);
+            for (BusNode busNode : notEmptyDescrBusNodes) {
+                writer.writeStartElement(TABLE_ROW_ELEMENT_NAME);
+                writer.writeStartElement(TABLE_DATA_ELEMENT_NAME);
+                writer.writeEmptyElement(DIV_ELEMENT_NAME);
+                writeStyleClasses(writer, styleProvider.getBusNodeStyleClasses(busNode), StyleProvider.LEGEND_SQUARE_CLASS);
+                writeStyleAttribute(writer, styleProvider.getBusNodeStyle(busNode));
+                writer.writeEndElement();
+                writer.writeStartElement(TABLE_DATA_ELEMENT_NAME);
+                writer.writeCharacters(labelProvider.getBusDescription(busNode));
+                writer.writeEndElement();
                 writer.writeEndElement();
             }
+            writer.writeEndElement();
         }
-        writer.writeEndElement();
     }
 
     private void drawNode(Graph graph, XMLStreamWriter writer, VoltageLevelNode vlNode) throws XMLStreamException {
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/DefaultLabelProvider.java b/network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/DefaultLabelProvider.java
@@ -52,7 +52,7 @@ public Optional<EdgeInfo> getEdgeInfo(Graph graph, ThreeWtEdge edge) {
 
     @Override
     public String getLabel(Edge edge) {
-        return edge.getEquipmentId();
+        return svgParameters.isEdgeNameDisplayed() ? edge.getEquipmentId() : null;
     }
 
     private Optional<EdgeInfo> getEdgeInfo(Terminal terminal) {
@@ -86,35 +86,41 @@ public List<String> getVoltageLevelDescription(VoltageLevelNode voltageLevelNode
 
     @Override
     public String getBusDescription(BusNode busNode) {
-        Bus b = network.getBusView().getBus(busNode.getEquipmentId());
-        String voltage = valueFormatter.formatVoltage(b.getV(), "kV");
-        String angle = valueFormatter.formatAngleInDegrees(b.getAngle());
-        return voltage + " / " + angle;
+        if (svgParameters.isBusLegend()) {
+            Bus b = network.getBusView().getBus(busNode.getEquipmentId());
+            String voltage = valueFormatter.formatVoltage(b.getV(), "kV");
+            String angle = valueFormatter.formatAngleInDegrees(b.getAngle());
+            return voltage + " / " + angle;
+        }
+        return null;
     }
 
     @Override
     public List<String> getVoltageLevelDetails(VoltageLevelNode vlNode) {
         List<String> voltageLevelDetails = new ArrayList<>();
-        VoltageLevel voltageLevel = network.getVoltageLevel(vlNode.getEquipmentId());
 
-        double activeProductionValue = voltageLevel.getGeneratorStream().mapToDouble(generator -> -generator.getTerminal().getP()).filter(p -> !Double.isNaN(p)).sum();
-        String activeProduction = activeProductionValue == 0 ? "" : valueFormatter.formatPower(activeProductionValue, "MW");
+        if (svgParameters.isVoltageLevelDetails()) {
+            VoltageLevel voltageLevel = network.getVoltageLevel(vlNode.getEquipmentId());
 
-        double reactiveProductionValue = voltageLevel.getGeneratorStream().mapToDouble(generator -> -generator.getTerminal().getQ()).filter(q -> !Double.isNaN(q)).sum();
-        String reactiveProduction = reactiveProductionValue == 0 ? "" : valueFormatter.formatPower(reactiveProductionValue, "MVAR");
+            double activeProductionValue = voltageLevel.getGeneratorStream().mapToDouble(generator -> -generator.getTerminal().getP()).filter(p -> !Double.isNaN(p)).sum();
+            String activeProduction = activeProductionValue == 0 ? "" : valueFormatter.formatPower(activeProductionValue, "MW");
 
-        double activeConsumptionValue = voltageLevel.getLoadStream().mapToDouble(load -> load.getTerminal().getP()).filter(p -> !Double.isNaN(p)).sum();
-        String activeConsumption = activeConsumptionValue == 0 ? "" : valueFormatter.formatPower(activeConsumptionValue, "MW");
+            double reactiveProductionValue = voltageLevel.getGeneratorStream().mapToDouble(generator -> -generator.getTerminal().getQ()).filter(q -> !Double.isNaN(q)).sum();
+            String reactiveProduction = reactiveProductionValue == 0 ? "" : valueFormatter.formatPower(reactiveProductionValue, "MVAR");
 
-        double reactiveConsumptionValue = voltageLevel.getLoadStream().mapToDouble(load -> load.getTerminal().getQ()).filter(q -> !Double.isNaN(q)).sum();
-        String reactiveConsumption = reactiveConsumptionValue == 0 ? "" : valueFormatter.formatPower(reactiveConsumptionValue, "MVAR");
+            double activeConsumptionValue = voltageLevel.getLoadStream().mapToDouble(load -> load.getTerminal().getP()).filter(p -> !Double.isNaN(p)).sum();
+            String activeConsumption = activeConsumptionValue == 0 ? "" : valueFormatter.formatPower(activeConsumptionValue, "MW");
 
-        if (!activeProduction.isEmpty() || !reactiveProduction.isEmpty()) {
-            voltageLevelDetails.add(String.format("~ %s / %s", activeProduction, reactiveProduction));
-        }
+            double reactiveConsumptionValue = voltageLevel.getLoadStream().mapToDouble(load -> load.getTerminal().getQ()).filter(q -> !Double.isNaN(q)).sum();
+            String reactiveConsumption = reactiveConsumptionValue == 0 ? "" : valueFormatter.formatPower(reactiveConsumptionValue, "MVAR");
+
+            if (!activeProduction.isEmpty() || !reactiveProduction.isEmpty()) {
+                voltageLevelDetails.add(String.format("~ %s / %s", activeProduction, reactiveProduction));
+            }
 
-        if (!activeConsumption.isEmpty() || !reactiveConsumption.isEmpty()) {
-            voltageLevelDetails.add(String.format("⌂ %s / %s", activeConsumption, reactiveConsumption));
+            if (!activeConsumption.isEmpty() || !reactiveConsumption.isEmpty()) {
+                voltageLevelDetails.add(String.format("⌂ %s / %s", activeConsumption, reactiveConsumption));
+            }
         }
 
         return voltageLevelDetails;
diff --git a/network-area-diagram/src/test/java/com/powsybl/nad/svg/CustomLabelProviderTest.java b/network-area-diagram/src/test/java/com/powsybl/nad/svg/CustomLabelProviderTest.java
@@ -31,14 +31,14 @@ class CustomLabelProviderTest extends AbstractTest {
     void setup() {
         setLayoutParameters(new LayoutParameters());
 
-        //Note: SvgParameters EdgeNameDisplayed, VoltageLevelDetails, and BusLegend must be true,
-        // for the edge names, the VL descriptions plus VL details, and bus descriptions to be rendered
+        //Note: sets SvgParameters EdgeNameDisplayed, VoltageLevelDetails, and BusLegend explicitly to false, to demonstrate that
+        // the custom label provider ignores them when rendering edge names, the VL descriptions, and VL details.
         setSvgParameters(new SvgParameters()
                 .setSvgWidthAndHeightAdded(true)
                 .setFixedWidth(800)
-                .setEdgeNameDisplayed(true)
-                .setVoltageLevelDetails(true)
-                .setBusLegend(true));
+                .setEdgeNameDisplayed(false)
+                .setVoltageLevelDetails(false)
+                .setBusLegend(false));
     }
 
     @Override
diff --git a/network-area-diagram/src/test/java/com/powsybl/nad/svg/TextNodeTest.java b/network-area-diagram/src/test/java/com/powsybl/nad/svg/TextNodeTest.java
@@ -17,6 +17,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.util.Collections;
 import java.util.List;
 
 /**
@@ -47,12 +48,16 @@ protected LabelProvider getLabelProvider(Network network) {
         return new DefaultLabelProvider(network, getSvgParameters()) {
             @Override
             public List<String> getVoltageLevelDetails(VoltageLevelNode vlNode) {
-                VoltageLevel vl = network.getVoltageLevel(vlNode.getEquipmentId());
-                return List.of(
-                        vl.getLoadCount() + " loads",
-                        vl.getGeneratorCount() + " generators",
-                        vl.getBatteryCount() + " batteries",
-                        vl.getDanglingLineCount() + " dangling lines");
+                if (getSvgParameters().isVoltageLevelDetails()) {
+                    VoltageLevel vl = network.getVoltageLevel(vlNode.getEquipmentId());
+                    return List.of(
+                            vl.getLoadCount() + " loads",
+                            vl.getGeneratorCount() + " generators",
+                            vl.getBatteryCount() + " batteries",
+                            vl.getDanglingLineCount() + " dangling lines");
+                } else {
+                    return Collections.emptyList();
+                }
             }
         };
     }
diff --git a/network-area-diagram/src/test/resources/3wt_disconnected.svg b/network-area-diagram/src/test/resources/3wt_disconnected.svg
@@ -147,7 +147,6 @@ path.nad-arrow-in:not(.nad-state-in .nad-arrow-in) {visibility: hidden}
         <foreignObject id="4-textnode" y="164.68" x="280.23" height="1" width="1">
             <div xmlns="http://www.w3.org/1999/xhtml" class="nad-label-box">
                 <div>VL_33</div>
-                <table></table>
             </div>
         </foreignObject>
     </g>
diff --git a/network-area-diagram/src/test/resources/3wt_disconnected_topological.svg b/network-area-diagram/src/test/resources/3wt_disconnected_topological.svg
@@ -212,7 +212,6 @@ path.nad-arrow-in:not(.nad-state-in .nad-arrow-in) {visibility: hidden}
         <foreignObject id="4-textnode" y="164.68" x="280.23" height="1" width="1">
             <div xmlns="http://www.w3.org/1999/xhtml" class="nad-label-box">
                 <div>VL_33</div>
-                <table></table>
             </div>
         </foreignObject>
     </g>
diff --git a/network-area-diagram/src/test/resources/IEEE_14_bus_disconnection.svg b/network-area-diagram/src/test/resources/IEEE_14_bus_disconnection.svg
@@ -734,7 +734,6 @@ path.nad-arrow-in:not(.nad-state-in .nad-arrow-in) {visibility: hidden}
         <foreignObject id="10-textnode" y="379.24" x="212.11" height="1" width="1">
             <div xmlns="http://www.w3.org/1999/xhtml" class="nad-label-box">
                 <div>VL14</div>
-                <table></table>
             </div>
         </foreignObject>
         <foreignObject id="11-textnode" y="-424.58" x="162.40" height="1" width="1">
diff --git a/network-area-diagram/src/test/resources/vl_description_id.svg b/network-area-diagram/src/test/resources/vl_description_id.svg
@@ -175,7 +175,15 @@ path.nad-arrow-in:not(.nad-state-in .nad-arrow-in) {visibility: hidden}
         <polyline id="2-textedge" points="-200.75,-3.27 -130.42,-13.82"/>
     </g>
     <g class="nad-text-nodes">
-        <text id="0-textnode" y="-333.70" x="43.94">vl1</text>
-        <text id="2-textnode" y="-13.82" x="-130.42">vl2</text>
+        <foreignObject id="0-textnode" y="-358.70" x="43.94" height="1" width="1">
+            <div xmlns="http://www.w3.org/1999/xhtml" class="nad-label-box">
+                <div>vl1</div>
+            </div>
+        </foreignObject>
+        <foreignObject id="2-textnode" y="-38.82" x="-130.42" height="1" width="1">
+            <div xmlns="http://www.w3.org/1999/xhtml" class="nad-label-box">
+                <div>vl2</div>
+            </div>
+        </foreignObject>
     </g>
 </svg>
