# djfcoder/sales-sync-gui architecture

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

- Interactive diagram: https://gitdiagram.com/djfcoder/sales-sync-gui
- Repository: https://github.com/djfcoder/sales-sync-gui

## Overview

##### Main Components
- Frontend (User Interface): Representing the Swing UI layer, including the Login screen, Main Dashboard, and various forms (e.g., SalesForm, CustomersForm, ExpensesForm). Indicate that FlatLaf is used as the look-and-feel library.
- Controllers: The “controller” package handles the input from user interfaces and delegates actions. List each controller (e.g., CustomerController, ExpenseController, etc.) to indicate the entry points from the UI.
- Services (Business Logic Layer): The “service” package encapsulates the business rules (CustomerService, ExpenseService, etc.). These services process data coming from controllers and coordinate interactions with the data access layer.
- Data Access Layer (DAO): The “dao” package contains DAO classes that abstract database operations (e.g., CustomerDAO, ExpenseDAO, etc.). This layer interacts with the underlying MySQL database through JPA/Hibernate.
- Model/Entities: The “model” package contains the entities (e.g., Customer, Sale, Expense, etc.) representing the data structures stored in the database.
- Utilities: The “util” package includes helper classes like HibernateUtil, CSVExporter, and UserSession that support various cross-cutting concerns.
- Database: Symbolize the MySQL database that persists all data, using configurations from persistence.xml and scripts located in the “resources/db” directory.
- External Libraries: Highlight the key technologies (e.g., Java 17, Hibernate, MySQL Connector, JBCrypt for security) that integrate within the system.

##### Relationships and Data Flow
- That each Controller forwards the request to an appropriate Service, which contains the business logic.
- Optionally, include flows for security (e.g., BCrypt for password hashing) to be applied during authentication in the login process.
- Utility classes as supportive components that are called by both the service and perhaps controller layers as needed.

##### Architectural Patterns and Design Principles
- Model-View-Controller (MVC) pattern: Models represent data, Views are built using Swing, and Controllers manage user interaction.
- Point out the layered architecture: Presentation (View), Business (Service), and Data Access Layers (DAO).
- Separation of concerns; each package has a dedicated purpose: controllers for input, services for logic, DAOs for persistence, and models for data.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        UI1["Swing UI"]:::frontend
        UI_Login["Login Screen"]:::frontend
        UI_Main["Main Dashboard"]:::frontend
        UI_Forms["Forms (Sales, Customers, Expenses, etc.)"]:::frontend
    end

    %% Controller Layer
    subgraph "Controller Layer"
        C_Customer["CustomerController"]:::controller
        C_Expense["ExpenseController"]:::controller
        C_Log["LogController"]:::controller
        C_Report["ReportController"]:::controller
        C_Sale["SaleController"]:::controller
        C_ServiceOrder["ServiceOrderController"]:::controller
        C_User["UserController"]:::controller
    end

    %% Service Layer
    subgraph "Service Layer"
        S_Customer["CustomerService"]:::service
        S_Expense["ExpenseService"]:::service
        S_Log["LogService"]:::service
        S_Report["ReportService"]:::service
        S_Sale["SaleService"]:::service
        S_ServiceOrder["ServiceOrderService"]:::service
        S_User["UserService"]:::service
    end

    %% Data Access Layer (DAO)
    subgraph "Data Access Layer (DAO)"
        D_Customer["CustomerDAO"]:::dao
        D_Expense["ExpenseDAO"]:::dao
        D_Sale["SaleDAO"]:::dao
        D_SaleItem["SaleItemDAO"]:::dao
        D_ServiceOrder["ServiceOrderDAO"]:::dao
        D_SystemLog["SystemLogDAO"]:::dao
        D_User["UserDAO"]:::dao
        D_ExpenseCategory["ExpenseCategoryDAO"]:::dao
        D_DAO["DAO (Generic)"]:::dao
    end

    %% Model/Entities Layer
    subgraph "Model Layer"
        M_Customer["Customer"]:::model
        M_Expense["Expense"]:::model
        M_Sale["Sale"]:::model
        M_SaleItem["SaleItem"]:::model
        M_ServiceOrder["ServiceOrder"]:::model
        M_SystemLog["SystemLog"]:::model
        M_User["User"]:::model
    end

    %% Utilities Layer
    subgraph "Utilities"
        U_CSV["CSVExporter"]:::util
        U_Hibernate["HibernateUtil"]:::util
        U_UserSession["UserSession"]:::util
    end

    %% Database
    subgraph "Database"
        DB["MySQL Database"]:::database
        DB_Config["persistence.xml"]:::database
        DB_Scripts["Database Scripts"]:::database
    end

    %% External Libraries & Configurations
    subgraph "External Libraries"
        EX_POM["pom.xml"]:::external
        EX_Info["Java17, Hibernate, MySQLConnector, JBCrypt, FlatLaf"]:::external
    end

    %% Relationships: Presentation Layer to Controllers
    UI_Login -->|"triggers"| C_Log
    UI_Main -->|"navigates"| C_User
    UI_Forms -->|"submits data"| C_Customer
    UI_Forms -->|"submits data"| C_Expense
    UI_Forms -->|"submits data"| C_Sale
    UI_Forms -->|"submits data"| C_ServiceOrder
    UI_Forms -->|"submits data"| C_Report

    %% Controllers call Services
    C_Customer --> S_Customer
    C_Expense --> S_Expense
    C_Log --> S_Log
    C_Report --> S_Report
    C_Sale --> S_Sale
    C_ServiceOrder --> S_ServiceOrder
    C_User --> S_User

    %% Services use DAOs
    S_Customer --> D_Customer
    S_Expense --> D_Expense
    S_Log --> D_SystemLog
    S_Report --> D_DAO
    S_Sale --> D_Sale
    S_ServiceOrder --> D_ServiceOrder
    S_User --> D_User

    %% DAO interactions with Database
    D_Customer --> DB
    D_Expense --> DB
    D_Sale --> DB
    D_SaleItem --> DB
    D_ServiceOrder --> DB
    D_SystemLog --> DB
    D_User --> DB
    D_ExpenseCategory --> DB
    D_DAO --> DB

    %% Utilities support various layers
    U_Hibernate ---|"ORM mapping"| DB
    U_CSV ---|"data export"| S_Report
    U_UserSession ---|"manages session"| C_Log

    %% External libraries integration
    EX_Info ---|"FlatLaf for UI"| UI_Forms
    EX_Info ---|"Hibernate ORM"| U_Hibernate
    EX_POM ---|"build config"| EX_Info
    EX_POM --- DB_Config
    DB_Config --> DB
    DB_Scripts --> DB

    %% Styles
    classDef frontend fill:#f9c,stroke:#333,stroke-width:2px;
    classDef controller fill:#bbf,stroke:#333,stroke-width:2px;
    classDef service fill:#bfb,stroke:#333,stroke-width:2px;
    classDef dao fill:#ffd,stroke:#333,stroke-width:2px;
    classDef model fill:#fdd,stroke:#333,stroke-width:2px;
    classDef util fill:#dfd,stroke:#333,stroke-width:2px;
    classDef database fill:#fd9,stroke:#333,stroke-width:2px;
    classDef external fill:#9ff,stroke:#333,stroke-width:2px;

    %% Click Events
    click UI_Login "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/view/Login.java"
    click UI_Main "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/view/MainAppView.java"
    click UI_Forms "https://github.com/djfcoder/sales-sync-gui/tree/master/src/main/java/br/com/devjf/salessync/view/forms"
    
    click C_Customer "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/CustomerController.java"
    click C_Expense "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/ExpenseController.java"
    click C_Log "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/LogController.java"
    click C_Report "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/ReportController.java"
    click C_Sale "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/SaleController.java"
    click C_ServiceOrder "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/ServiceOrderController.java"
    click C_User "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/controller/UserController.java"
    
    click S_Customer "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/CustomerService.java"
    click S_Expense "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/ExpenseService.java"
    click S_Log "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/LogService.java"
    click S_Report "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/ReportService.java"
    click S_Sale "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/SaleService.java"
    click S_ServiceOrder "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/ServiceOrderService.java"
    click S_User "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/service/UserService.java"
    
    click D_Customer "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/CustomerDAO.java"
    click D_Expense "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/ExpenseDAO.java"
    click D_Sale "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/SaleDAO.java"
    click D_SaleItem "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/SaleItemDAO.java"
    click D_ServiceOrder "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/ServiceOrderDAO.java"
    click D_SystemLog "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/SystemLogDAO.java"
    click D_User "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/UserDAO.java"
    click D_ExpenseCategory "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/ExpenseCategoryDAO.java"
    click D_DAO "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/dao/DAO.java"
    
    click M_Customer "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/Customer.java"
    click M_Expense "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/Expense.java"
    click M_Sale "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/Sale.java"
    click M_SaleItem "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/SaleItem.java"
    click M_ServiceOrder "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/ServiceOrder.java"
    click M_SystemLog "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/SystemLog.java"
    click M_User "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/model/User.java"
    
    click U_CSV "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/util/CSVExporter.java"
    click U_Hibernate "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/util/HibernateUtil.java"
    click U_UserSession "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/java/br/com/devjf/salessync/util/UserSession.java"
    
    click DB_Config "https://github.com/djfcoder/sales-sync-gui/blob/master/src/main/resources/META-INF/persistence.xml"
    click DB_Scripts "https://github.com/djfcoder/sales-sync-gui/tree/master/src/main/resources/db"
    
    click EX_POM "https://github.com/djfcoder/sales-sync-gui/blob/master/pom.xml"
```
