# kietpham-vn/online-exam-management-system architecture

> Architecture diagram of the GitHub repository kietpham-vn/online-exam-management-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kietpham-vn/online-exam-management-system
- Repository: https://github.com/kietpham-vn/online-exam-management-system

## Overview

##### Main Components

A. Application Layers (Top to Bottom):
- UI Layer (src/ui/)
- Controller Layer (src/controller/)
- Repository Layer (src/repository/)
- Data Layer (src/data/)
- Database Layer (src/db/)

B. Cross-cutting Components:
- Interfaces (src/interfaces/)
- Utilities (src/utils/)

**┌─────────────────────────────────────────────┐**
- UI Layer                    │
- (StartupMenu, AdminMenu, StudentMenu, etc.) │
- ┘
- ↓ ↑
**┌─────────────────────────────────────────────┐**
- Controller Layer                │
- (UserController, ExamExecuter, etc.)     │
- ┘
- ↓ ↑
**┌─────────────────────────────────────────────┐**
- Repository Layer                 │
- (ExamRepository, UserRepository)         │
- ┘
- ↓ ↑
**┌─────────────────────────────────────────────┐**
- Data Layer                     │
- (User, Exam, Question, Grade, etc.)      │
- ┘
- ↓ ↑
**┌─────────────────────────────────────────────┐**
- Database Layer                  │
- (database.java)                 │
- ┘

##### Important Relationships

A. Vertical Relationships:
- UI → Controllers (user actions)
- Controllers → Repositories (data operations)
- Repositories → Database (persistence)

B. Horizontal Relationships:
- Repository implementations → Repository interfaces
- Data model associations (User-Exam-Question relationships)

##### Additional Elements

A. Key Design Patterns:
- Repository Pattern (shown by IExamsRepository and IUserRepository)
- MVC-like structure (separation of UI, Controllers, and Data)

B. Database Schema Overview:
- A simplified version of the database schema (from database/db.sql)
- Main entities: Users, Exams, Questions, Grades

##### Specific Components Detail

A. UI Components:
- Hierarchy: StartupMenu → AdminMenu/StudentMenu/InstructorMenu
- ExamMenu and ExamSubMenu relationships

B. Controller Components:
- Related controllers (Exam-related controllers together)
- Validation flow through ValidationMarks

C. Data Models:
- Relationships between entities (User, Exam, Question, Choice, etc.)
- Aggregation/composition relationships

##### Implementation Notes

- Notes for important design decisions or constraints
- Flow of exam creation, execution, and grading

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI
        Menu["Menu Interface"]
        StartupMenu["Startup Menu"]
        AdminMenu["Admin Menu"]
        StudentMenu["Student Menu"]
        InstructorMenu["Instructor Menu"]
        ExamMenu["Exam Menu"]
        ExamSubMenu["Exam Sub Menu"]
        
        Menu --> StartupMenu
        StartupMenu --> AdminMenu
        StartupMenu --> StudentMenu
        StartupMenu --> InstructorMenu
        AdminMenu --> ExamMenu
        ExamMenu --> ExamSubMenu
    end

    subgraph Controllers
        UserCtrl["User Controller"]
        ExamExec["Exam Executer"]
        CreateExam["Create Exam Controller"]
        UpdateExam["Update Exam Controller"]
        DeleteExam["Delete Exam Controller"]
        Validation["Validation Marks"]
    end

    subgraph Repositories
        IExamRepo["IExams Repository"]
        IUserRepo["IUser Repository"]
        ExamRepo["Exam Repository"]
        UserRepo["User Repository"]
        
        IExamRepo --> ExamRepo
        IUserRepo --> UserRepo
    end

    subgraph DataModels
        User["User Model"]
        Exam["Exam Model"]
        Question["Question Model"]
        Grade["Grade Model"]
        Choice["Choice Model"]
        Subject["Subject Model"]
        StudentExam["Student Exam"]
        StudentAnswer["Student Answer"]
        GradeReport["Grade Report"]
        Teaching["Teaching Model"]
    end

    subgraph Database
        DB["Database Handler"]
        Schema["Database Schema"]
        
        DB --> Schema
    end

    subgraph Utils
        Input["Input Handler"]
        StrProc["String Processor"]
    end

    UI --> Controllers
    Controllers --> Repositories
    Repositories --> DataModels
    DataModels --> Database
    Utils --> UI
    Utils --> Controllers

    %% Click events for component mapping
    click Menu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/Menu.java"
    click StartupMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/StartupMenu.java"
    click AdminMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/AdminMenu.java"
    click StudentMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/StudentMenu.java"
    click InstructorMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/InstructorMenu.java"
    click ExamMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/ExamMenu.java"
    click ExamSubMenu "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/ui/ExamSubMenu.java"
    
    click UserCtrl "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/UserController.java"
    click ExamExec "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/ExamExecuter.java"
    click CreateExam "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/CreateExamController.java"
    click UpdateExam "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/UpdateExamController.java"
    click DeleteExam "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/DeleteExamController.java"
    click Validation "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/controller/ValidationMarks.java"
    
    click IExamRepo "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/interfaces/repository/IExamsRepository.java"
    click IUserRepo "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/interfaces/repository/IUserRepository.java"
    click ExamRepo "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/repository/ExamRepository.java"
    click UserRepo "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/repository/UserRepository.java"
    
    click User "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/User.java"
    click Exam "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Exam.java"
    click Question "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Question.java"
    click Grade "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Grade.java"
    click Choice "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Choice.java"
    click Subject "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Subject.java"
    click StudentExam "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/StudentExam.java"
    click StudentAnswer "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/StudentAnswer.java"
    click GradeReport "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/GradeReport.java"
    click Teaching "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/data/Teach.java"
    
    click DB "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/db/database.java"
    click Schema "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/database/db.sql"
    
    click Input "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/utils/Inputter.java"
    click StrProc "https://github.com/KietPham-VN/Online-Exam-Management-System/blob/main/src/utils/StringProcessor.java"

    classDef ui fill:#e1f5fe,stroke:#01579b
    classDef controller fill:#c8e6c9,stroke:#1b5e20
    classDef repository fill:#ffe0b2,stroke:#e65100
    classDef data fill:#fff9c4,stroke:#f57f17
    classDef database fill:#f5f5f5,stroke:#212121
    classDef utils fill:#ffffff,stroke:#757575
    
    class Menu,StartupMenu,AdminMenu,StudentMenu,InstructorMenu,ExamMenu,ExamSubMenu ui
    class UserCtrl,ExamExec,CreateExam,UpdateExam,DeleteExam,Validation controller
    class IExamRepo,IUserRepo,ExamRepo,UserRepo repository
    class User,Exam,Question,Grade,Choice,Subject,StudentExam,StudentAnswer,GradeReport,Teaching data
    class DB,Schema database
    class Input,StrProc utils
```
