Package com.powsybl.iidm.network
Interface Importer
-
- All Known Implementing Classes:
CgmesImport
,IeeeCdfImporter
,Importer.ImporterWrapper
,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
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Importer.ImporterWrapper
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static Importer
addPostProcessors(Importer importer, ComputationManager computationManager, String... names)
static Importer
addPostProcessors(Importer importer, String... names)
static Importer
addPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, String... names)
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 importablestatic Importer
find(ReadOnlyDataSource dataSource)
static Importer
find(ReadOnlyDataSource dataSource, ComputationManager computationManager)
static Importer
find(ReadOnlyDataSource dataSource, ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
static Importer
find(ImportersLoader loader, String format, ComputationManager computationManager, ImportConfig config)
Find an importer for the specified format name.static Importer
find(String format)
Find an importer for the specified format name.static Importer
find(String format, ComputationManager computationManager)
Find an importer for the specified format name.static Importer
find(String format, ComputationManager computationManager, ImportConfig config)
Find an importer for the specified format name.String
getComment()
Get some information about this importer.String
getFormat()
Get a unique identifier of the format.static Collection<String>
getFormats()
static Collection<String>
getFormats(ImportersLoader loader)
Get all supported import formats.default List<Parameter>
getParameters()
Get a description of import parametersstatic Collection<String>
getPostProcessorNames()
static Collection<String>
getPostProcessorNames(ImportersLoader loader)
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.static Collection<Importer>
list()
static Collection<Importer>
list(ComputationManager computationManager, ImportConfig config)
static Collection<Importer>
list(ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
static Importer
removePostProcessors(Importer importer)
static Importer
setPostProcessors(Importer importer, ComputationManager computationManager, String... names)
static Importer
setPostProcessors(Importer importer, String... names)
static Importer
setPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, String... names)
-
-
-
Method Detail
-
getFormats
static Collection<String> getFormats(ImportersLoader loader)
Get all supported import formats.
-
getFormats
static Collection<String> getFormats()
-
list
static Collection<Importer> list(ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
-
list
static Collection<Importer> list(ComputationManager computationManager, ImportConfig config)
-
list
static Collection<Importer> list()
-
find
static Importer find(ImportersLoader loader, String format, @Nullable ComputationManager computationManager, ImportConfig config)
Find an importer for the specified format name. The returned importer will apply configuredImportPostProcessor
s on imported networks.- Parameters:
loader
- the loader responsible for providing the list of available importers and post processorsformat
- the import formatcomputationManager
- a computation manager which may be used by configuredImportPostProcessor
sconfig
- the import configuration- Returns:
- the importer if one exists for the given format or
null
otherwise.
-
find
static Importer find(String format, @Nullable ComputationManager computationManager, ImportConfig config)
Find an importer for the specified format name. The returned importer will apply configuredImportPostProcessor
s on imported networks.All declared services implementing the
Importer
interface are available.- Parameters:
format
- the import formatcomputationManager
- a computation manager which may be used by configuredImportPostProcessor
sconfig
- the import configuration- Returns:
- the importer if one exists for the given format or
null
otherwise.
-
find
static Importer find(String format, @Nullable ComputationManager computationManager)
Find an importer for the specified format name. The returned importer will apply configuredImportPostProcessor
s on imported networks.All declared services implementing the
Importer
interface are available. The import configuration is loaded from default platform config.- Parameters:
format
- the import formatcomputationManager
- a computation manager which may be used by configuredImportPostProcessor
s- Returns:
- the importer if one exists for the given format or
null
otherwise.
-
find
static Importer find(String format)
Find an importer for the specified format name. The returned importer will apply configuredImportPostProcessor
s on imported networks.All declared services implementing the
Importer
interface are available. The import configuration is loaded from default platform config. Import post processors will use the default instance ofLocalComputationManager
, as configured in default platform config.- Parameters:
format
- the import format- Returns:
- the importer if one exists for the given format or
null
otherwise.
-
getPostProcessorNames
static Collection<String> getPostProcessorNames(ImportersLoader loader)
-
getPostProcessorNames
static Collection<String> getPostProcessorNames()
-
addPostProcessors
static Importer addPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, String... names)
-
addPostProcessors
static Importer addPostProcessors(Importer importer, ComputationManager computationManager, String... names)
-
setPostProcessors
static Importer setPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, String... names)
-
setPostProcessors
static Importer setPostProcessors(Importer importer, ComputationManager computationManager, String... names)
-
find
static Importer find(ReadOnlyDataSource dataSource, ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
-
find
static Importer find(ReadOnlyDataSource dataSource, ComputationManager computationManager)
-
find
static Importer find(ReadOnlyDataSource dataSource)
-
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
-
-