# sathvikpm/onifoods architecture

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

- Interactive diagram: https://gitdiagram.com/sathvikpm/onifoods
- Repository: https://github.com/sathvikpm/onifoods

## Overview

- The Web Layer (View) is represented by the JSP files found in the src/main/webapp directory (e.g., Login.jsp, Signup.jsp, cart.jsp, orderSuccess.jsp). These elements provide the user interface and handle session-based interactions.

- The Controller Layer is implemented with multiple Servlets (found in the src/main/java/com/tap/controller directory), such as CartServlet, LoginServlet, MenuServlet, OrderServlet, RestaurantServlet, and SignUpServlet. They process incoming HTTP requests, manage session information, and coordinate with the business and database layers.

- The Data Access Layer is split into DAO interfaces and their concrete implementations (located in the src/main/java/com/tap/dao and daoImp directories). This layer handles all interactions with the database (MySQL) via JDBC, ensuring a clean separation between the business logic and persistence logic.

- The Domain Model is defined by the Java classes under src/main/java/com/tap/model. These classes (User, Restaurant, Menu, Order, OrderHistory, Cart, CartItem, etc.) represent the various entities central to the application's business logic.

##### Main components
- Web Client Layer: Show end-user devices accessing the application, which display web pages (JSPs).
- Web Server/Application Server: This component (typically a Servlet container like Tomcat) hosts the web application.
- Controller Components: Illustrate each Servlet (Login, Signup, Menu, Cart, Order, Restaurant controllers) as entry points to the application logic.
- Business/Data Access Layer: Detail the DAO and DAO implementation classes that encapsulate database operations.
- Domain Model: Represent the key model entities (User, Restaurant, Menu, Order, etc.), showing that these objects flow between controllers and DAOs.
- Database: Represent the MySQL database that holds the persistent application data.
- External Libraries: Optionally illustrate tools like the MySQL Connector/J (included in WEB-INF/lib) and possibly the JDBC mechanism as a link to the database.

##### Relationships and interactions
- Controllers as the intermediaries intercepting HTTP requests (from JSP forms or links) and coordinating with the Business/Data Access Layer.
- That Controllers invoke methods on the DAOs to query or update the MySQL database.
- If applicable, include components for user authentication and admin dashboard features as noted in the README.

##### Architectural patterns and design principles
- MVC paradigm: Clearly separate the front-end JSP views, back-end controllers (servlets), and data handling via models and DAOs.
- Layered architecture: Emphasize that each layer (presentation, controller, data access, and database) operates independently and communicates through defined interfaces.
- Modularity: Each servlet, DAO, and model represents a distinct module, which makes the system both testable and extendable. For instance, the test classes found under daoImp (like OrderHistoryDaoTest and OrderItemDaoTest) show efforts in modular testing.

##### Relevant technologies
- Java, Servlets for dynamic web operations.
- JDBC as the database connectivity framework.
- MySQL for persistent storage.
- HTML/JSP and CSS for frontend design.
- External libraries like the MySQL Connector/J.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Client
    Client["User Browser"]:::client

    %% Presentation Layer
    subgraph "Presentation Layer"
        JSPViews["JSP Views"]:::frontend
    end

    %% Controller Layer
    subgraph "Controller Layer"
        LoginServlet["LoginServlet"]:::controller
        SignUpServlet["SignUpServlet"]:::controller
        MenuServlet["MenuServlet"]:::controller
        CartServlet["CartServlet"]:::controller
        OrderServlet["OrderServlet"]:::controller
        RestaurantServlet["RestaurantServlet"]:::controller
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        subgraph "DAO Interfaces"
            MenuDao["MenuDao"]:::dao
            OrderDao["OrderDao"]:::dao
            OrderHistoryDao["OrderHistoryDao"]:::dao
            OrderItemDao["OrderItemDao"]:::dao
            RestaurantDao["RestaurantDao"]:::dao
            UserDao["UserDao"]:::dao
        end
        subgraph "DAO Implementations"
            MenuDaoI["MenuDaoI"]:::daoImp
            OrderDaoI["OrderDaoI"]:::daoImp
            OrderHistoryDaoI["OrderHistoryDaoI"]:::daoImp
            OrderItemDaoI["OrderItemDaoI"]:::daoImp
            RestaurantDaoI["RestaurantDaoI"]:::daoImp
            UserDaoI["UserDaoI"]:::daoImp
            TestDAOs["DAO Tests"]:::daoImp
        end
    end

    %% Domain Model Layer
    subgraph "Domain Model"
        Cart["Cart"]:::model
        CartItem["CartItem"]:::model
        Menu["Menu"]:::model
        Order["Order"]:::model
        OrderHistory["OrderHistory"]:::model
        OrderItem["OrderItem"]:::model
        Restaurant["Restaurant"]:::model
        User["User"]:::model
    end

    %% External Systems
    DB["MySQL Database"]:::database
    Lib["MySQL Connector/J"]:::lib

    %% Connections
    Client -->|"HTTP_Request"| JSPViews

    JSPViews -->|"submitsRequest"| LoginServlet
    JSPViews -->|"submitsRequest"| SignUpServlet
    JSPViews -->|"submitsRequest"| MenuServlet
    JSPViews -->|"submitsRequest"| CartServlet
    JSPViews -->|"submitsRequest"| OrderServlet
    JSPViews -->|"submitsRequest"| RestaurantServlet

    LoginServlet -->|"calls"| UserDao
    SignUpServlet -->|"calls"| UserDao
    MenuServlet -->|"calls"| MenuDao
    CartServlet -->|"calls"| OrderDao
    OrderServlet -->|"calls"| OrderDao
    RestaurantServlet -->|"calls"| RestaurantDao

    UserDao -->|"implementedBy"| UserDaoI
    MenuDao -->|"implementedBy"| MenuDaoI
    OrderDao -->|"implementedBy"| OrderDaoI
    RestaurantDao -->|"implementedBy"| RestaurantDaoI
    OrderHistoryDao -->|"implementedBy"| OrderHistoryDaoI
    OrderItemDao -->|"implementedBy"| OrderItemDaoI

    UserDaoI -->|"executesQueryOn"| DB
    MenuDaoI -->|"executesQueryOn"| DB
    OrderDaoI -->|"executesQueryOn"| DB
    RestaurantDaoI -->|"executesQueryOn"| DB
    OrderHistoryDaoI -->|"executesQueryOn"| DB
    OrderItemDaoI -->|"executesQueryOn"| DB

    %% Domain Model Flow (used by controllers and DAOs)
    LoginServlet ---|"handlesUser"| User
    SignUpServlet ---|"handlesUser"| User
    MenuServlet ---|"usesModel"| Menu
    CartServlet ---|"usesModel"| Cart
    CartServlet ---|"usesModel"| CartItem
    OrderServlet ---|"usesModel"| Order
    OrderServlet ---|"usesModel"| OrderItem
    RestaurantServlet ---|"usesModel"| Restaurant
    OrderDaoI ---|"mapsTo"| OrderHistory
    OrderDaoI ---|"mapsTo"| OrderItem

    %% External Library supports JDBC communication
    Lib -->|"JDBC_Driver"| DB

    %% Click Events
    click JSPViews "https://github.com/sathvikpm/onifoods/tree/main/Onifood/src/main/webapp"
    click LoginServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/LoginServlet.java"
    click SignUpServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/SignUpServlet.java"
    click MenuServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/MenuServlet.java"
    click CartServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/CartServlet.java"
    click OrderServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/OrderServlet.java"
    click RestaurantServlet "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/controller/RestaurantServlet.java"
    click MenuDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/MenuDao.java"
    click OrderDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/OrderDao.java"
    click OrderHistoryDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/OrderHistoryDao.java"
    click OrderItemDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/OrderItemDao.java"
    click RestaurantDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/RestaurantDao.java"
    click UserDao "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/dao/UserDao.java"
    click MenuDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/MenuDaoI.java"
    click OrderDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/OrderDaoI.java"
    click OrderHistoryDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/OrderHistoryDaoI.java"
    click OrderItemDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/OrderItemDaoI.java"
    click RestaurantDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/RestaurantDaoI.java"
    click UserDaoI "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/daoImp/UserDaoI.java"
    click TestDAOs "https://github.com/sathvikpm/onifoods/tree/main/Onifood/src/main/java/com/tap/daoImp"
    click Cart "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/Cart.java"
    click CartItem "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/CartItem.java"
    click Menu "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/Menu.java"
    click Order "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/Order.java"
    click OrderHistory "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/OrderHistory.java"
    click OrderItem "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/OrderItem.java"
    click Restaurant "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/Restaurant.java"
    click User "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/java/com/tap/model/User.java"
    click Lib "https://github.com/sathvikpm/onifoods/blob/main/Onifood/src/main/webapp/WEB-INF/lib/mysql-connector-j-9.1.0.jar"

    %% Styles
    classDef frontend fill:#FFCC99,stroke:#000,stroke-width:2px,font-size:12px;
    classDef controller fill:#CCFFCC,stroke:#000,stroke-width:2px;
    classDef dao fill:#CCFFFF,stroke:#000,stroke-width:2px;
    classDef daoImp fill:#99CCFF,stroke:#000,stroke-width:2px;
    classDef model fill:#FFCCCC,stroke:#000,stroke-width:2px;
    classDef database fill:#FFFF99,stroke:#000,stroke-width:2px;
    classDef lib fill:#CCCCFF,stroke:#000,stroke-width:2px;
    classDef client fill:#EFEFEF,stroke:#000,stroke-width:2px;
```
