Package com.powsybl.iidm.serde

Class AbstractTreeDataImporter

java.lang.Object

com.powsybl.iidm.serde.AbstractTreeDataImporter

All Implemented Interfaces:

Importer

Direct Known Subclasses:

JsonImporter, XMLImporter

public abstract class AbstractTreeDataImporter
extends Object
implements Importer

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.iidm.network.Importer

Importer.ImporterWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSIONS_LIST
static final String	THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTreeDataImporter()
protected	AbstractTreeDataImporter(PlatformConfig platformConfig)

Method Summary

Modifier and Type	Method	Description
void	copy(ReadOnlyDataSource fromDataSource, DataSource toDataSource)	Copy data from one data source to another.
protected ImportOptions	createImportOptions(Properties parameters)
boolean	exists(ReadOnlyDataSource dataSource)	Check if the data source is importable
protected abstract boolean	exists(ReadOnlyDataSource dataSource, String ext)
protected abstract String[]	getExtensions()
List<Parameter>	getParameters()	Get a description of import parameters
Network	importData(ReadOnlyDataSource dataSource, NetworkFactory networkFactory, Properties parameters, Reporter reporter)	Create a model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.iidm.network.Importer

getComment, getFormat, importData, importData

Field Details

THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

public static final String THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

See Also:

• Constant Field Values

EXTENSIONS_LIST

public static final String EXTENSIONS_LIST

See Also:

• Constant Field Values

Constructor Details

AbstractTreeDataImporter

protected AbstractTreeDataImporter()

AbstractTreeDataImporter

protected AbstractTreeDataImporter(PlatformConfig platformConfig)

Method Details

getParameters

public List<Parameter> getParameters()

Description copied from interface: Importer

Get a description of import parameters

Specified by:

getParameters in interface Importer

Returns:

getExtensions

protected abstract String[] getExtensions()

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

exists

protected abstract boolean exists(ReadOnlyDataSource dataSource,
 String ext)
                           throws IOException

Throws:

IOException

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,
 NetworkFactory networkFactory,
 Properties parameters,
 Reporter reporter)

Description copied from interface: Importer

Create a model.

Specified by:

importData in interface Importer

Parameters:

dataSource - data source

networkFactory - network factory

parameters - some properties to configure the import

reporter - the reporter used for functional logs

Returns:

the model

createImportOptions

protected ImportOptions createImportOptions(Properties parameters)