Skip to content

Commit

Permalink
feat(#336): remove sct-data module and update documents
Browse files Browse the repository at this point in the history
Signed-off-by: Aliou DIAITE <aliou.diaite@rte-france.com>
  • Loading branch information
AliouDIAITE committed Oct 11, 2023
1 parent 4a14304 commit 5651f19
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 168 deletions.
1 change: 0 additions & 1 deletion docs/QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Actually there are 4 packages available:
- compas-sct
- sct-commons
- sct-app
- sct-data


#### 2. Usage
Expand Down
38 changes: 0 additions & 38 deletions docs/compas-sct.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ The below package diagram shows different part of the tool architecture.
Hence, we can distinguish four major parts:

* **[sct-commons](#SCT-COMMONS)** : a library that contents shared functionalities for the bound SCL object.
* **[sct-data](#SCT-DATA)** : It holds data models and database connectivity services.
* **[sct-app](#SCT-APPLICATION)** : *TODO*.

## SCT COMMONS
Expand Down Expand Up @@ -96,43 +95,6 @@ should always return `true`:
[...]
}

## SCT DATA
Data models and connectivity to database are defined here. Data access layer is an abstract layer that defined connectivity
interfaces. This layer manages a database with single table (SQL-Like database) or single collection (NoSQL-Like database).
The concrete data access layers are implemented in specific packages. A data model can implement the following interface

```
public interface IScd <ID> {
ID getId();
byte[] getRawXml();
ID getHeaderId();
String getHeaderRevision();
String getHeaderVersion();
String filename();
}
```

* ### SQL-Like Database
An implementation of the sct-data connectivity interface with custom data models. This allows the application to work with sql-like database.
The libraries ares use for SQL-Like databases, those that support XML type (PostgreSql, Oracle, etc)

* ### NoSQL-Like Database
Like SQL-like part, this package contains the sct-data connector interfaces implementation for NoSQL-Like databases (BaseX, existDB, etc )
that support XML processing.

This can also be a local repository connector (file system). For example, with meta-data headerID, headerVersion, headerRevision and filename
one can implement the connector to have the below output (with the constraint of having a single file in /pathTo/headerId/headerVersion/headerRevision):

```
myRepo
├───<headerID>
│ ├───<headerVersion1>
│ │ └───<headerRevision1>
│ │ | ├───<fileName1.scd>
│ │ └───<headerRevision2>
│ │ ├───<fileName2.scd>
```

## SCT APPLICATION
**TODO**
> In progress
Expand Down
1 change: 0 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@
<modules>
<module>sct-commons</module>
<module>sct-coverage</module>
<module>sct-data</module>
<module>sct-app</module>
</modules>

Expand Down
55 changes: 0 additions & 55 deletions sct-data/pom.xml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 5651f19

Please sign in to comment.