Package com.powsybl.iidm.import_
Interface Importer
-
- All Known Implementing Classes:
CgmesImport
,IeeeCdfImporter
,MatpowerImporter
,PowerFactoryImporter
,PsseImporter
,UcteImporter
,XMLImporter
public interface Importer
This is the base class for all IIDM importers.Importer
lookup is based on theServiceLoader
architecture so do not forget to create aMETA-INF/services/com.powsybl.iidm.importData.Importer
file with the fully qualified name of yourImporter
implementation.- Author:
- Geoffroy Jamgotchian
- See Also:
ServiceLoader
,Importers
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 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 importableString
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 parametersdefault 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.
-
-
-
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.
-
importData
default Network importData(ReadOnlyDataSource dataSource, NetworkFactory networkFactory, Properties parameters)
Create a model.- Parameters:
dataSource
- data sourcenetworkFactory
- network factoryparameters
- 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 sourcenetworkFactory
- network factoryparameters
- some properties to configure the importreporter
- 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 sourcetoDataSource
- destination data source
-
-