# deathzill/cs151-library-management-system-gamers architecture

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

- Interactive diagram: https://gitdiagram.com/deathzill/cs151-library-management-system-gamers
- Repository: https://github.com/deathzill/cs151-library-management-system-gamers

## Overview

##### Project Type & Purpose
- This is a full-stack, desktop Java application (Library Management System) with a Swing-based GUI (“frontend”) and core Java classes handling business logic and data persistence (“backend”). It uses Maven for build/dependency management and JSON files for runtime data storage.

##### File-Structure Analysis
- Top-level:
- src/main/java/frontend → user-interface classes (LibraryUI, custom Exceptions)
- src/main/java/backend → domain model & services (Book, User, Patron, Librarian, Tables, Searchable, Borrowable)
- src/test → unit tests for backend
- src/pom.xml → Maven configuration
- out/artifacts → packaged JAR
- This separation signals an MVC-style layering (UI vs domain logic vs persistence).

##### README Insights
- Distinguishes “Patron” and “Librarian” user roles.
- Data persistence via JSON.
- Key features: authentication, book management, search/filter, JSON-based database.
- Uses JDK 19, Swing (LibraryUI), Maven.

a. Main Components
1. Frontend/UI Layer
- LibraryUI class (Swing windows, panels, menus)
- Validation Exceptions (email/password rules)
2. Application/Service Layer
- Controllers (LibraryUI calls backend methods)
- Domain objects: User ← Patron/Librarian, Book
- Tables class (manages in-memory collections & JSON I/O)
3. Persistence Layer
- JSON files (books.json, users.json)
- JSON read/write via Tables
4. External/Infrastructure
- Maven build system
- JUnit tests (for backend)
- .jar packaging
b. Relationships & Data Flow
- User interacts with LibraryUI → UI invokes service methods on Tables, Patron, Librarian.
- Tables reads JSON at startup → populates in-memory collections.
- Operations (add/remove/search/checkout/return) update in-memory state → Tables writes JSON on each change or at shutdown.
- Authentication flow: LibraryUI → UserService (in Tables) → validation exceptions → domain creation.
c. Architectural Patterns & Principles
- Layered Architecture (UI → Business Logic → Persistence)
- MVC-style separation (LibraryUI is “View+Controller”, backend domain + Tables are “Model”)
- Single Responsibility (each exception class handles one validation rule).
- Dependency Injection is manual: UI directly instantiates backend objects.
d. Technologies & Frameworks
- Java 19, Swing (AWT)
- Maven (pom.xml)
- JSON (e.g., Gson or Jackson—depending on Tables implementation)
- JUnit 4 for testing

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        UI["LibraryUI"]:::ui
        EX1["EmailException"]:::ui
        EX2["AtSignMissingException"]:::ui
        EX3["PeriodMissingException"]:::ui
        EX4["PasswordException"]:::ui
        EX5["LowerCaseCharacterMissing"]:::ui
        EX6["UpperCaseCharacterMissing"]:::ui
        EX7["NumberCharacterMissing"]:::ui
        EX8["SpecialCharacterMissing"]:::ui
        EX9["Minimum8CharactersRequired"]:::ui
    end

    %% Domain Layer
    subgraph "Domain Layer"
        User["User"]:::domain
        Patron["Patron"]:::domain
        Librarian["Librarian"]:::domain
        Book["Book"]:::domain
        Searchable["Searchable"]:::domain
        Borrowable["Borrowable"]:::domain
        Tables["Tables (JSON I/O & in-memory)"]:::domain
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        JSON["books.json & users.json"]:::persistence
    end

    %% External/Infrastructure
    subgraph "External/Infrastructure"
        Maven["pom.xml"]:::external
        JAR["Packaged JAR"]:::external
        subgraph "JUnit Tests"
            BookTest["BookTest"]:::external
            UserTest["UserTest"]:::external
            PatronTest["PatronTest"]:::external
            LibrarianTest["LibrarianTest"]:::external
            TablesTest["TablesTest"]:::external
        end
        subgraph "Documentation & UML"
            README["README.md"]:::external
            Proposal["Proposal/README.md"]:::external
            UML["diagrams/"]:::external
        end
    end

    %% Relationships
    UI -->|"login(), search(), checkout(), return()"| Tables
    UI -->|"throws validation" | EX1
    UI --> EX2
    UI --> EX3
    UI --> EX4
    UI --> EX5
    UI --> EX6
    UI --> EX7
    UI --> EX8
    UI --> EX9

    Patron -->|extends| User
    Librarian -->|extends| User
    Book -->|implements| Searchable
    Patron -->|implements| Borrowable
    Tables -->|"reads/writes JSON"| JSON

    User --> Tables
    Patron --> Tables
    Librarian --> Tables

    Maven -->|builds| JAR
    Tables -->|tested by| BookTest
    Tables -->|tested by| UserTest
    Tables -->|tested by| PatronTest
    Tables -->|tested by| LibrarianTest
    Tables -->|tested by| TablesTest

    %% Click Events
    click UI "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/LibraryUI.java"
    click EX1 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/EmailException.java"
    click EX2 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/AtSignMissingException.java"
    click EX3 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/PeriodMissingException.java"
    click EX4 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/PasswordException.java"
    click EX5 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/LowerCaseCharacterMissing.java"
    click EX6 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/UpperCaseCharacterMissing.java"
    click EX7 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/NumberCharacterMissing.java"
    click EX8 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/SpecialCharacterMissing.java"
    click EX9 "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/frontend/Minimum8CharactersRequired.java"

    click User "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/User.java"
    click Patron "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Patron.java"
    click Librarian "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Librarian.java"
    click Book "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Book.java"
    click Searchable "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Searchable.java"
    click Borrowable "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Borrowable.java"
    click Tables "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/main/java/backend/Tables.java"

    click Maven "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/pom.xml"
    click JAR "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/out/artifacts/CS151_Library_Management_System_Gamers_jar/CS151-Library-Management-System-Gamers.jar"

    click BookTest "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/test/BookTest.java"
    click UserTest "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/test/UserTest.java"
    click PatronTest "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/test/PatronTest.java"
    click LibrarianTest "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/test/LibrarianTest.java"
    click TablesTest "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/src/test/TablesTest.java"

    click README "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/README.md"
    click Proposal "https://github.com/deathzill/cs151-library-management-system-gamers/blob/main/Proposal/README.md"
    click UML "https://github.com/deathzill/cs151-library-management-system-gamers/tree/main/diagrams/"

    %% Styles
    classDef ui fill:#D0E4FD,stroke:#1E70BF,color:#000
    classDef domain fill:#E2F0D9,stroke:#4CAF50,color:#000
    classDef persistence fill:#FDE9D0,stroke:#FB8C00,color:#000
    classDef external fill:#F3F3F3,stroke:#999,color:#000,stroke-dasharray: 5 5
```
