Package com.powsybl.iidm.network
Interface Exporter
- All Known Implementing Classes:
AbstractTreeDataExporter
,AmplExporter
,BinaryExporter
,CgmesExport
,JsonExporter
,MatpowerExporter
,PsseExporter
,UcteExporter
,XMLExporter
public interface Exporter
This is the base class for all IIDM exporters.
Exporter
lookup is based on the ServiceLoader
architecture so do not forget to create a
META-INF/services/com.powsybl.iidm.network.Exporter
file
with the fully qualified name of your Exporter
implementation.
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
export
(Network network, Properties parameters, DataSource dataSource) Export a model.default void
export
(Network network, Properties parameters, DataSource dataSource, ReportNode reportNode) Export a model.static Exporter
find
(ExportersLoader loader, String format) Find an exporter.static Exporter
Get some information about this exporter.Get a unique identifier of the format.static Collection<String>
static Collection<String>
getFormats
(ExportersLoader loader) Get all supported export formats.Get a description of export parameters
-
Method Details
-
getFormats
Get all supported export formats. -
getFormats
-
find
Find an exporter.- Parameters:
format
- the export format- Returns:
- the exporter if one exists for the given format or
null
otherwise
-
find
-
getFormat
String getFormat()Get a unique identifier of the format. -
getComment
String getComment()Get some information about this exporter. -
getParameters
Get a description of export parameters- Returns:
-
export
Export a model.- Parameters:
network
- the modelparameters
- some properties to configure the exportdataSource
- data source
-
export
default void export(Network network, Properties parameters, DataSource dataSource, ReportNode reportNode) Export a model.- Parameters:
network
- the modelparameters
- some properties to configure the exportdataSource
- data sourcereportNode
- the reportNode used for functional logs
-