# rioacosta/s3.03escaperoom architecture

> Architecture diagram of the GitHub repository rioacosta/s3.03escaperoom, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rioacosta/s3.03escaperoom
- Repository: https://github.com/rioacosta/s3.03escaperoom

## Overview

##### Project type and purpose
- This is a monolithic, console-based Java application (“Escape Room Management System”) that uses a layered architecture to manage rooms, hints, decorations, tickets, players and notifications via a MySQL database.

##### File structure
- Top-level artifacts
- pom.xml – Maven build
- src/main/java – source code
- src/main/resources – SQL schema & logging config
- Layers in src/main/java/com/escapeRoom
- controllers – entry point for user actions
- services (named “handlers”) – business logic
- dao – data-access layer with interfaces and MySQL implementations
- entities – domain model (EscapeRoom, Player, Hint, etc.) + enums
- roombuilder – builder pattern for constructing EscapeRoom objects
- notifications – observer pattern (subjects & subscribers)
- manager – MenuManager for console navigation
- utils – common helpers (InputUtils)
- Main.java ties everything together and starts the console UI.

##### README for additional insights
- Technologies: Java 24, Maven, MySQL
- Features: CRUD on rooms, hints, decorations; ticket sales; newsletter notifications; console menus
- Patterns: DAO, Builder, Observer, MVC-style layering

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Main["Main.java"]:::ui
        Menu["MenuManager"]:::ui
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        AppCtrl["AppController"]:::controllers
        RoomCtrl["RoomController"]:::controllers
        PlayerCtrl["PlayerController"]:::controllers
        InvCtrl["InventoryController"]:::controllers
        TicketCtrl["TicketController"]:::controllers
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        ERHandler["EscapeRoomHandler"]:::services
        RoomHandler["RoomHandler"]:::services
        PlayerHandler["PlayerHandler"]:::services
        InvHandler["InventoryHandler"]:::services
        TicketHandler["TicketHandler"]:::services
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        DBConn["DatabaseConnection"]:::dao
        IGeneric["IGenericDAO"]:::dao
        IRoomDao["IRoomDao"]:::dao
        MySQLEscapeDao["MySQLEscaperoomDAO"]:::dao
        MySQLRoomDao["MySQLRoomDAO"]:::dao
        MySQLPlayerDao["MySQLPlayerDAO"]:::dao
        MySQLHintDao["MySQLHintDAO"]:::dao
        MySQLDecoDao["MySQLDecorationDAO"]:::dao
        MySQLTicketDao["MySQLTicketDAO"]:::dao
        MySQLCertDao["MySQLCertificateDAO"]:::dao
    end

    %% Domain Model
    subgraph "Domain Model"
        direction TB
        ER["EscapeRoom"]:::domain
        RoomE["Room"]:::domain
        PlayerE["Player"]:::domain
        HintE["Hint"]:::domain
        DecoE["Decoration"]:::domain
        TicketE["Tickets"]:::domain
        CertE["Certificate"]:::domain
        Collector["RoomInputCollector"]:::domain
        Difficulty["Difficulty"]:::domain
        Theme["Theme"]:::domain
    end

    %% Auxiliary Modules
    subgraph "Auxiliary Modules"
        direction TB
        subgraph "Builder Pattern"
            direction TB
            IRoomBuilder["IRoomBuilder"]:::aux
            ConcreteBuilder["ConcreteBuilder"]:::aux
        end
        subgraph "Notification (Observer)"
            direction TB
            Subscriber["Subscriber"]:::aux
            Newsletter["Newsletter"]:::aux
            NewNewsletter["NewNewsletter"]:::aux
            NewSubscriber["NewSubscriber"]:::aux
        end
    end

    %% Database
    DB[(escaperoomdb)]:::db

    %% Connections
    Main -->|"start()"| Menu
    Menu -->|"selectOption()"| AppCtrl
    AppCtrl -->|"processBusinessLogic()"| ERHandler
    RoomCtrl -->|"processBusinessLogic()"| RoomHandler
    PlayerCtrl -->|"processBusinessLogic()"| PlayerHandler
    InvCtrl -->|"processBusinessLogic()"| InvHandler
    TicketCtrl -->|"processBusinessLogic()"| TicketHandler

    ERHandler -->|"save()/find()"| IGeneric
    RoomHandler -->|"save()/find()"| IRoomDao
    PlayerHandler -->|"save()/find()"| MySQLPlayerDao
    InvHandler -->|"save()/find()"| MySQLHintDao
    InvHandler -->|"save()/find()"| MySQLDecoDao
    TicketHandler -->|"save()/find()"| MySQLTicketDao
    TicketHandler -->|"save()/find()"| MySQLCertDao

    IGeneric -->|"uses"| DBConn
    IRoomDao -->|"uses"| DBConn
    MySQLEscapeDao -->|"execute SQL"| DB
    MySQLRoomDao -->|"execute SQL"| DB
    MySQLPlayerDao -->|"execute SQL"| DB
    MySQLHintDao -->|"execute SQL"| DB
    MySQLDecoDao -->|"execute SQL"| DB
    MySQLTicketDao -->|"execute SQL"| DB
    MySQLCertDao -->|"execute SQL"| DB

    ERHandler -->|"buildRoom()"| IRoomBuilder
    IRoomBuilder -->|"construct()"| ConcreteBuilder
    ConcreteBuilder -->|"returns EscapeRoom"| ER

    ERHandler -->|"publishEvent()"| NewNewsletter
    NewNewsletter -->|"notify()"| NewSubscriber

    %% Click Events
    click Main "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/Main.java"
    click Menu "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/manager/MenuManager.java"
    click AppCtrl "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/controllers/AppController.java"
    click RoomCtrl "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/controllers/RoomController.java"
    click PlayerCtrl "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/controllers/PlayerController.java"
    click InvCtrl "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/controllers/InventoryController.java"
    click TicketCtrl "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/controllers/TicketController.java"
    click ERHandler "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/services/EscapeRoomHandler.java"
    click RoomHandler "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/services/RoomHandler.java"
    click PlayerHandler "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/services/PlayerHandler.java"
    click InvHandler "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/services/InventoryHandler.java"
    click TicketHandler "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/services/TicketHandler.java"
    click DBConn "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/DatabaseConnection.java"
    click IGeneric "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/interfaces/IGenericDAO.java"
    click IRoomDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/interfaces/IRoomDao.java"
    click MySQLEscapeDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLEscaperoomDAO.java"
    click MySQLRoomDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLRoomDAO.java"
    click MySQLPlayerDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLPlayerDAO.java"
    click MySQLHintDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLHintDAO.java"
    click MySQLDecoDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLDecorationDAO.java"
    click MySQLTicketDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLTicketDAO.java"
    click MySQLCertDao "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/dao/mysqlimp/MySQLCertificateDAO.java"
    click ER "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/EscapeRoom.java"
    click RoomE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Room.java"
    click PlayerE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Player.java"
    click HintE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Hint.java"
    click DecoE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Decoration.java"
    click TicketE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Tickets.java"
    click CertE "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/Certificate.java"
    click Collector "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/RoomInputCollector.java"
    click Difficulty "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/enums/Difficulty.java"
    click Theme "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/enums/Theme.java"
    click IRoomBuilder "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/roombuilder/interfaces/IRoomBuilder.java"
    click ConcreteBuilder "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/entities/ConcreteBuilder.java"
    click Subscriber "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/notifications/interfaces/Subscriber.java"
    click Newsletter "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/notifications/interfaces/Newsletter.java"
    click NewNewsletter "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/notifications/concreteSubject/NewNewsletter.java"
    click NewSubscriber "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/notifications/concreteObserver/NewSubscriber.java"
    click InputUtils "https://github.com/rioacosta/s3.03escaperoom/blob/master/src/main/java/com/escapeRoom/utils/InputUtils.java"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#000;
    classDef controllers fill:#D0FFD0,stroke:#000;
    classDef services fill:#FFF0B3,stroke:#000;
    classDef dao fill:#FFC680,stroke:#000;
    classDef db fill:#D3D3D3,stroke:#000;
    classDef aux fill:#E0B3FF,stroke:#000;
    classDef domain fill:#F0F0F0,stroke:#000;
```
