Merge remote-tracking branch 'origin/develop-ifremer'

architecture.md

+ 
+# App architecture
+
+## Overview
+
+Ionic, Angular, Angular Material, Apollo (graphql)
+
+On Android: Cordova plugins (camera, audio, ...).
+
+## Modules
+
+- Shared
+- Core
+- Admin
+- Referential
+- Data
+  * Trip
+  * ...
+
+## Core module
+
+### Core :: Storage
+
+- Local storage (web browser) or SQLlite (Android)
+
+### Core :: Config
+
+- Load order: pod, local storage, environement (defaults)
+- Allow to get: 
+  * theme (colors, app logo, partner's logos, background images)
+  * App name
+  * Software properties (See the pod entity SoftwareProperties)
+
+## Core :: Settings
+
+- User defined, with defaults
+- Saved locally
+
+- Allow to store: 
+ * user locale
+ * usage mode (on field mode, or desktop mode),
+ * fields preferences (e.g. Display label+Code, or Label only)
+ * ...
+ 
+
+### Core :: Services
+
+- Base service can be linked each other:
+  * Life cycle : start() stop() ready() 
+
+
+#### Network service
+
+- First service to be started
+- Manage network connection and peer changes.
+- If no peer found (in local storage or environement) ask user to choose a peer
+
+#### Platform service
+- Wait network to be started, then settings, and Cordova plugins
+
+#### Data service
+
+- Query GQL
+  * Fragments
+
+- EditorDataService: CRUD for editor
+  * load()
+  * save()
+  * delete()
+  * listenChanges()
+
+- TableDataService: CRUD for table
+  * watchAll()
+  * saveAll()
+  * deleteAll()
+
+- Cache
+
+- Model entities
+- Entity validators
+
+##### What is GraphQL ?
+
+- Query
+- Mutation (update, delete)
+- Subscription (listen changes)
+
+##### Model entities
+
+- Simple beans:
+  * only attributes
+  * BUT with two required functions:
+    * fromObject() : parse GraphQL queries result
+    * asObject(): convert to objet for GraphQL mutations
+- Class inheritance (Entity -> DataEntity -> Trip)
+- Interface implementation (IReferentialItem, IWithVesselEntity)
+
+#### Validators
+
+- Check entities content (e.g. min/max, required fields, etc.)
+- Used in Reactive forms
+
+## Admin module
+
+- Access to pod managment
+  * Users
+  * Pod's configuration (see entities: Software & SoftwareProperties)
+
+## Data module
+
+- Utilities for data editor, data table
+- Use abstract data model entities (.e.g QualityFlag, RecorderDepartment)
+
+## Business modules (e.g. Trip)
+
+- Final user (business specific) screens
+  * Pages,
+  * Services
+  * Entities
+  * Validator
+
+  
+  
+# Pod architecture
+
+## Overview
+
+Spring Boot, Hibernate/JPA, GraphQL-java
+
+## Maven
+
+- Start pod (-Prun)
+- Liquibase diff 
+
+## Database
+
+- HSQLDB (server mode) 
+- Oracle (mapping over a SIH-Adagio database)
+
+## Model entities
+
+- JPA entities
+- Value Object (VO)
+
+## DAO / Repository
+
+- Interface + Impl
+- HQL Query
+- JPA Query Builder - toSpecification()
+- Cache (Spring Cache)
+- Unit Tests
+
+## Service
+
+- Interface + Impl
+- Unit Tests
+
+## GraphQL endpoint
+
+- Annotations: declare query/mutation, auth
+- Contextual fecth
+- Dev tools: GraphiQL

model/mapping_imagine.md

+# Mapping Adagio / Sumaris
+
+Modèle Adagio : http://www.ifremer.fr/allegro/allegro-uml/html/index.html
+
+Spécifications : https://www.ifremer.fr/sih-resource-private/bargeo/UML/bargeo.html
+
+## Utilisateurs, profils et droits
+
+| Specs | Adagio | Sumaris |
+| ----- | ------ | ------- |
+| Utilisateur | person (first_name, last_name, email, department_fk) | person (first_name, last_name, email, department_fk) |
+| Profil | user_profil : <br> ALLEGRO_ADMINISTRATEUR, ALLEGRO_UTILISATEUR, ALLEGRO_SUPER_UTILISATEUR | user_profile : <br> ADMIN, USER, SUPERVISOR, GUEST (surchargé par énumération) |
+| Privilège | program_privilege : <br> Administrateur, Observateur, Consultation intégrale, Validateur, Qualificateur | program_privilege : <br> MANAGER, OBSERVER, VIEWER, VALIDATOR, QUALIFIER (surchargé par énumération) |
+| Droits | ? *observed_location (sampling_strata_fk, location_fk)* <br> ? *observed_location2person (observed_location_fk, program_privilege_fk, person_fk, department_fk)* | ? |
+
+Profiles et privilèges utilisés :
+- Administrateur de référentiel : profil Administrateur
+- Administrateur de programme : profil Administrateur avec privilège Administrateur sur un programme
+- Utilisateur : profile Utilisateur avec privilège Observateur sur une observation
+
+Les droits sont gérés au niveau de l'observation.
+
+## Plans d'échantillonnage et lignes de plan
+
+Les stratégies sont reliées au programme PARAM-BIO.
+Les données seront par contre rattachées au programmes de collecte correspondants : SIH-OBSVENTE, CAM-*.
+
+| Specs | Adagio |
+| ----- | ------ |
+| programme (PARAM-BIO) | strategy.program_fk |
+| code (AAAA_BIO_XXXX) | strategy.label + strategy.name |
+| commentaire | strategy.description |
+| EOTP | strategy.analytic_reference |
+| laboratoire | strategy2department (program_privilège_fk=Observateur) |
+| zones de pêches | applied_strategy.location_fk + program2location (zones en mer / configurables) |
+| espèce cible | strategy.reference_taxon_strategy.reference_taxon_fk |
+| paramètres à mesurer | pmfm_strategy (acquisition_level_fk=SAMPLE) |
+| - poids (liste de pmfm) | pmfm_strategy.pmfm_fk |
+| - taille (liste de pmfm) | pmfm_strategy.pmfm_fk |
+| - sexe (pmfm) | pmfm_strategy.pmfm_fk |
+| - maturité (liste de pmfm) | pmfm_strategy.pmfm_fk |
+| - âge (pmfm) | pmfm_strategy.pmfm_fk |
+| - type de pièce calcifiée (liste de fractions) | pmfm_strategy.fraction_fk |
+| début de la période | non stocké (min applied_period.start_date) |
+| fin de la période | non stocké (max applied_period.end_date) |
+| trimestres de la période | applied_strategy.applied_period.start_date/end_date (lié à la première zone de pêche) |
+| efforts sur le trimestre | applied_strategy.applied_period.acquisition_number (lié à la première zone de pêche) |
+
+> Initialiser PROGRAM2LOCATION_CLASSIFICATION avec zones en mer / zones à terre
+
+> Lorsque les stratégies sont modifiées, mettre à jour PROGRAM.UPDATE_DATE
+
+Liste des évolutions de modèle nécessaires :
+- modifier PMFM_STRATEGY.PMFM_FK en nullable
+- ajouter les colonnes PMFM_STRATEGY.PARAMETER_FK, MATRIX_FK, FRACTION_FK, METHOD_FK en nullable
+- ajouter les colonnes STRATEGY.ANALYTIC_REFERENCE, APPLIED_PERIOD.ACQUISITION_NUMBER
+- ajouter la table STRATEGY2DEPARTMENT : lien n-n avec program_privilège_fk (cf program2department)
+- [POD] modifier le service qui va chercher les PMFM applicables, pour, à partir de ces PMFM_STRATEGY, aller chercher (par requêtes) les PMFM qui correspondent
+
+Spécifications : https://www.ifremer.fr/sih-resource-private/bargeo/UML/bargeo.html?refid=_17_0_4_2_ece0350_1583488391537_540379_6549
+
+![pmfm_strategy](http://www.ifremer.fr/allegro/allegro-uml/html/index_files/_12_5_1_eb50347_1207578735308_746618_4801.jpg)
\ No newline at end of file