Package com.powsybl.iidm.import_

Interface Importer

All Known Implementing Classes:

CgmesImport, IeeeCdfImporter, MatpowerImporter, PsseImporter, UcteImporter, XMLImporter

public interface Importer

This is the base class for all IIDM importers.

Importer lookup is based on the ServiceLoader architecture so do not forget to create a META-INF/services/com.powsybl.iidm.importData.Importer file with the fully qualified name of your Importer implementation.

Author:

Geoffroy Jamgotchian

See Also:

ServiceLoader, Importers

Method Summary

Modifier and Type	Method	Description
default void	copy(ReadOnlyDataSource fromDataSource, DataSource toDataSource)	Copy data from one data source to another.
boolean	exists(ReadOnlyDataSource dataSource)	Check if the data source is importable
String	getComment()	Get some information about this importer.
String	getFormat()	Get a unique identifier of the format.
default List<Parameter>	getParameters()	Get a description of import parameters
default Network	importData(ReadOnlyDataSource dataSource, NetworkFactory networkFactory, Properties parameters)	Create a model.
default Network	importData(ReadOnlyDataSource dataSource, NetworkFactory networkFactory, Properties parameters, Reporter reporter)	Create a model.
default Network	importData(ReadOnlyDataSource dataSource, Properties parameters)	Deprecated. Use importData(ReadOnlyDataSource, NetworkFactory, Properties) instead.

Method Detail

getFormat

String getFormat()

Get a unique identifier of the format.

getParameters

default List<Parameter> getParameters()

Get a description of import parameters

Returns:

getComment

String getComment()

Get some information about this importer.

exists

boolean exists(ReadOnlyDataSource dataSource)

Check if the data source is importable

Parameters:

dataSource - the data source

Returns:

true if the data source is importable, false otherwise

importData

@Deprecated
default Network importData(ReadOnlyDataSource dataSource,
                           Properties parameters)

Deprecated.

Use importData(ReadOnlyDataSource, NetworkFactory, Properties) instead.

importData

default Network importData(ReadOnlyDataSource dataSource,
                           NetworkFactory networkFactory,
                           Properties parameters)

Create a model.

Parameters:

dataSource - data source

networkFactory - network factory

parameters - some properties to configure the import

Returns:

the model

importData

default Network importData(ReadOnlyDataSource dataSource,
                           NetworkFactory networkFactory,
                           Properties parameters,
                           Reporter reporter)

Create a model.

Parameters:

dataSource - data source

networkFactory - network factory

parameters - some properties to configure the import

reporter - the reporter used for functional logs

Returns:

the model

copy

default void copy(ReadOnlyDataSource fromDataSource,
                  DataSource toDataSource)

Copy data from one data source to another.

Parameters:

fromDataSource - from data source

toDataSource - destination data source