Package com.powsybl.sld.svg

Class DefaultSVGWriter

java.lang.Object

com.powsybl.sld.svg.DefaultSVGWriter

All Implemented Interfaces:

SVGWriter

public class DefaultSVGWriter
extends Object
implements SVGWriter

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer , Florian Dupuy

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	CIRCLE_RADIUS_NODE_INFOS_SIZE
protected static String	CLASS
protected ComponentLibrary	componentLibrary
protected static String	GROUP
protected static String	HEIGHT
protected static double	LABEL_OFFSET
protected LayoutParameters	layoutParameters
protected static org.slf4j.Logger	LOGGER
protected static String	MIDDLE
protected static String	POINTS
protected static String	POLYLINE
protected static String	ROTATE
protected static String	SCALE
protected static String	STYLE
protected static String	TEXT_ANCHOR
protected static String	TRANSFORM
protected static String	TRANSLATE
protected static String	WIDTH

Constructor Summary

Constructors

Constructor	Description
DefaultSVGWriter(ComponentLibrary componentLibrary, LayoutParameters layoutParameters)

Method Summary

Modifier and Type	Method	Description
protected void	addStyle(Document document, DiagramStyleProvider styleProvider, DiagramLabelProvider labelProvider, Graph graph, Set<String> listUsedComponentSVG)
protected boolean	canInsertComponentSVG(Node node)
protected void	createDefsSVGComponents(Document document, Set<String> listUsedComponentSVG)	Creation of the defs area for the SVG components
protected Element	createLabelElement(String str, double xShift, double yShift, int shiftAngle, Element g)
protected List<GraphMetadata.NodeLabelMetadata>	createNodeLabelMetadata(String prefixId, Node node, List<DiagramLabelProvider.NodeLabel> nodeLabels)
protected void	drawBus(VoltageLevelGraph graph, BusNode node, Element g)
protected void	drawBuses(String prefixId, Element root, VoltageLevelGraph graph, GraphMetadata metadata, DiagramLabelProvider initProvider, DiagramStyleProvider styleProvider, Set<Node> remainingNodesToDraw)
protected void	drawEdges(String prefixId, Element root, VoltageLevelGraph graph, GraphMetadata metadata, DiagramLabelProvider initProvider, DiagramStyleProvider styleProvider, Collection<Edge> edges)
protected void	drawGraphLabel(String prefixId, Element root, VoltageLevelGraph graph, GraphMetadata metadata)
protected void	drawGrid(String prefixId, VoltageLevelGraph graph, Document document, GraphMetadata metadata, Element root)
protected void	drawGridHorizontalLine(Document document, VoltageLevelGraph graph, int maxH, double y, Element root)
protected void	drawGridLine(Document document, double x1, double y1, double x2, double y2, Element root)
protected void	drawGridVerticalLine(Document document, VoltageLevelGraph graph, int maxV, double x, Element root)
protected void	drawNodeDecorators(String prefixId, Element root, Graph graph, Node node, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider)
protected void	drawNodeLabel(String prefixId, Element g, Node node, List<DiagramLabelProvider.NodeLabel> nodeLabels)
protected void	drawNodes(String prefixId, Element root, BaseGraph graph, Point shift, GraphMetadata metadata, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider, Collection<? extends Node> nodes)
protected void	drawSnakeLines(String prefixId, Element root, BaseGraph graph, GraphMetadata metadata, DiagramStyleProvider styleProvider)
protected void	drawSnakeLines(String prefixId, Element root, ZoneGraph graph, GraphMetadata metadata, DiagramStyleProvider styleProvider)
protected void	drawSubstation(String prefixId, SubstationGraph graph, Element root, GraphMetadata metadata, DiagramLabelProvider initProvider, DiagramStyleProvider styleProvider)
protected void	drawVoltageLevel(String prefixId, VoltageLevelGraph graph, Element root, GraphMetadata metadata, DiagramLabelProvider initProvider, DiagramStyleProvider styleProvider)
protected void	incorporateComponents(String prefixId, Graph graph, Node node, Point shift, Element g, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider)
protected void	insertBusInfo(String prefixId, Element root, BusNode busNode, GraphMetadata metadata, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider)
protected void	insertBusInfoSVGIntoDocumentSVG(BusInfo busInfo, String prefixId, Element g)
protected void	insertComponentSVGIntoDocumentSVG(String prefixId, String componentType, Element g, Graph graph, Node node, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider)
protected void	insertDecoratorSVGIntoDocumentSVG(String prefixId, DiagramLabelProvider.NodeDecorator nodeDecorator, Element g, Graph graph, Node node, DiagramStyleProvider styleProvider)
protected void	insertFeederInfos(String prefixId, List<Point> points, Element root, VoltageLevelGraph graph, FeederNode feederNode, GraphMetadata metadata, DiagramLabelProvider labelProvider)
protected void	insertFeederInfoSVGIntoDocumentSVG(FeederInfo feederInfo, String prefixId, Element g, double angle)
protected void	insertSVGComponentIntoDefsArea(String componentType, Element group, Map<String,List<Element>> subComponents)
protected void	insertSVGIntoDocumentSVG(String componentType, Element g, String tooltip, BiConsumer<Element,String> elementAttributesSetter)
protected String	pointsListToString(List<Point> polyline)
protected void	setMetadata(String prefixId, GraphMetadata metadata, Node node, String nodeId, BaseGraph graph, Direction direction, List<DiagramLabelProvider.NodeLabel> nodeLabels)
protected void	transformComponent(Node node, Point shift, Element g)
protected void	transformFeederInfo(List<Point> points, ComponentSize componentSize, double shift, Element g)
GraphMetadata	write(String prefixId, Graph graph, DiagramLabelProvider labelProvider, DiagramStyleProvider styleProvider, Writer writer)	Create the SVGDocument corresponding to the graph
protected GraphMetadata	writeGraph(String prefixId, Graph graph, Document document, DiagramLabelProvider initProvider, DiagramStyleProvider styleProvider)	Create the SVGDocument corresponding to the graph

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

GROUP

protected static final String GROUP

See Also:

Constant Field Values

CLASS

protected static final String CLASS

See Also:

Constant Field Values

STYLE

protected static final String STYLE

See Also:

Constant Field Values

TRANSFORM

protected static final String TRANSFORM

See Also:

Constant Field Values

TRANSLATE

protected static final String TRANSLATE

See Also:

Constant Field Values

ROTATE

protected static final String ROTATE

See Also:

Constant Field Values

SCALE

protected static final String SCALE

See Also:

Constant Field Values

LABEL_OFFSET

protected static final double LABEL_OFFSET

See Also:

Constant Field Values

POLYLINE

protected static final String POLYLINE

See Also:

Constant Field Values

POINTS

protected static final String POINTS

See Also:

Constant Field Values

TEXT_ANCHOR

protected static final String TEXT_ANCHOR

See Also:

Constant Field Values

MIDDLE

protected static final String MIDDLE

See Also:

Constant Field Values

CIRCLE_RADIUS_NODE_INFOS_SIZE

protected static final int CIRCLE_RADIUS_NODE_INFOS_SIZE

See Also:

Constant Field Values

WIDTH

protected static final String WIDTH

See Also:

Constant Field Values

HEIGHT

protected static final String HEIGHT

See Also:

Constant Field Values

componentLibrary

protected final ComponentLibrary componentLibrary

layoutParameters

protected final LayoutParameters layoutParameters

Constructor Detail

DefaultSVGWriter

public DefaultSVGWriter(ComponentLibrary componentLibrary,
                        LayoutParameters layoutParameters)

Method Detail

write

public GraphMetadata write(String prefixId,
                           Graph graph,
                           DiagramLabelProvider labelProvider,
                           DiagramStyleProvider styleProvider,
                           Writer writer)

Create the SVGDocument corresponding to the graph

Specified by:

write in interface SVGWriter

Parameters:

graph - zone, voltage level or substation graph

writer - writer for the SVG content

addStyle

protected void addStyle(Document document,
                        DiagramStyleProvider styleProvider,
                        DiagramLabelProvider labelProvider,
                        Graph graph,
                        Set<String> listUsedComponentSVG)

writeGraph

protected GraphMetadata writeGraph(String prefixId,
                                   Graph graph,
                                   Document document,
                                   DiagramLabelProvider initProvider,
                                   DiagramStyleProvider styleProvider)

Create the SVGDocument corresponding to the graph

drawVoltageLevel

protected void drawVoltageLevel(String prefixId,
                                VoltageLevelGraph graph,
                                Element root,
                                GraphMetadata metadata,
                                DiagramLabelProvider initProvider,
                                DiagramStyleProvider styleProvider)

drawSubstation

protected void drawSubstation(String prefixId,
                              SubstationGraph graph,
                              Element root,
                              GraphMetadata metadata,
                              DiagramLabelProvider initProvider,
                              DiagramStyleProvider styleProvider)

drawGrid

protected void drawGrid(String prefixId,
                        VoltageLevelGraph graph,
                        Document document,
                        GraphMetadata metadata,
                        Element root)

drawGridHorizontalLine

protected void drawGridHorizontalLine(Document document,
                                      VoltageLevelGraph graph,
                                      int maxH,
                                      double y,
                                      Element root)

drawGridVerticalLine

protected void drawGridVerticalLine(Document document,
                                    VoltageLevelGraph graph,
                                    int maxV,
                                    double x,
                                    Element root)

drawGridLine

protected void drawGridLine(Document document,
                            double x1,
                            double y1,
                            double x2,
                            double y2,
                            Element root)

drawBuses

protected void drawBuses(String prefixId,
                         Element root,
                         VoltageLevelGraph graph,
                         GraphMetadata metadata,
                         DiagramLabelProvider initProvider,
                         DiagramStyleProvider styleProvider,
                         Set<Node> remainingNodesToDraw)

createNodeLabelMetadata

protected List<GraphMetadata.NodeLabelMetadata> createNodeLabelMetadata(String prefixId,
                                                                        Node node,
                                                                        List<DiagramLabelProvider.NodeLabel> nodeLabels)

drawNodes

protected void drawNodes(String prefixId,
                         Element root,
                         BaseGraph graph,
                         Point shift,
                         GraphMetadata metadata,
                         DiagramLabelProvider labelProvider,
                         DiagramStyleProvider styleProvider,
                         Collection<? extends Node> nodes)

setMetadata

protected void setMetadata(String prefixId,
                           GraphMetadata metadata,
                           Node node,
                           String nodeId,
                           BaseGraph graph,
                           Direction direction,
                           List<DiagramLabelProvider.NodeLabel> nodeLabels)

drawNodeLabel

protected void drawNodeLabel(String prefixId,
                             Element g,
                             Node node,
                             List<DiagramLabelProvider.NodeLabel> nodeLabels)

drawNodeDecorators

protected void drawNodeDecorators(String prefixId,
                                  Element root,
                                  Graph graph,
                                  Node node,
                                  DiagramLabelProvider labelProvider,
                                  DiagramStyleProvider styleProvider)

drawGraphLabel

protected void drawGraphLabel(String prefixId,
                              Element root,
                              VoltageLevelGraph graph,
                              GraphMetadata metadata)

drawBus

protected void drawBus(VoltageLevelGraph graph,
                       BusNode node,
                       Element g)

createLabelElement

protected Element createLabelElement(String str,
                                     double xShift,
                                     double yShift,
                                     int shiftAngle,
                                     Element g)

canInsertComponentSVG

protected boolean canInsertComponentSVG(Node node)

incorporateComponents

protected void incorporateComponents(String prefixId,
                                     Graph graph,
                                     Node node,
                                     Point shift,
                                     Element g,
                                     DiagramLabelProvider labelProvider,
                                     DiagramStyleProvider styleProvider)

insertComponentSVGIntoDocumentSVG

protected void insertComponentSVGIntoDocumentSVG(String prefixId,
                                                 String componentType,
                                                 Element g,
                                                 Graph graph,
                                                 Node node,
                                                 DiagramLabelProvider labelProvider,
                                                 DiagramStyleProvider styleProvider)

insertFeederInfoSVGIntoDocumentSVG

protected void insertFeederInfoSVGIntoDocumentSVG(FeederInfo feederInfo,
                                                  String prefixId,
                                                  Element g,
                                                  double angle)

insertBusInfoSVGIntoDocumentSVG

protected void insertBusInfoSVGIntoDocumentSVG(BusInfo busInfo,
                                               String prefixId,
                                               Element g)

insertDecoratorSVGIntoDocumentSVG

protected void insertDecoratorSVGIntoDocumentSVG(String prefixId,
                                                 DiagramLabelProvider.NodeDecorator nodeDecorator,
                                                 Element g,
                                                 Graph graph,
                                                 Node node,
                                                 DiagramStyleProvider styleProvider)

insertSVGIntoDocumentSVG

protected void insertSVGIntoDocumentSVG(String componentType,
                                        Element g,
                                        String tooltip,
                                        BiConsumer<Element,String> elementAttributesSetter)

transformComponent

protected void transformComponent(Node node,
                                  Point shift,
                                  Element g)

transformFeederInfo

protected void transformFeederInfo(List<Point> points,
                                   ComponentSize componentSize,
                                   double shift,
                                   Element g)

insertFeederInfos

protected void insertFeederInfos(String prefixId,
                                 List<Point> points,
                                 Element root,
                                 VoltageLevelGraph graph,
                                 FeederNode feederNode,
                                 GraphMetadata metadata,
                                 DiagramLabelProvider labelProvider)

insertBusInfo

protected void insertBusInfo(String prefixId,
                             Element root,
                             BusNode busNode,
                             GraphMetadata metadata,
                             DiagramLabelProvider labelProvider,
                             DiagramStyleProvider styleProvider)

drawEdges

protected void drawEdges(String prefixId,
                         Element root,
                         VoltageLevelGraph graph,
                         GraphMetadata metadata,
                         DiagramLabelProvider initProvider,
                         DiagramStyleProvider styleProvider,
                         Collection<Edge> edges)

drawSnakeLines

protected void drawSnakeLines(String prefixId,
                              Element root,
                              ZoneGraph graph,
                              GraphMetadata metadata,
                              DiagramStyleProvider styleProvider)

drawSnakeLines

protected void drawSnakeLines(String prefixId,
                              Element root,
                              BaseGraph graph,
                              GraphMetadata metadata,
                              DiagramStyleProvider styleProvider)

pointsListToString

protected String pointsListToString(List<Point> polyline)

createDefsSVGComponents

protected void createDefsSVGComponents(Document document,
                                       Set<String> listUsedComponentSVG)

Creation of the defs area for the SVG components

insertSVGComponentIntoDefsArea

protected void insertSVGComponentIntoDefsArea(String componentType,
                                              Element group,
                                              Map<String,List<Element>> subComponents)