Package com.powsybl.iidm.network

Interface Importer

All Known Implementing Classes:

AbstractTreeDataImporter, BinaryImporter, CgmesImport, IeeeCdfImporter, Importer.ImporterWrapper, JsonImporter, MatpowerImporter, PowerFactoryImporter, 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 <geoffroy.jamgotchian at rte-france.com>

See Also:

• ServiceLoader
• Importers

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Importer.ImporterWrapper

Method Summary

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 importable
static 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 parameters
static 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, ReportNode reportNode)	Create a model.
default Network	importData(ReadOnlyDataSource dataSource, Properties parameters)	Deprecated. Use importData(ReadOnlyDataSource, NetworkFactory, Properties) instead.
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 Details

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 configured ImportPostProcessors on imported networks.

Parameters:

loader - the loader responsible for providing the list of available importers and post processors

format - the import format

computationManager - a computation manager which may be used by configured ImportPostProcessors

config - 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 configured ImportPostProcessors on imported networks.

All declared services implementing the Importer interface are available.

Parameters:

format - the import format

computationManager - a computation manager which may be used by configured ImportPostProcessors

config - 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 configured ImportPostProcessors 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 format

computationManager - a computation manager which may be used by configured ImportPostProcessors

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 configured ImportPostProcessors 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 of LocalComputationManager, 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)

addPostProcessors

static Importer addPostProcessors(Importer importer,
 String... names)

setPostProcessors

static Importer setPostProcessors(ImportersLoader loader,
 Importer importer,
 ComputationManager computationManager,
 String... names)

setPostProcessors

static Importer setPostProcessors(Importer importer,
 ComputationManager computationManager,
 String... names)

setPostProcessors

static Importer setPostProcessors(Importer importer,
 String... names)

removePostProcessors

static Importer removePostProcessors(Importer importer)

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(since="2.6.0")
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,
 ReportNode reportNode)

Create a model.

Parameters:

dataSource - data source

networkFactory - network factory

parameters - some properties to configure the import

reportNode - the reportNode 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