# nhviet03/java_project_restaurantms architecture

> Architecture diagram of the GitHub repository nhviet03/java_project_restaurantms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nhviet03/java_project_restaurantms
- Repository: https://github.com/nhviet03/java_project_restaurantms

## Overview

##### Project type and purpose
- This is a desktop, full-featured “Restaurant Management System” written in Java using JavaSwing for the GUI.
- It follows an MVC-style, layered architecture to manage customers, staff (including warehouse and admin roles), menu, orders, billing, inventory, and reporting.
- It connects to an Oracle database (via JDBC/ojdbc8.jar) for persistent storage and uses external libraries for exporting Excel, PDF, emailing, calendar components, etc.

##### File structure
- Top-level folders:
- src/RTDRestaurant/Model – domain model classes.
- src/RTDRestaurant/Controller – contains Connection (DatabaseConnection), Event (UI event handlers), Service (business-logic and utility services).
- src/RTDRestaurant/View – JavaSwing UI components, dialogs, forms, and main frames, organized by user role (Customer, Staff, Admin, Warehouse, Login/Register).
- src/DataBase – the Database.sql script.
- src/External_Library – third-party JARs (Excel, PDF, mail, layout, JDBC).

##### Key insights from README
- Three main user personas: Customer, Staff (including Receptionist, Warehouse, Admin).
- Functional layers: UI (JavaSwing), controllers, services, DB.
- ERD exists: multiple tables for Users, MenuItems, Orders, Invoices, Inventory, etc.
- Uses JDK 17, Oracle database.

##### Elements
- UI → Controller/Event → Service → DatabaseConnection → Oracle DB
- Service → External Library (for exports/email)
- Models returned back up the chain for rendering in the UI
- Presentation Layer (blue), Controller Layer (green), Service Layer (yellow), Data Access (orange), Database (red), External Libraries (gray)

##### Final recommendations
- User-role UIs and major feature flows (login, order process, inventory management, reporting).
- Detail the service classes that drive each major functional area (e.g., ServiceAdmin for reporting).
- Refer to the ERD as a separate inset or callout to show database structure in more detail.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer" 
        direction TB
        subgraph "Login/Register UI" 
            direction TB
            MainLogin["Main_LoginAndRegister"]:::presentation
            PanelLogin["PanelLoginAndRegister"]:::presentation
            PanelVerify["PanelVerifyCode"]:::presentation
            PanelCover["PanelCover"]:::presentation
            PanelLoading["PanelLoading"]:::presentation
            MessageUI["Message"]:::presentation
        end
        subgraph "Customer UI"
            direction TB
            CustMain["Main_Customer_Frame"]:::presentation
            CustMenuComp["Menu"]:::presentation
            CardBan["CardBan"]:::presentation
            CardMonAn["CardMonAn"]:::presentation
            CardVoucher["CardVoucher"]:::presentation
        end
        subgraph "Staff UI"
            direction TB
            StaffMain["Main_Staff_Frame"]:::presentation
            StaffMenuComp["MenuS"]:::presentation
            CardBanS["CardBanS"]:::presentation
        end
        subgraph "Admin UI"
            direction TB
            AdminMain["Main_Admin_Frame"]:::presentation
            AdminMenuComp["MenuA"]:::presentation
            CardAdmin["Card"]:::presentation
        end
        subgraph "Warehouse UI"
            direction TB
            WarehouseMain["Main_WarehouseStaff_Frame"]:::presentation
            WarehouseMenuComp["MenuStaff"]:::presentation
        end
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        DatabaseConn["DatabaseConnection"]:::controller
        EventMenu["EventMenu"]:::controller
        EventMenuSel["EventMenuSelected"]:::controller
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        ServiceUser["ServiceUser"]:::service
        ServiceCust["ServiceCustomer"]:::service
        ServiceStaff["ServiceStaff"]:::service
        ServiceAdmin["ServiceAdmin"]:::service
        ServiceMail["ServiceMail"]:::service
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        DBConnAccess["DatabaseConnection"]:::dataaccess
    end

    %% Database
    OracleDB["Oracle DB"]:::database

    %% External Libraries
    subgraph "External Libraries"
        direction TB
        EasyXLS["EasyXLS.jar"]:::external
        PDFBox["pdfbox-app-2.0.28.jar"]:::external
        JavaMail["javax.mail.jar"]:::external
        JCalendar["jcalendar-1.4.jar"]:::external
        MigLayout["miglayout-4.0.jar"]:::external
        Timing["TimingFramework-0.55.jar"]:::external
        JDBCJar["ojdbc8.jar"]:::external
    end

    %% Connections
    MainLogin -->|triggers| EventMenu
    PanelLogin -->|triggers| EventMenu
    CustMain -->|triggers| EventMenu
    StaffMain -->|triggers| EventMenu
    AdminMain -->|triggers| EventMenu
    WarehouseMain -->|triggers| EventMenu

    EventMenu -->|selects menu| EventMenuSel
    EventMenuSel -->|calls| ServiceUser
    EventMenuSel -->|calls| ServiceCust
    EventMenuSel -->|calls| ServiceStaff
    EventMenuSel -->|calls| ServiceAdmin

    ServiceUser -->|uses| DBConnAccess
    ServiceCust -->|uses| DBConnAccess
    ServiceStaff -->|uses| DBConnAccess
    ServiceAdmin -->|uses| DBConnAccess
    ServiceMail -->|uses| JavaMail

    DBConnAccess -->|executes SQL| OracleDB

    ServiceAdmin -->|export reports| EasyXLS
    ServiceAdmin -->|generate PDF| PDFBox
    ServiceAdmin -->|schedule tasks| Timing
    ServiceAdmin -->|calendar| JCalendar
    ServiceCust -->|layout| MigLayout

    %% Click Events
    click MainLogin "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Main_Frame/Main_LoginAndRegister.java"
    click PanelLogin "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/LoginAndRegister_Component/PanelLoginAndRegister.java"
    click PanelVerify "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/LoginAndRegister_Component/PanelVerifyCode.java"
    click PanelCover "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/LoginAndRegister_Component/PanelCover.java"
    click PanelLoading "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/LoginAndRegister_Component/PanelLoading.java"
    click MessageUI "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/LoginAndRegister_Component/Message.java"
    click CustMain "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Main_Frame/Main_Customer_Frame.java"
    click CustMenuComp "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/Customer_Component/Menu.java"
    click StaffMain "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Main_Frame/Main_Staff_Frame.java"
    click StaffMenuComp "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/Staff_Component/MenuS.java"
    click AdminMain "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Main_Frame/Main_Admin_Frame.java"
    click AdminMenuComp "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/Admin_Component/MenuA.java"
    click WarehouseMain "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Main_Frame/Main_WarehouseStaff_Frame.java"
    click WarehouseMenuComp "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/View/Component/WarehouseStaff_Component/MenuStaff.java"
    click DatabaseConn "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Connection/DatabaseConnection.java"
    click EventMenu "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Event/EventMenu.java"
    click EventMenuSel "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Event/EventMenuSelected.java"
    click ServiceUser "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Service/ServiceUser.java"
    click ServiceCust "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Service/ServiceCustomer.java"
    click ServiceStaff "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Service/ServiceStaff.java"
    click ServiceAdmin "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Service/ServiceAdmin.java"
    click ServiceMail "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Service/ServiceMail.java"
    click DBConnAccess "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/RTDRestaurant/Controller/Connection/DatabaseConnection.java"
    click OracleDB "https://github.com/nhviet03/java_project_restaurantms/blob/main/src/DataBase/Database.sql"

    %% Styles
    classDef presentation fill:#D6EAF8,stroke:#21618C,color:#1B4F72
    classDef controller fill:#D5F5E3,stroke:#196F3D,color:#145A32
    classDef service fill:#FCF3CF,stroke:#B7950B,color:#7D6608
    classDef dataaccess fill:#FADBD8,stroke:#C0392B,color:#78281F
    classDef database fill:#F5B7B1,stroke:#922B21,color:#641E16
    classDef external fill:#E5E7E9,stroke:#566573,color:#1B2631
```
