# vadimarsh/cleanexample architecture

> Architecture diagram of the GitHub repository vadimarsh/cleanexample, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vadimarsh/cleanexample
- Repository: https://github.com/vadimarsh/cleanexample

## Overview

This is a Swing student-debt planner. Users add disciplines and tasks, browse all or open tasks, mark tasks done, change deadlines, or cancel tasks; task changes trigger discipline-status refreshes. The UI controller dispatches domain use cases through repository ports to selectable in-memory, file, or SQLite adapters. The graph includes the documented capabilities and major domain stages; unsampled GUI/config wiring is represented only where the README or SOURCE INDEX supports it.

Main entry points: [`src/presentation/config/GUISwingConfig.java`](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/config/GUISwingConfig.java) (Dependency config), [`src/domain/usecase/discipline`](https://github.com/vadimarsh/cleanexample/tree/master/src/domain/usecase/discipline) (Discipline operations), [`src/presentation/gui/mainwindow/MainWindowController.java`](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainWindowController.java) (Task controller), [`src/data/repository`](https://github.com/vadimarsh/cleanexample/tree/master/src/data/repository) (Task repositories)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Swing presentation"]
  node_app["Application startup<br/>[Main.java]"]
  node_config["Dependency config"]
  node_mainui["Main window"]
  node_maincontroller["Task controller"]
  node_tasktable["Task table model"]
  node_disciplineui["Discipline window"]
  node_disciplinecontroller["Discipline controller"]
  node_disciplinetable["Discipline table model"]
end

subgraph group_domain["Business logic"]
  node_taskcases["Task operations"]
  node_disciplinecases["Discipline operations"]
  node_entities["Task and discipline"]
  node_taskport["Task repository port"]
  node_disciplineport["Discipline repository port"]
end

subgraph group_data["Data adapters"]
  node_taskrepos["Task repositories"]
  node_disciplinerepos["Discipline repositories"]
  node_storageinterface["Storage interface<br/>[Storage.java]"]
  node_dtos["Storage DTOs"]
end

subgraph group_storage["Persistence"]
  node_filegen["File ID generator"]
  node_filestorage["Text-file storage<br/>[InFileStorage.java]"]
  node_sqlstorage[("SQLite storage<br/>[SQLiteStorage.java]")]
end

node_user(("Planner user"))
node_dbfile[("SQLite database")]

node_user -->|"uses"| node_mainui
node_app -->|"creates"| node_config
node_app -->|"starts"| node_maincontroller
node_app -->|"creates"| node_mainui
node_config -->|"configures"| node_taskrepos
node_config -->|"configures"| node_disciplinerepos
node_config -->|"provides"| node_taskcases
node_config -->|"provides"| node_disciplinecases
node_maincontroller -->|"gets dependencies"| node_config
node_maincontroller -->|"invokes"| node_taskcases
node_maincontroller -->|"invokes"| node_disciplinecases
node_maincontroller -->|"updates"| node_mainui
node_mainui -->|"displays"| node_tasktable
node_mainui -->|"opens"| node_disciplinecontroller
node_disciplinecontroller -->|"gets dependencies"| node_config
node_disciplinecontroller -->|"invokes"| node_disciplinecases
node_disciplinecontroller -->|"updates"| node_disciplinetable
node_taskcases -->|"calls"| node_taskport
node_disciplinecases -->|"calls"| node_disciplineport
node_disciplinecases -->|"queries tasks"| node_taskport
node_taskrepos -->|"implements"| node_taskport
node_disciplinerepos -->|"implements"| node_disciplineport
node_taskrepos -->|"uses"| node_storageinterface
node_disciplinerepos -->|"uses"| node_storageinterface
node_taskrepos -->|"maps data"| node_dtos
node_disciplinerepos -->|"maps data"| node_dtos
node_filestorage -->|"generates IDs"| node_filegen
node_filestorage -->|"implements"| node_storageinterface
node_sqlstorage -->|"implements"| node_storageinterface
node_sqlstorage -->|"reads and writes"| node_dtos
node_sqlstorage -->|"persists to"| node_dbfile
node_taskrepos -->|"maps to"| node_entities
node_disciplinerepos -->|"maps to"| node_entities
node_taskcases -.->|"operates on"| node_entities
node_disciplinecases -.->|"operates on"| node_entities
node_user -->|"manages subjects"| node_disciplineui

click node_app "https://github.com/vadimarsh/cleanexample/blob/master/src/Main.java"
click node_config "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/config/GUISwingConfig.java"
click node_mainui "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainWindowView.java"
click node_maincontroller "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainWindowController.java"
click node_tasktable "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainTableModel.java"
click node_disciplineui "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesWindowView.java"
click node_disciplinecontroller "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesWindowController.java"
click node_disciplinetable "https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesTableModel.java"
click node_taskcases "https://github.com/vadimarsh/cleanexample/tree/master/src/domain/usecase/task"
click node_disciplinecases "https://github.com/vadimarsh/cleanexample/tree/master/src/domain/usecase/discipline"
click node_entities "https://github.com/vadimarsh/cleanexample/tree/master/src/domain/entity"
click node_taskport "https://github.com/vadimarsh/cleanexample/blob/master/src/domain/port/TaskRepository.java"
click node_disciplineport "https://github.com/vadimarsh/cleanexample/blob/master/src/domain/port/DisciplineRepository.java"
click node_taskrepos "https://github.com/vadimarsh/cleanexample/tree/master/src/data/repository"
click node_disciplinerepos "https://github.com/vadimarsh/cleanexample/tree/master/src/data/repository"
click node_storageinterface "https://github.com/vadimarsh/cleanexample/blob/master/src/data/repository/Storage.java"
click node_dtos "https://github.com/vadimarsh/cleanexample/tree/master/src/data/storage/dto"
click node_filegen "https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/InFileIDGenerator.java"
click node_filestorage "https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/InFileStorage.java"
click node_sqlstorage "https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/SQLiteStorage.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_app,node_config,node_mainui,node_maincontroller,node_tasktable,node_disciplineui,node_disciplinecontroller,node_disciplinetable,node_user toneBlue
class node_taskcases,node_disciplinecases,node_entities,node_taskport,node_disciplineport,node_dbfile toneAmber
class node_taskrepos,node_disciplinerepos,node_storageinterface,node_dtos toneMint
class node_filegen,node_filestorage,node_sqlstorage toneRose
```

## Components

### Swing presentation

- [Application startup](https://github.com/vadimarsh/cleanexample/blob/master/src/Main.java): `src/Main.java`
- [Dependency config](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/config/GUISwingConfig.java): `src/presentation/config/GUISwingConfig.java`
- [Main window](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainWindowView.java): `src/presentation/gui/mainwindow/MainWindowView.java`
- [Task controller](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainWindowController.java): `src/presentation/gui/mainwindow/MainWindowController.java`
- [Task table model](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/mainwindow/MainTableModel.java): `src/presentation/gui/mainwindow/MainTableModel.java`
- [Discipline window](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesWindowView.java): `src/presentation/gui/discwindow/DisciplinesWindowView.java`
- [Discipline controller](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesWindowController.java): `src/presentation/gui/discwindow/DisciplinesWindowController.java`
- [Discipline table model](https://github.com/vadimarsh/cleanexample/blob/master/src/presentation/gui/discwindow/DisciplinesTableModel.java): `src/presentation/gui/discwindow/DisciplinesTableModel.java`

### Business logic

- [Task operations](https://github.com/vadimarsh/cleanexample/tree/master/src/domain/usecase/task): `src/domain/usecase/task`
- [Discipline operations](https://github.com/vadimarsh/cleanexample/tree/master/src/domain/usecase/discipline): `src/domain/usecase/discipline`
- [Task and discipline](https://github.com/vadimarsh/cleanexample/tree/master/src/domain/entity): `src/domain/entity`
- [Task repository port](https://github.com/vadimarsh/cleanexample/blob/master/src/domain/port/TaskRepository.java): `src/domain/port/TaskRepository.java`
- [Discipline repository port](https://github.com/vadimarsh/cleanexample/blob/master/src/domain/port/DisciplineRepository.java): `src/domain/port/DisciplineRepository.java`

### Data adapters

- [Task repositories](https://github.com/vadimarsh/cleanexample/tree/master/src/data/repository): `src/data/repository`
- [Discipline repositories](https://github.com/vadimarsh/cleanexample/tree/master/src/data/repository): `src/data/repository`
- [Storage interface](https://github.com/vadimarsh/cleanexample/blob/master/src/data/repository/Storage.java): `src/data/repository/Storage.java`
- [Storage DTOs](https://github.com/vadimarsh/cleanexample/tree/master/src/data/storage/dto): `src/data/storage/dto`

### Persistence

- [File ID generator](https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/InFileIDGenerator.java): `src/data/storage/InFileIDGenerator.java`
- [Text-file storage](https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/InFileStorage.java): `src/data/storage/InFileStorage.java`
- [SQLite storage](https://github.com/vadimarsh/cleanexample/blob/master/src/data/storage/SQLiteStorage.java): `src/data/storage/SQLiteStorage.java`

### Other components

- **Planner user**
- **SQLite database**

## Connections

- Planner user → Main window: uses (evidence: `README.md`)
- Application startup → Dependency config: creates (evidence: `src/Main.java`)
- Application startup → Task controller: starts (evidence: `src/Main.java`)
- Application startup → Main window: creates (evidence: `src/Main.java`)
- Dependency config → Task repositories: configures (evidence: `src/presentation/config/GUISwingConfig.java`)
- Dependency config → Discipline repositories: configures (evidence: `src/presentation/config/GUISwingConfig.java`)
- Dependency config → Task operations: provides (evidence: `src/presentation/config/GUISwingConfig.java`)
- Dependency config → Discipline operations: provides (evidence: `src/presentation/config/GUISwingConfig.java`)
- Task controller → Dependency config: gets dependencies (evidence: `src/presentation/gui/mainwindow/MainWindowController.java`)
- Task controller → Task operations: invokes (evidence: `src/presentation/gui/mainwindow/MainWindowController.java`)
- Task controller → Discipline operations: invokes (evidence: `src/presentation/gui/mainwindow/MainWindowController.java`)
- Task controller → Main window: updates (evidence: `src/presentation/gui/mainwindow/MainWindowController.java`)
- Main window → Task table model: displays (evidence: `src/presentation/gui/mainwindow/MainWindowView.java`)
- Main window → Discipline controller: opens (evidence: `src/presentation/gui/mainwindow/MainWindowController.java`)
- Discipline controller → Dependency config: gets dependencies (evidence: `src/presentation/gui/discwindow/DisciplinesWindowController.java`)
- Discipline controller → Discipline operations: invokes (evidence: `src/presentation/gui/discwindow/DisciplinesWindowController.java`)
- Discipline controller → Discipline table model: updates (evidence: `src/presentation/gui/discwindow/DisciplinesWindowController.java`)
- Task operations → Task repository port: calls (evidence: `src/domain/usecase/task/GetAllTasksUseCase.java`)
- Discipline operations → Discipline repository port: calls (evidence: `src/domain/usecase/discipline/CreateDisciplineUseCase.java`)
- Discipline operations → Task repository port: queries tasks (evidence: `src/domain/usecase/discipline/RefreshDisciplineStatusUseCase.java`)
- Task repositories → Task repository port: implements (evidence: `src/data/repository/indatabase/InDBTaskRepository.java`)
- Discipline repositories → Discipline repository port: implements (evidence: `src/data/repository/indatabase/InDBDiscipRepository.java`)
- Task repositories → Storage interface: uses (evidence: `src/data/repository/indatabase/InDBTaskRepository.java`)
- Discipline repositories → Storage interface: uses (evidence: `src/data/repository/indatabase/InDBDiscipRepository.java`)
- Task repositories → Storage DTOs: maps data (evidence: `src/data/repository/indatabase/InDBTaskRepository.java`)
- Discipline repositories → Storage DTOs: maps data (evidence: `src/data/repository/indatabase/InDBDiscipRepository.java`)
- Text-file storage → File ID generator: generates IDs (evidence: `src/data/storage/InFileStorage.java`)
- Text-file storage → Storage interface: implements (evidence: `src/data/storage/InFileStorage.java`)
- SQLite storage → Storage interface: implements (evidence: `src/data/storage/SQLiteStorage.java`)
- SQLite storage → Storage DTOs: reads and writes (evidence: `src/data/storage/SQLiteStorage.java`)
- SQLite storage → SQLite database: persists to (evidence: `src/data/storage/SQLiteStorage.java`)
- Task repositories → Task and discipline: maps to (evidence: `src/data/repository/indatabase/InDBTaskRepository.java`)
- Discipline repositories → Task and discipline: maps to (evidence: `src/data/repository/indatabase/InDBDiscipRepository.java`)
- Task operations → Task and discipline: operates on (evidence: `src/domain/usecase/task/GetAllTasksByDisciplineUseCase.java`)
- Discipline operations → Task and discipline: operates on (evidence: `src/domain/usecase/discipline/RefreshDisciplineStatusUseCase.java`)
- Planner user → Discipline window: manages subjects (evidence: `README.md`)
