com.powsybl.iidm.xml

Class XMLImporter

java.lang.Object

com.powsybl.iidm.xml.XMLImporter

All Implemented Interfaces:

Importer

@AutoService(value=Importer.class)
public class XMLImporter
extends java.lang.Object
implements Importer

Constructor Summary

Constructors

Constructor and Description
XMLImporter()
XMLImporter(PlatformConfig platformConfig)

Method Summary

Modifier and Type	Method and Description
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
java.lang.String	getComment() Get some information about this importer.
java.lang.String	getFormat() Get a unique identifier of the format.
java.util.List<Parameter>	getParameters() Get a description of import parameters
Network	importData(ReadOnlyDataSource dataSource, java.util.Properties parameters) Create a model.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLImporter

public XMLImporter()

XMLImporter

public XMLImporter(PlatformConfig platformConfig)

Method Detail

getFormat

public java.lang.String getFormat()

Description copied from interface: Importer

Get a unique identifier of the format.

Specified by:

getFormat in interface Importer

getParameters

public java.util.List<Parameter> getParameters()

Description copied from interface: Importer

Get a description of import parameters

Specified by:

getParameters in interface Importer

Returns:

getComment

public java.lang.String getComment()

Description copied from interface: Importer

Get some information about this importer.

Specified by:

getComment in interface Importer

exists

public boolean exists(ReadOnlyDataSource dataSource)

Description copied from interface: Importer

Check if the data source is importable

Specified by:

exists in interface Importer

Parameters:

dataSource - the data source

Returns:

true if the data source is importable, false otherwise

copy

public void copy(ReadOnlyDataSource fromDataSource,
                 DataSource toDataSource)

Description copied from interface: Importer

Copy data from one data source to another.

Specified by:

copy in interface Importer

Parameters:

fromDataSource - from data source

toDataSource - destination data source

importData

public Network importData(ReadOnlyDataSource dataSource,
                          java.util.Properties parameters)

Description copied from interface: Importer

Create a model.

Specified by:

importData in interface Importer

Parameters:

dataSource - data source

parameters - some properties to configure the import

Returns:

the model