Package com.powsybl.sld.library

Class ResourcesComponentLibrary

java.lang.Object

com.powsybl.sld.library.ResourcesComponentLibrary

All Implemented Interfaces:

ComponentLibrary

Direct Known Subclasses:

ConvergenceComponentLibrary

public class ResourcesComponentLibrary
extends Object
implements ComponentLibrary

Library of resources components, that is, the SVG image files representing the components, together with the styles associated to each component

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer

Constructor Summary

Constructors

Constructor	Description
ResourcesComponentLibrary(String name, String directory, String... additionalDirectories)	Constructs a new library containing the components in the given directories

Method Summary

Modifier and Type	Method	Description
List<AnchorPoint>	getAnchorPoints(String type)
Map<String,ComponentSize>	getComponentsSize()
Optional<String>	getComponentStyleClass(String type)
List<String>	getCssFilenames()
List<URL>	getCssUrls()
protected List<Element>	getElements(Document doc)
String	getName()
ComponentSize	getSize(String type)
Optional<String>	getSubComponentStyleClass(String type, String subComponent)
Map<String,List<Element>>	getSvgElements(String type)
Map<Orientation,Component.Transformation>	getTransformations(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcesComponentLibrary

public ResourcesComponentLibrary(String name,
                                 String directory,
                                 String... additionalDirectories)

Constructs a new library containing the components in the given directories

Parameters:

name - name of the library

directory - main directory containing the resources components: SVG files, with associated components.json (containing the list of SVG files) and components.css (containing the style applied to each component)

additionalDirectories - directories for additional components (each directory containing SVG files, associated components.json and components.css).

Method Detail

getName

public String getName()

Specified by:

getName in interface ComponentLibrary

getElements

protected List<Element> getElements(Document doc)

getSvgElements

public Map<String,List<Element>> getSvgElements(String type)

Specified by:

getSvgElements in interface ComponentLibrary

getAnchorPoints

public List<AnchorPoint> getAnchorPoints(String type)

Specified by:

getAnchorPoints in interface ComponentLibrary

getSize

public ComponentSize getSize(String type)

Specified by:

getSize in interface ComponentLibrary

getComponentsSize

public Map<String,ComponentSize> getComponentsSize()

Specified by:

getComponentsSize in interface ComponentLibrary

getCssFilenames

public List<String> getCssFilenames()

Specified by:

getCssFilenames in interface ComponentLibrary

getCssUrls

public List<URL> getCssUrls()

Specified by:

getCssUrls in interface ComponentLibrary

getComponentStyleClass

public Optional<String> getComponentStyleClass(String type)

Specified by:

getComponentStyleClass in interface ComponentLibrary

getSubComponentStyleClass

public Optional<String> getSubComponentStyleClass(String type,
                                                  String subComponent)

Specified by:

getSubComponentStyleClass in interface ComponentLibrary

getTransformations

public Map<Orientation,Component.Transformation> getTransformations(String type)

Specified by:

getTransformations in interface ComponentLibrary