com.powsybl.iidm.import_

Interface Importer

All Known Implementing Classes:

CgmesImport, 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.

See Also:

ServiceLoader, Importers

Method Summary

Modifier and Type	Method and 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
java.lang.String	getComment() Get some information about this importer.
java.lang.String	getFormat() Get a unique identifier of the format.
default java.util.List<Parameter>	getParameters() Get a description of import parameters
Network	importData(ReadOnlyDataSource dataSource, java.util.Properties parameters) Create a model.

Method Detail

getFormat

java.lang.String getFormat()

Get a unique identifier of the format.

getParameters

default java.util.List<Parameter> getParameters()

Get a description of import parameters

Returns:

getComment

java.lang.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

Network importData(ReadOnlyDataSource dataSource,
                   java.util.Properties parameters)

Create a model.

Parameters:

dataSource - data source

parameters - some properties to configure the import

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