com.powsybl.iidm.export

Class Exporters

java.lang.Object

com.powsybl.iidm.export.Exporters

public final class Exporters
extends java.lang.Object

A utility class to work with IIDM exporters.

Method Summary

Modifier and Type	Method and Description
static DataSource	createDataSource(java.nio.file.Path file)
static DataSource	createDataSource(java.nio.file.Path file, DataSourceObserver observer)
static DataSource	createDataSource(java.nio.file.Path directory, java.lang.String fileNameOrBaseName, DataSourceObserver observer)
static void	export(ExportersLoader loader, java.lang.String format, Network network, java.util.Properties parameters, DataSource dataSource) A convenient method to export a model to a given format.
static void	export(ExportersLoader loader, java.lang.String format, Network network, java.util.Properties parameters, java.nio.file.Path file) A convenient method to export a model to a given format.
static void	export(ExportersLoader loader, java.lang.String format, Network network, java.util.Properties parameters, java.lang.String directory, java.lang.String baseName) A convenient method to export a model to a given format.
static void	export(java.lang.String format, Network network, java.util.Properties parameters, DataSource dataSource)
static void	export(java.lang.String format, Network network, java.util.Properties parameters, java.nio.file.Path file)
static void	export(java.lang.String format, Network network, java.util.Properties parameters, java.lang.String directory, java.lang.String baseName)
static Exporter	getExporter(ExportersLoader loader, java.lang.String format) Get an exporter.
static Exporter	getExporter(java.lang.String format)
static java.util.Collection<java.lang.String>	getFormats()
static java.util.Collection<java.lang.String>	getFormats(ExportersLoader loader) Get all supported export formats.

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(ExportersLoader loader)

Get all supported export formats.

getFormats

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

getExporter

public static Exporter getExporter(ExportersLoader loader,
                                   java.lang.String format)

Get an exporter.

Parameters:

format - the export format

Returns:

the exporter if one exists for the given format or null otherwise

getExporter

public static Exporter getExporter(java.lang.String format)

createDataSource

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

createDataSource

public static DataSource createDataSource(java.nio.file.Path file,
                                          DataSourceObserver observer)

createDataSource

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

export

public static void export(ExportersLoader loader,
                          java.lang.String format,
                          Network network,
                          java.util.Properties parameters,
                          DataSource dataSource)

A convenient method to export a model to a given format.

Parameters:

format - the export format

network - the model

parameters - some properties to configure the export

dataSource - data source

export

public static void export(java.lang.String format,
                          Network network,
                          java.util.Properties parameters,
                          DataSource dataSource)

export

public static void export(ExportersLoader loader,
                          java.lang.String format,
                          Network network,
                          java.util.Properties parameters,
                          java.nio.file.Path file)

A convenient method to export a model to a given format.

Parameters:

format - the export format

network - the model

parameters - some properties to configure the export

file - the network file

export

public static void export(java.lang.String format,
                          Network network,
                          java.util.Properties parameters,
                          java.nio.file.Path file)

export

public static void export(ExportersLoader loader,
                          java.lang.String format,
                          Network network,
                          java.util.Properties parameters,
                          java.lang.String directory,
                          java.lang.String baseName)

A convenient method to export a model to a given format.

Parameters:

format - the export format

network - the model

parameters - some properties to configure the export

directory - the output directory where files are generated

baseName - a base name for all generated files

export

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