Package com.powsybl.iidm.export

Interface Exporter

All Known Implementing Classes:

AmplExporter, CgmesExport, 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.export.Exporter file with the fully qualified name of your Exporter implementation.

Author:

Geoffroy Jamgotchian

See Also:

ServiceLoader, Exporters

Method Summary

Modifier and Type	Method	Description
default void	export(Network network, Properties parameters, DataSource dataSource)	Export a model.
default void	export(Network network, Properties parameters, DataSource dataSource, Reporter reporter)	Export a model.
static Exporter	find(ExportersLoader loader, String format)	Find an exporter.
static Exporter	find(String format)
String	getComment()	Get some information about this exporter.
String	getFormat()	Get a unique identifier of the format.
static Collection<String>	getFormats()
static Collection<String>	getFormats(ExportersLoader loader)	Get all supported export formats.
default List<Parameter>	getParameters()	Get a description of export parameters

Method Detail

getFormats

static Collection<String> getFormats(ExportersLoader loader)

Get all supported export formats.

getFormats

static Collection<String> getFormats()

find

static Exporter find(ExportersLoader loader,
                     String format)

Find an exporter.

Parameters:

format - the export format

Returns:

the exporter if one exists for the given format or null otherwise

find

static Exporter find(String format)

getFormat

String getFormat()

Get a unique identifier of the format.

getComment

String getComment()

Get some information about this exporter.

getParameters

default List<Parameter> getParameters()

Get a description of export parameters

Returns:

export

default void export(Network network,
                    Properties parameters,
                    DataSource dataSource)

Export a model.

Parameters:

network - the model

parameters - some properties to configure the export

dataSource - data source

export

default void export(Network network,
                    Properties parameters,
                    DataSource dataSource,
                    Reporter reporter)

Export a model.

Parameters:

network - the model

parameters - some properties to configure the export

dataSource - data source

reporter - the reporter used for functional logs