# deepshah232004/budgetmanager architecture

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

- Interactive diagram: https://gitdiagram.com/deepshah232004/budgetmanager
- Repository: https://github.com/deepshah232004/budgetmanager

## Overview

##### Project type and purpose
- This is a standalone Java desktop application (“Budget Tracker Application”) with a Swing-based GUI.
- Purpose: let end users enter incomes and expenses, categorize them, view monthly reports (including pie charts), and save/load data as JSON.

##### File structure
- Top-level directories:
- src/main/model – core domain objects (Budget, Category, TransactionExpense, TransactionIncome, WorkRoom, EventLog).
- src/main/persistence – JSON serialization (JsonReader, JsonWriter).
- src/main/ui – Swing UI entry points (Main, BudgetManagerUI) and tab panels (AddCategory, ExpenseTab, IncomeTab, MonthlyReportTab, PieChartTab).
- data – sample JSON files and docs.
- lib – third-party JARs (JUnit for tests, JFreeChart, JDatePicker, JSON library, SWT, etc.).
- src/test – unit tests for model and persistence.

##### Key architectural patterns and tech stack (from README and file tree)
- Layers: UI layer (Swing), Business Model layer (Budget, Category, Transactions), Persistence layer (JSON reader/writer).
- Observer/Event pattern: EventLog tracks application events.
- Chart generation: JFreeChart for pie charts.
- Build & Checkstyle: checkstyle.xml; IDE project file present.

##### Main components and interactions (
a. Frontend/UI Layer
- Main window (BudgetManagerUI)
- Tab panels: AddCategory, ExpenseTab, IncomeTab, MonthlyReportTab, PieChartTab
- User actions (button clicks, date pickers) → Controller code in BudgetManager/BudgetManagerUI
b. Business Model Layer
- WorkRoom aggregates: BudgetMap, CategoryMap, EventLog, List<TransactionExpense>, List<TransactionIncome>
- Entities: Budget, Category, Expense, Income, Event
- Model classes raise events into EventLog
c. Persistence Layer
- JsonReader and JsonWriter read/write WorkRoom and related maps to JSON files under data/
- Triggered at startup (load data prompt) and shutdown (save data prompt)
d. External Libraries
- JSON-20210307.jar for JSON parsing
- JFreeChart and JDatePicker for charting and date selection
- JUnit libraries for testing (not part of runtime flow but shown as test harness)

##### Architectural patterns & design principles
- Layered architecture: UI → Model → Persistence
- Single Responsibility: each package has one concern (model, persistence, UI)
- Observer/EventLog: decouple event recording from core logic
- Dependency Inversion: UI depends on interfaces of model and persistence

- “BudgetManagerUI / Main”
- “Tabs” (group AddCategory, ExpenseTab, etc.)
- “BudgetManager” (controllers)
- “WorkRoom” & contained maps/entities
- “JsonReader / JsonWriter”
- “JFreeChart” service
- “EventLog”
- UI → Controller (user actions)
- Controller → Model (create/update entities)
- Model → EventLog (record events)
- Controller → Persistence layer (load/save via JSON classes)
- Controller/Model → Chart service (pie chart generation)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer (Blue)
    subgraph "UI Layer" 
        direction TB
        Main["Main"]:::ui
        BudgetManagerUI["BudgetManagerUI"]:::ui
        BudgetManager["BudgetManager"]:::ui
        DateLabelFormatter["DateLabelFormatter"]:::ui
        subgraph "Tabs" 
            direction TB
            Tab["Tab"]:::ui
            AddCategory["AddCategory"]:::ui
            ExpenseTab["ExpenseTab"]:::ui
            IncomeTab["IncomeTab"]:::ui
            MonthlyReportTab["MonthlyReportTab"]:::ui
            PieChartTab["PieChartTab"]:::ui
        end
    end

    %% Business Model Layer (Green)
    subgraph "Model Layer"
        direction TB
        WorkRoom["WorkRoom"]:::model
        Budget["Budget"]:::model
        Category["Category"]:::model
        TransactionExpense["TransactionExpense"]:::model
        Expense["Expense"]:::model
        TransactionIncome["TransactionIncome"]:::model
        Income["Income"]:::model
        BudgetMap["BudgetMap"]:::model
        CategoryMap["CategoryMap"]:::model
        Event["Event"]:::model
        EventLog["EventLog"]:::model
    end

    %% Persistence Layer (Orange)
    subgraph "Persistence Layer"
        direction TB
        JsonReader["JsonReader"]:::persistence
        JsonWriter["JsonWriter"]:::persistence
    end

    %% External Libraries (Gray)
    subgraph "External Libraries"
        direction TB
        JSONLib["JSON-20210307.jar"]:::external
        JFreeChart["JFreeChart"]:::external
        JDatePicker["JDatePicker"]:::external
        JUnit["JUnit"]:::external
    end

    %% Data Files
    DataFiles["Data Files"]:::external
    BudgetJSON["budgetManager.json"]:::external
    WorkRoomJSON["workroom.json"]:::external
    DataFiles --> BudgetJSON
    DataFiles --> WorkRoomJSON

    %% Connections
    Main -->|"launches"| BudgetManagerUI
    BudgetManagerUI -->|"delegates to"| BudgetManager
    BudgetManagerUI -->|"uses"| DateLabelFormatter
    BudgetManager -->|"manages tabs"| AddCategory
    BudgetManager -->|"manages tabs"| ExpenseTab
    BudgetManager -->|"manages tabs"| IncomeTab
    BudgetManager -->|"manages tabs"| MonthlyReportTab
    BudgetManager -->|"manages tabs"| PieChartTab

    AddCategory -->|"calls"| WorkRoom
    ExpenseTab -->|"calls"| WorkRoom
    IncomeTab -->|"calls"| WorkRoom
    MonthlyReportTab -->|"queries transactions"| WorkRoom
    PieChartTab -->|"requests chart"| JFreeChart

    WorkRoom -->|"contains maps"| BudgetMap
    WorkRoom -->|"contains maps"| CategoryMap
    WorkRoom -->|"holds transactions"| TransactionExpense
    WorkRoom -->|"holds transactions"| TransactionIncome
    WorkRoom -->|"records events"| EventLog
    TransactionExpense -->|"is a"| Expense
    TransactionIncome -->|"is a"| Income
    WorkRoom -->|"uses"| Event

    BudgetManager -->|"load/save"| JsonReader
    BudgetManager -->|"load/save"| JsonWriter
    JsonReader -->|"reads from"| DataFiles
    JsonWriter -->|"writes to"| DataFiles

    MonthlyReportTab -->|"generatePieChart(data)"| JFreeChart
    MonthlyReportTab -->|"uses date picker"| JDatePicker

    %% Test Harness (side)
    JUnit 

    %% Click events
    click Main "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/Main.java"
    click BudgetManagerUI "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/BudgetManagerUI.java"
    click BudgetManager "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/BudgetManager.java"
    click DateLabelFormatter "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/DateLabelFormatter.java"
    click Tab "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/Tab.java"
    click AddCategory "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/AddCategory.java"
    click ExpenseTab "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/ExpenseTab.java"
    click IncomeTab "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/IncomeTab.java"
    click MonthlyReportTab "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/MonthlyReportTab.java"
    click PieChartTab "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/ui/tabs/PieChartTab.java"
    click Budget "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/Budget.java"
    click Category "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/Category.java"
    click TransactionExpense "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/TransactionExpense.java"
    click Expense "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/Expense.java"
    click TransactionIncome "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/TransactionIncome.java"
    click Income "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/Income.java"
    click WorkRoom "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/WorkRoom.java"
    click BudgetMap "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/BudgetMap.java"
    click CategoryMap "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/CategoryMap.java"
    click Event "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/Event.java"
    click EventLog "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/model/EventLog.java"
    click JsonReader "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/persistence/JsonReader.java"
    click JsonWriter "https://github.com/deepshah232004/budgetmanager/blob/main/src/main/persistence/JsonWriter.java"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef model fill:#90EE90,stroke:#333,stroke-width:1px
    classDef persistence fill:#FFA500,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
