# chafik-akmouche/pdph-backend architecture

> Architecture diagram of the GitHub repository chafik-akmouche/pdph-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chafik-akmouche/pdph-backend
- Repository: https://github.com/chafik-akmouche/pdph-backend

## Overview

PdPH is a hospital-staff scheduling backend: a client submits cycle length, constraint options, and input data; the service persists request files, invokes the scheduling solver, and exposes saved solutions as JSON. The solver parses staffing requirements and builds an optimization model using CPLEX. The graph also shows the separate solution-browsing and saved-parameter capabilities. Source excerpts establish the API, input preparation, solver invocation, and result parsing; the solver’s complete output-to-solution-file path is not shown, so that relationship is left unconnected.

Main entry points: [`src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java) (REST Controller), [`src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java`](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java) (Solution Reader), [`src/main/java/com/projet/annuel/pdph/solveur/Solver.java`](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/solveur/Solver.java) (Schedule Optimizer), [`src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java`](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java) (Solver Parameters)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["HTTP API"]
  node_application["Spring Application"]
  node_controller["REST Controller<br/>[Controller.java]"]
end

subgraph group_preparation["Request Preparation"]
  node_params["Solver Parameters<br/>[SolveurParam.java]"]
  node_requestfiles["Input and Config Files<br/>[SolveurParam.java]"]
end

subgraph group_optimization["Scheduling Optimization"]
  node_callsolver["Solver Launcher<br/>[CallSolver.java]"]
  node_solver["Schedule Optimizer<br/>[Solver.java]"]
  node_functions["Input Parsing and Metrics<br/>[Functions.java]"]
end

subgraph group_browsing["Solution Browsing"]
  node_solutionfiles["Saved Solution Files<br/>[Response.java]"]
  node_response["Solution Reader<br/>[Response.java]"]
  node_slot["Schedule Slot DTO<br/>[Creneau.java]"]
  node_filter["Solution List DTO<br/>[FilterParams.java]"]
end

node_client(("API Client"))
node_cplex["IBM CPLEX"]

node_client -->|"sends requests"| node_controller
node_application -.->|"serves API"| node_controller
node_controller -->|"accepts parameters"| node_params
node_controller -->|"persists request"| node_requestfiles
node_params -->|"writes files"| node_requestfiles
node_controller -->|"starts solve"| node_callsolver
node_callsolver -->|"constructs solver"| node_solver
node_solver -->|"parses inputs"| node_functions
node_solver -->|"solves model"| node_cplex
node_controller -->|"reads solutions"| node_response
node_response -->|"reads workbook"| node_solutionfiles
node_response -->|"builds schedule slots"| node_slot
node_controller -->|"returns solution list"| node_filter
node_response -->|"provides solution names"| node_filter

click node_application "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/PdPhBackendApplication.java"
click node_controller "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java"
click node_params "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java"
click node_requestfiles "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java"
click node_callsolver "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/CallSolver.java"
click node_solver "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/solveur/Solver.java"
click node_functions "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/solveur/Functions.java"
click node_solutionfiles "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java"
click node_response "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java"
click node_slot "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Creneau.java"
click node_filter "https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/FilterParams.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_application,node_controller,node_client toneBlue
class node_params,node_requestfiles toneAmber
class node_callsolver,node_solver,node_functions toneMint
class node_solutionfiles,node_response,node_slot,node_filter toneRose
class node_cplex toneIndigo
```

## Components

### HTTP API

- [Spring Application](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/PdPhBackendApplication.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/PdPhBackendApplication.java`
- [REST Controller](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`

### Request Preparation

- [Solver Parameters](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java`
- [Input and Config Files](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java`

### Scheduling Optimization

- [Solver Launcher](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/CallSolver.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/CallSolver.java`
- [Schedule Optimizer](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/solveur/Solver.java): `src/main/java/com/projet/annuel/pdph/solveur/Solver.java`
- [Input Parsing and Metrics](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/solveur/Functions.java): `src/main/java/com/projet/annuel/pdph/solveur/Functions.java`

### Solution Browsing

- [Saved Solution Files](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java`
- [Solution Reader](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java`
- [Schedule Slot DTO](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/Creneau.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/Creneau.java`
- [Solution List DTO](https://github.com/chafik-akmouche/pdph-backend/blob/master/src/main/java/com/projet/annuel/pdph/PdPHBackend/FilterParams.java): `src/main/java/com/projet/annuel/pdph/PdPHBackend/FilterParams.java`

### Other components

- **API Client**
- **IBM CPLEX**

## Connections

- API Client → REST Controller: sends requests (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- Spring Application → REST Controller: serves API
- REST Controller → Solver Parameters: accepts parameters (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- REST Controller → Input and Config Files: persists request (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- Solver Parameters → Input and Config Files: writes files (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/SolveurParam.java`)
- REST Controller → Solver Launcher: starts solve (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- Solver Launcher → Schedule Optimizer: constructs solver (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/CallSolver.java`)
- Schedule Optimizer → Input Parsing and Metrics: parses inputs (evidence: `src/main/java/com/projet/annuel/pdph/solveur/Solver.java`)
- Schedule Optimizer → IBM CPLEX: solves model (evidence: `src/main/java/com/projet/annuel/pdph/solveur/Solver.java`)
- REST Controller → Solution Reader: reads solutions (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- Solution Reader → Saved Solution Files: reads workbook (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java`)
- Solution Reader → Schedule Slot DTO: builds schedule slots (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Response.java`)
- REST Controller → Solution List DTO: returns solution list (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
- Solution Reader → Solution List DTO: provides solution names (evidence: `src/main/java/com/projet/annuel/pdph/PdPHBackend/Controller.java`)
