# snj07/parking-lot-system architecture

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

- Interactive diagram: https://gitdiagram.com/snj07/parking-lot-system
- Repository: https://github.com/snj07/parking-lot-system

## Overview

##### Project type and purpose
- This is a standalone, open-source, command-line Parking Lot system written in Java.
- It reads parking commands (park, leave, status, etc.) from a file or console, processes them in memory, and outputs results.

##### File structure
- Top level: Gradle build files, `Main.java`, JAR, tests.
- src/main/java packages reflect layers:
- constant (static values/messages)
- controller (input ingestion + command execution)
- dao (data handling; in-memory implementation)
- model (domain objects: Car, Vehicle, Driver)
- service (business logic)
- strategy (parking slot allocation strategy)
- observers (publish-subscribe for output collection)
- utils (file reading)
- src/main/resources contains sample input files.
- src/test/java has unit tests.

##### README for additional insights
- Tech stack: Java 8+, Gradle wrapper, JUnit 5.
- No external DB—DAO uses in-memory structures.
- Commands described for running with Gradle or JAR.
- High-level structure matches package layout.

##### Main components & relationships
a. Components:
- External: Input Source (console or file)
- InputController (ConsoleInputController or FileInputController)
- CommandController (parses commands via CommandPatternController)
- Service layer (ParkingLotService)
- Strategy (NearestSlotParkingStrategy implementing ParkingStrategy)
- DAO (ParkingLotDataHandler interface with InMemoryParkingLotHandler)
- Model objects (ParkingLot, Slot, Vehicle, Driver)
- Observers (CommandObservable + console/string output observers)
- Utility (FileUtils)
b. Interactions / Data Flow:
1. Main → selects InputController
2. InputController → reads raw commands → passes to CommandController
3. CommandController → validates against constants → invokes Service
4. Service → employs Strategy to pick slot → calls DAO to create/update models
5. DAO → updates in-memory data structure
6. Service/Controller → notifies registered Observers with results
7. Observers → produce output to console or collect strings
c. Architectural patterns & principles:
- MVC-style separation: controllers ↔ service ↔ data
- Strategy pattern for parking slot allocation
- Observer pattern for output capture
- DAO abstraction for data operations
- Single Responsibility: constants, utils, exceptions isolated
d. Key technologies & frameworks:
- Java 8+
- Gradle wrapper (build & run)
- JUnit 5 for unit tests

##### Detailed breakdown
- Both controllers implementing a common InputController interface.
- CommandPatternController calls ParkingLotService (implements IService).
- Inside ParkingLotService, annotate usage of NearestSlotParkingStrategy.
- ParkingLotService calls ParkingLotDataHandler (interface) → InMemoryParkingLotHandler.
- InMemoryParkingLotHandler updates Model objects (ParkingLot, Slot, Vehicle, Driver).
- Service/Controller register observers with CommandObservable → CommandConsoleOutputObserver and CommandStringOutputStoreObserver.
- FileUtils sits beside FileInputController to show its helper role.
- Constants, Enums, Exception packages can be drawn as supporting libraries around all components.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Main entry
    Main["Main.java"]:::main
    click Main "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/Main.java"

    %% Input Layer
    subgraph "Input Layer"
        IC["InputController"]:::controllers
        CIC["ConsoleInputController"]:::controllers
        FIC["FileInputController"]:::controllers
    end
    click IC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/controller/InputController.java"
    click CIC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/controller/impl/ConsoleInputController.java"
    click FIC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/controller/impl/FileInputController.java"

    %% Controller Layer
    subgraph "Command Controllers"
        CC["CommandController"]:::controllers
        CPC["CommandPatternController"]:::controllers
    end
    click CC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/controller/CommandController.java"
    click CPC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/controller/impl/CommandPatternController.java"

    %% Service Layer
    subgraph "Service Layer"
        SI["IService"]:::service
        PLS["ParkingLotService"]:::service
        NSPS["NearestSlotParkingService"]:::service
    end
    click SI "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/service/IService.java"
    click PLS "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/service/ParkingLotService.java"
    click NSPS "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/service/impl/NearestSlotParkingService.java"

    %% Strategy Layer
    subgraph "Strategy"
        PS["ParkingStrategy"]:::strategy
        NSPSG["NearestSlotParkingStrategy"]:::strategy
    end
    click PS "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/strategy/ParkingStrategy.java"
    click NSPSG "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/strategy/NearestSlotParkingStrategy.java"

    %% DAO & Model Layer
    subgraph "DAO Layer"
        PDH["ParkingLotDataHandler"]:::dao
        IMPL["InMemoryParkingLotHandler"]:::dao
    end
    click PDH "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/dao/ParkingLotDataHandler.java"
    click IMPL "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/dao/impl/InMemoryParkingLotHandler.java"

    subgraph "Model Objects"
        V["Vehicle"]:::model
        C["Car"]:::model
        D["Driver"]:::model
    end
    click V "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/model/Vehicle.java"
    click C "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/model/Car.java"
    click D "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/model/Driver.java"

    %% Observer Layer
    subgraph "Observers"
        CO["CommandObservable"]:::observers
        COI["CommandObserver"]:::observers
        CCOO["CommandConsoleOutputObserver"]:::observers
        CSO["CommandStringOutputStoreObserver"]:::observers
    end
    click CO "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/observers/CommandObservable.java"
    click COI "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/observers/CommandObserver.java"
    click CCOO "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/observers/impl/CommandConsoleOutputObserver.java"
    click CSO "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/observers/impl/CommandStringOuputStoreObserver.java"

    %% Utils & Constants
    subgraph "Utilities & Constants"
        FU["FileUtils"]:::utils
        CCST["CommandConstants"]:::constants
        EM["ErrorMessage"]:::constants
        GC["GlobalConstants"]:::constants
        OM["OutputMessage"]:::constants
    end
    click FU "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/utils/FileUtils.java"
    click CCST "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/constant/CommandConstants.java"
    click EM "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/constant/ErrorMessage.java"
    click GC "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/constant/GlobalConstants.java"
    click OM "https://github.com/snj07/parking-lot-system/blob/master/src/main/java/constant/OutputMessage.java"

    %% Relationships
    Main -->|selects| CIC
    Main -->|selects| FIC
    CIC -->|implements| IC
    FIC -->|implements| IC
    CIC -->|uses| CC
    FIC -->|uses| CC
    CC -->|implements| CC
    CPC -->|implements| CC
    CIC -->|reads| FU
    CIC -->|reads| CCST
    CPC -->|parses| CCST
    CPC -->|invokes| PLS
    PLS -->|implements| SI
    NSPS -->|implements| SI
    PLS -->|uses| PS
    PS -->|implemented by| NSPSG
    PLS -->|calls| PDH
    PDH -->|implemented by| IMPL
    IMPL -->|updates| V
    IMPL -->|updates| C
    IMPL -->|updates| D
    CPC -->|registers| CO
    PLS -->|registers| CO
    CO -->|observes| CCOO
    CO -->|observes| CSO

    %% Styles
    classDef main fill:#ADD8E6,stroke:#000
    classDef controllers fill:#ADD8E6,stroke:#000
    classDef service fill:#90EE90,stroke:#000
    classDef strategy fill:#98FB98,stroke:#000
    classDef dao fill:#FFFFE0,stroke:#000
    classDef model fill:#FFFFE0,stroke:#000
    classDef observers fill:#FFA500,stroke:#000
    classDef utils fill:#D3D3D3,stroke:#000
    classDef constants fill:#D3D3D3,stroke:#000
```
