Skip to content

Commit

Permalink
change packaging for converters
Browse files Browse the repository at this point in the history
  • Loading branch information
miovd committed Mar 27, 2019
1 parent a0105b2 commit efc6c91
Show file tree
Hide file tree
Showing 16 changed files with 33 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: import-export-parameters-default-value
layout: default
---

The `import-export-parameters-default-value` module is an optional module used by the `com.powsybl.iidm.import_.Importers`
The `import-export-parameters-default-value` module is an optional module used by the `com.powsybl.iidm.converter.Importers`
class to initialize the parameters passed to configure the importer. This module support 3 different types of properties:
- Boolean
- String
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/modules/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: import
layout: default
---

The `import` module is used by the `com.powsybl.iidm.import_.Importers` class, after a case is loaded. A
The `import` module is used by the `com.powsybl.iidm.converter.Importers` class, after a case is loaded. A
[post processor](../../iidm/importer/post-processor/index.md) is a class used to modify a network after its loading:
- [GroovyPostProcessor](../../iidm/importer/post-processor/GroovyScriptPostProcessor.md): to run a groovy script
- [JavaScriptPostProcessor](../../iidm/importer/post-processor/JavaScriptPostProcessor.md) to run a javascript script
Expand All @@ -16,7 +16,7 @@ used to list the available implementations.
# Optional properties

## postProcessors
The `postProcessors` property is an optional property that defines the list of `com.powsybl.iidm.import_.ImportPostProcessor`
The `postProcessors` property is an optional property that defines the list of `com.powsybl.iidm.converter.ImportPostProcessor`
names. The default value of this property is an empty list.

# Examples
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/modules/javaScriptPostProcessor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: javaScriptPostProcessor
layout: default
---

The `javaScriptPostProcessor` module is used by the `com.powsybl.iidm.import_.JavaScriptPostProcessor` class, which is
an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor` that runs a javascript script after a case is
The `javaScriptPostProcessor` module is used by the `com.powsybl.iidm.converter.JavaScriptPostProcessor` class, which is
an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor` that runs a javascript script after a case is
converted to an IIDM network.

# Optional properties
Expand Down
5 changes: 5 additions & 0 deletions docs/iidm/exporter/iidm.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ This property is deprecated since v2.4.0. Use the `iidm.export.xml.export-mode`
# Maven configuration
To support IIDM-XML files, add the following dependencies to the `pom.xml` file.
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-xml-converter</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion docs/iidm/exporter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Exporters
layout: default
---

The `com.powsybl.iidm.export.Exporter` class is used to serialize a IIDM network to files. Powsybl supports natively
The `com.powsybl.iidm.converter.Exporter` class is used to serialize a IIDM network to files. Powsybl supports natively
several implementations:
- [IIDM](iidm.md)
- [AMPL](ampl.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/iidm/importer/cgmes.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To support CGMES files, add the following dependencies to the `pom.xml` file:
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-cgmes-conversion</artifactId>
<artifactId>powsybl-cgmes-converter</artifactId>
<version>${powsybl.version}</version>
</dependency>
<dependency>
Expand Down
5 changes: 5 additions & 0 deletions docs/iidm/importer/iidm.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,11 @@ The `throwExceptionIfExtensionNotFound` property is deprecated since v2.0.0. Use
# Maven configuration
To support IIDM-XML files, add the following dependencies to the `pom.xml` file.
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-xml-converter</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion docs/iidm/importer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Importers
layout: default
---

The `com.powsybl.iidm.import_.Importer` class is used to create a IIDM network instance from a case. Powsybl supports
The `com.powsybl.iidm.converter.Importer` class is used to create a IIDM network instance from a case. Powsybl supports
natively several implementations:
- [IIDM](iidm.md)
- [CGMES](cgmes.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GroovyScriptPostProcessor
layout: default
---

The `com.powsybl.iidm.import_.GroovyScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor`
The `com.powsybl.iidm.converter.GroovyScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor`
interface that runs a Groovy script after a IIDM network is loaded.

The groovy script has access to two variables:
Expand Down Expand Up @@ -49,7 +49,7 @@ To use the Groovy post processor, add the following dependencies to the `pom.xml
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
```
4 changes: 2 additions & 2 deletions docs/iidm/importer/post-processor/JavaScriptPostProcessor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: JavaScriptPostProcessor
layout: default
---

The `com.powsybl.iidm.import_.JavaScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor`
The `com.powsybl.iidm.converter.JavaScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor`
interface that runs a JS script after a IIDM network is loaded.

The JS script has access to two variables:
Expand Down Expand Up @@ -50,7 +50,7 @@ To use the Groovy post processor, add the following dependencies to the `pom.xml
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
```
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: LoadFlowResultsCompletionPostProcessor
layout: default
---

The `com.powsybl.loadflow.LoadFlowResultsCompletionPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor`
The `com.powsybl.loadflow.LoadFlowResultsCompletionPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor`
interface that aims at completing the loadflow results of a network, computing and assigning, if not already set, the flows
at the end of branches.

Expand Down
2 changes: 1 addition & 1 deletion docs/iidm/importer/ucte.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To support UCTE-DEF files, add the following dependencies to the `pom.xml` file:
</dependency>
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-ucte-network</artifactId>
<artifactId>powsybl-ucte-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/convert-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To use the `convert-network` command, add the following dependencies to the `pom
```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
```
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/iidm/exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In order to do so, you will need to:

In order to implement a new `Exporter`, add the following dependencies
- `auto-service (com.google.auto.service)`: Configuration/metadata generator for `ServiceLoader`-style providers
- `powsybl-iidm-converter-api`: IIDM network import/export API
- `powsybl-iidm-api`: IIDM network API

in your `pom.xml` file:

Expand All @@ -28,7 +28,7 @@ in your `pom.xml` file:
</dependency>
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.core.version}</version>
</dependency>
</dependencies>
Expand All @@ -41,7 +41,7 @@ implementation. Here is an empty class template of an `Exporter` implementation:

```java
import com.powsybl.commons.datasource.DataSource;
import com.powsybl.iidm.export.Exporter;
import com.powsybl.iidm.converter.Exporter;
import com.powsybl.iidm.network.Network;

import java.util.Properties;
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/iidm/importer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In order to do so, you will need to:

In order to implement a new `Importer`, add the following dependencies in your `pom.xml` file:
- `auto-service (com.google.auto.service)`: Configuration/metadata generator for `ServiceLoader`-style providers
- `powsybl-iidm-converter-api`: IIDM network import/export API
- `powsybl-iidm-api`: IIDM network API

```xml
<dependencies>
Expand All @@ -26,7 +26,7 @@ In order to implement a new `Importer`, add the following dependencies in your `
</dependency>
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.core.version}</version>
</dependency>
</dependencies>
Expand All @@ -40,7 +40,7 @@ implementation. Here is an empty class template of an `Importer` implementation:
```java
import com.powsybl.commons.datasource.DataSource;
import com.powsybl.commons.datasource.ReadOnlyDataSource;
import com.powsybl.iidm.import_.Importer;
import com.powsybl.iidm.converter.Importer;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.parameters.Parameter;

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/itools/extend-itools.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ dependencies to implement a new `iTools` command are the following:

In your project you also need to add the other dependencies required by your command business logic implementation, e.g.
to implement the `iTools` command displaying the number of lines of a network, you would have to add the following
dependency to get the IIDM converter API, needed to import IIDM networks:
dependency to get the IIDM API, needed to import IIDM networks:

```xml
<dependency>
<groupId>com.powsybl</groupId>
<artifactId>powsybl-iidm-converter-api</artifactId>
<artifactId>powsybl-iidm-api</artifactId>
<version>${powsybl.version}</version>
</dependency>
```
Expand Down

0 comments on commit efc6c91

Please sign in to comment.