com.powsybl.iidm.import_

Class Importers

java.lang.Object

com.powsybl.iidm.import_.Importers

public final class Importers
extends java.lang.Object

A utility class to work with IIDM importers.

Method Summary

Modifier and Type	Method and Description
static Importer	addPostProcessors(Importer importer, ComputationManager computationManager, java.lang.String... names)
static Importer	addPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, java.lang.String... names)
static Importer	addPostProcessors(Importer importer, java.lang.String... names)
static DataSource	createDataSource(java.nio.file.Path file)
static DataSource	createDataSource(java.nio.file.Path directory, java.lang.String fileNameOrBaseName)
static Importer	findImporter(ReadOnlyDataSource dataSource, ComputationManager computationManager)
static Importer	findImporter(ReadOnlyDataSource dataSource, ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
static java.util.Collection<java.lang.String>	getFormats()
static java.util.Collection<java.lang.String>	getFormats(ImportersLoader loader) Get all supported import formats.
static Importer	getImporter(ImportersLoader loader, java.lang.String format, ComputationManager computationManager, ImportConfig config) Get an importer.
static Importer	getImporter(java.lang.String format)
static Importer	getImporter(java.lang.String format, ComputationManager computationManager)
static Importer	getImporter(java.lang.String format, ComputationManager computationManager, ImportConfig config)
static java.util.Collection<java.lang.String>	getPostProcessorNames()
static java.util.Collection<java.lang.String>	getPostProcessorNames(ImportersLoader loader)
static void	importAll(java.nio.file.Path dir, Importer importer, boolean parallel, java.util.function.Consumer<Network> consumer)
static void	importAll(java.nio.file.Path dir, Importer importer, boolean parallel, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	importAll(java.nio.file.Path dir, Importer importer, boolean parallel, java.util.Properties parameters, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static Network	importData(ImportersLoader loader, java.lang.String format, ReadOnlyDataSource dataSource, java.util.Properties parameters, ComputationManager computationManager, ImportConfig config) A convenient method to create a model from data in a given format.
static Network	importData(java.lang.String format, ReadOnlyDataSource dataSource, java.util.Properties parameters)
static Network	importData(java.lang.String format, ReadOnlyDataSource dataSource, java.util.Properties parameters, ComputationManager computationManager)
static Network	importData(java.lang.String format, java.lang.String directory, java.lang.String baseName, java.util.Properties parameters) A convenient method to create a model from data in a given format.
static java.util.Collection<Importer>	list()
static java.util.Collection<Importer>	list(ComputationManager computationManager, ImportConfig config)
static java.util.Collection<Importer>	list(ImportersLoader loader, ComputationManager computationManager, ImportConfig config)
static Network	loadNetwork(java.nio.file.Path file)
static Network	loadNetwork(java.nio.file.Path file, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters)
static Network	loadNetwork(java.nio.file.Path file, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters, ImportersLoader loader)
static Network	loadNetwork(java.lang.String file)
static Network	loadNetwork(java.lang.String filename, java.io.InputStream data)
static Network	loadNetwork(java.lang.String filename, java.io.InputStream data, ComputationManager computationManager)
static Network	loadNetwork(java.lang.String filename, java.io.InputStream data, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters)
static Network	loadNetwork(java.lang.String filename, java.io.InputStream data, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters, ImportersLoader loader)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, ComputationManager computationManager, ImportConfig config, java.util.function.Consumer<Network> consumer)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, ComputationManager computationManager, ImportConfig config, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, java.util.function.Consumer<Network> consumer)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, ImportersLoader loader, ComputationManager computationManager, ImportConfig config, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	loadNetworks(java.nio.file.Path dir, boolean parallel, ImportersLoader loader, ComputationManager computationManager, ImportConfig config, java.util.Properties parameters, java.util.function.Consumer<Network> consumer, java.util.function.Consumer<ReadOnlyDataSource> listener)
static void	loadNetworks(java.nio.file.Path dir, java.util.function.Consumer<Network> consumer)
static java.lang.Object	readParameter(java.lang.String format, java.util.Properties parameters, Parameter configuredParameter) Deprecated. Use ConversionParameters.readParameter(String, Properties, Parameter) instead
static java.lang.Object	readParameter(java.lang.String format, java.util.Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig) Deprecated. Use ConversionParameters.readParameter(String, Properties, Parameter, ParameterDefaultValueConfig) instead
static Importer	removePostProcessors(Importer importer)
static Importer	setPostProcessors(Importer importer, ComputationManager computationManager, java.lang.String... names)
static Importer	setPostProcessors(ImportersLoader loader, Importer importer, ComputationManager computationManager, java.lang.String... names)
static Importer	setPostProcessors(Importer importer, java.lang.String... names)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFormats

public static java.util.Collection<java.lang.String> getFormats(ImportersLoader loader)

Get all supported import formats.

getFormats

public static java.util.Collection<java.lang.String> getFormats()

list

public static java.util.Collection<Importer> list(ImportersLoader loader,
                                                  ComputationManager computationManager,
                                                  ImportConfig config)

list

public static java.util.Collection<Importer> list(ComputationManager computationManager,
                                                  ImportConfig config)

list

public static java.util.Collection<Importer> list()

getImporter

public static Importer getImporter(ImportersLoader loader,
                                   java.lang.String format,
                                   ComputationManager computationManager,
                                   ImportConfig config)

Get an importer.

Parameters:

format - the import format

Returns:

the importer if one exists for the given format or null otherwise.

getImporter

public static Importer getImporter(java.lang.String format,
                                   ComputationManager computationManager,
                                   ImportConfig config)

getImporter

public static Importer getImporter(java.lang.String format,
                                   ComputationManager computationManager)

getImporter

public static Importer getImporter(java.lang.String format)

getPostProcessorNames

public static java.util.Collection<java.lang.String> getPostProcessorNames(ImportersLoader loader)

getPostProcessorNames

public static java.util.Collection<java.lang.String> getPostProcessorNames()

addPostProcessors

public static Importer addPostProcessors(ImportersLoader loader,
                                         Importer importer,
                                         ComputationManager computationManager,
                                         java.lang.String... names)

addPostProcessors

public static Importer addPostProcessors(Importer importer,
                                         ComputationManager computationManager,
                                         java.lang.String... names)

addPostProcessors

public static Importer addPostProcessors(Importer importer,
                                         java.lang.String... names)

setPostProcessors

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

setPostProcessors

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

setPostProcessors

public static Importer setPostProcessors(Importer importer,
                                         java.lang.String... names)

removePostProcessors

public static Importer removePostProcessors(Importer importer)

importData

public static Network importData(ImportersLoader loader,
                                 java.lang.String format,
                                 ReadOnlyDataSource dataSource,
                                 java.util.Properties parameters,
                                 ComputationManager computationManager,
                                 ImportConfig config)

A convenient method to create a model from data in a given format.

Parameters:

format - the import format

dataSource - data source

parameters - some properties to configure the import

computationManager - computation manager to use for default post processors

Returns:

the model

importData

public static Network importData(java.lang.String format,
                                 ReadOnlyDataSource dataSource,
                                 java.util.Properties parameters,
                                 ComputationManager computationManager)

importData

public static Network importData(java.lang.String format,
                                 ReadOnlyDataSource dataSource,
                                 java.util.Properties parameters)

importData

public static Network importData(java.lang.String format,
                                 java.lang.String directory,
                                 java.lang.String baseName,
                                 java.util.Properties parameters)

A convenient method to create a model from data in a given format.

Parameters:

format - the import format

directory - the directory where input files are

baseName - a base name for all input files

parameters - some properties to configure the import

Returns:

the model

importAll

public static void importAll(java.nio.file.Path dir,
                             Importer importer,
                             boolean parallel,
                             java.util.Properties parameters,
                             java.util.function.Consumer<Network> consumer,
                             java.util.function.Consumer<ReadOnlyDataSource> listener)
                      throws java.io.IOException,
                             java.lang.InterruptedException,
                             java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

importAll

public static void importAll(java.nio.file.Path dir,
                             Importer importer,
                             boolean parallel,
                             java.util.function.Consumer<Network> consumer,
                             java.util.function.Consumer<ReadOnlyDataSource> listener)
                      throws java.io.IOException,
                             java.lang.InterruptedException,
                             java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

importAll

public static void importAll(java.nio.file.Path dir,
                             Importer importer,
                             boolean parallel,
                             java.util.function.Consumer<Network> consumer)
                      throws java.io.IOException,
                             java.lang.InterruptedException,
                             java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

readParameter

@Deprecated
public static java.lang.Object readParameter(java.lang.String format,
                                                         java.util.Properties parameters,
                                                         Parameter configuredParameter)

Deprecated. Use ConversionParameters.readParameter(String, Properties, Parameter) instead

readParameter

@Deprecated
public static java.lang.Object readParameter(java.lang.String format,
                                                         java.util.Properties parameters,
                                                         Parameter configuredParameter,
                                                         ParameterDefaultValueConfig defaultValueConfig)

Deprecated. Use ConversionParameters.readParameter(String, Properties, Parameter, ParameterDefaultValueConfig) instead

createDataSource

public static DataSource createDataSource(java.nio.file.Path file)

createDataSource

public static DataSource createDataSource(java.nio.file.Path directory,
                                          java.lang.String fileNameOrBaseName)

findImporter

public static Importer findImporter(ReadOnlyDataSource dataSource,
                                    ImportersLoader loader,
                                    ComputationManager computationManager,
                                    ImportConfig config)

findImporter

public static Importer findImporter(ReadOnlyDataSource dataSource,
                                    ComputationManager computationManager)

loadNetwork

public static Network loadNetwork(java.nio.file.Path file,
                                  ComputationManager computationManager,
                                  ImportConfig config,
                                  java.util.Properties parameters,
                                  ImportersLoader loader)

loadNetwork

public static Network loadNetwork(java.nio.file.Path file,
                                  ComputationManager computationManager,
                                  ImportConfig config,
                                  java.util.Properties parameters)

loadNetwork

public static Network loadNetwork(java.nio.file.Path file)

loadNetwork

public static Network loadNetwork(java.lang.String file)

loadNetwork

public static Network loadNetwork(java.lang.String filename,
                                  java.io.InputStream data,
                                  ComputationManager computationManager,
                                  ImportConfig config,
                                  java.util.Properties parameters,
                                  ImportersLoader loader)

loadNetwork

public static Network loadNetwork(java.lang.String filename,
                                  java.io.InputStream data,
                                  ComputationManager computationManager,
                                  ImportConfig config,
                                  java.util.Properties parameters)

loadNetwork

public static Network loadNetwork(java.lang.String filename,
                                  java.io.InputStream data,
                                  ComputationManager computationManager)

loadNetwork

public static Network loadNetwork(java.lang.String filename,
                                  java.io.InputStream data)

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                ImportersLoader loader,
                                ComputationManager computationManager,
                                ImportConfig config,
                                java.util.Properties parameters,
                                java.util.function.Consumer<Network> consumer,
                                java.util.function.Consumer<ReadOnlyDataSource> listener)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                ImportersLoader loader,
                                ComputationManager computationManager,
                                ImportConfig config,
                                java.util.function.Consumer<Network> consumer,
                                java.util.function.Consumer<ReadOnlyDataSource> listener)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                ComputationManager computationManager,
                                ImportConfig config,
                                java.util.Properties parameters,
                                java.util.function.Consumer<Network> consumer,
                                java.util.function.Consumer<ReadOnlyDataSource> listener)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                ComputationManager computationManager,
                                ImportConfig config,
                                java.util.function.Consumer<Network> consumer,
                                java.util.function.Consumer<ReadOnlyDataSource> listener)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                ComputationManager computationManager,
                                ImportConfig config,
                                java.util.function.Consumer<Network> consumer)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                java.util.function.Consumer<Network> consumer)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                boolean parallel,
                                java.util.function.Consumer<Network> consumer,
                                java.util.function.Consumer<ReadOnlyDataSource> listener)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

loadNetworks

public static void loadNetworks(java.nio.file.Path dir,
                                java.util.function.Consumer<Network> consumer)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException