# dp2-c1-037/acme-ans-d03 architecture

> Architecture diagram of the GitHub repository dp2-c1-037/acme-ans-d03, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dp2-c1-037/acme-ans-d03
- Repository: https://github.com/dp2-c1-037/acme-ans-d03

## Overview

##### Project Type and Purpose
- The project is a full-stack Java web application that manages airport operations for charter flights.
- Its purpose is to assist airports in handling aspects such as flight scheduling, bookings, crew assignments, incident reporting, and aircraft maintenance.
- The README emphasizes that the system is designed to facilitate operations for both administrators and end users (airlines and passengers).

##### Analysis of the File Structure
- The Java source code under src/main/java/acme is organized into several key packages:
- “components”: Contains supporting classes (e.g., ServiceAdvisor, ServiceRepository).
- “constraints”: Houses a large number of validation annotations and validator classes (e.g., ValidAircraft, AircraftValidator) that enforce business rules.
- “datatypes”: Defines enums or simple datastructures (e.g., AircraftStatus, AirlineType, LegStatus) used throughout the application.
- “entities”: Holds domain objects (e.g., Aircraft, Airline, Airport, Booking, FlightAssignment, etc.) and corresponding Repository classes which indicate data access operations.
- “features”: Divided into sub-packages (administrator, authenticated, customer, flightCrewMember) where each contains controllers and related services for various user roles. This clearly outlines an MVC (Model-View-Controller) or layered architecture.
- “forms” and “realms”: Likely handle UI dashboard models and security or identity-related logic (e.g., AssistanceAgent, Customer, Provider).
- In addition, the resources directory (src/main/resources/WEB-INF/views) contains JSP files organized by user role and functionality, which serves as the presentation layer.
- The presence of configuration files (e.g., application.properties, multiple platform-specific properties) and Maven’s pom.xml indicates that this project uses Maven for build management and is designed for different environments (development, testing, production).

##### Key Components
a. Presentation Layer (Frontend):
- JSP Views found under WEB-INF/views for different functionalities: administrator, authenticated, customer, flight crew member.
- Client or browser interactions initiating requests.
b. Application/Controller Layer:
- Controllers (e.g., Administrator*Controller, BookingController, PassengerController, FlightCrewMemberActivityLogController) that receive user input and orchestrate operations.
- Service classes (e.g., CreateService, ListService, UpdateService) that contain business logic.
c. Business Logic and Domain Layer:
- Domain entities located in src/main/java/acme/entities (Aircraft, Airline, Airport, Booking, etc.).
- Validation and constraint classes ensuring that business rules are met.
- Data types and mappings that represent domain logic.
d. Data Access Layer:
- Repository classes within the entities packages (e.g., AircraftRepository, AirlineRepository, AirportRepository) acting as the interface to persistence.
- The CSV files (in src/main/resources/WEB-INF/data and data/sample) suggest that the project initially loads or stores data from CSV sources.
e. Supporting Components:
- Components and utility classes (in src/main/java/acme/components) that may provide cross-cutting functionality.
- Configuration files (e.g., application.properties) that determine behavior based on deployment environment.

##### Relationships and Interactions
- Data flows from the client (browsers) to the presentation layer (JSP pages), passes to controllers, then to corresponding services, which in turn interact with repositories and domain models.
- Validators in the “constraints” package check inputs at both controller and domain levels.
- There is a separation of concerns where each “feature” (like administrator or customer functionality) has dedicated controllers, services, and repository interactions.

##### Architectural Patterns & Design Principles
- Layered/MVC Architecture: Clearly distinguish between presentation (views), application (controllers/services), and data layers (repositories/domain entities).
- Separation of Concerns: Each sub-package (e.g., features, constraints, datatypes) focuses on a distinct aspect of the system.
- Modularization by User Role: The “features” package is segmented by user roles (administrator, authenticated, customer, flight crew member) which guides the design of component interconnections.
- Environment-specific configurations: Multiple properties files indicate that the design should account for different deployment environments.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        Browser("Browser/User"):::presentation
        JSPViews("JSP Views"):::presentation
    end

    Browser -->|"sends request"| JSPViews

    %% Application/Controller Layer
    subgraph "Application/Controller Layer"
        %% Admin Controllers
        AdminAircraftCtrl("Administrator Aircraft Controller"):::controller
        AdminAirlineCtrl("Administrator Airline Controller"):::controller
        AdminAirportCtrl("Administrator Airport Controller"):::controller
        %% Other Controllers (customer, flight crew, etc.) are implied

        %% Admin Service
        AdminAircraftCreateSvc("Administrator Aircraft Create Service"):::service
    end

    JSPViews -->|"routes to"| AdminAircraftCtrl
    JSPViews -->|"routes to"| AdminAirlineCtrl
    JSPViews -->|"routes to"| AdminAirportCtrl

    AdminAircraftCtrl -->|"invokes"| AdminAircraftCreateSvc

    %% Domain Layer: Business Logic and Entities
    subgraph "Domain Layer"
        AircraftEntity("Aircraft Entity"):::entity
        AirlineEntity("Airline Entity"):::entity
        OtherEntities("Other Domain Entities"):::entity

        AircraftValidator("AircraftValidator"):::validator
        ValidAircraft("ValidAircraft"):::validator
        AircraftStatus("AircraftStatus"):::datatype
        OtherDatatypes("Other Datatypes"):::datatype
    end

    AdminAircraftCreateSvc -->|"processes using"| AircraftEntity
    AdminAircraftCreateSvc -->|"processes using"| AirlineEntity
    AdminAircraftCreateSvc -->|"validates with"| AircraftValidator
    AdminAircraftCreateSvc -->|"validates with"| ValidAircraft
    AircraftEntity ---|"has status"| AircraftStatus

    %% Data Access Layer
    subgraph "Data Access Layer"
        AircraftRepo("Aircraft Repository"):::repository
        AirlineRepo("Airline Repository"):::repository
        AirportRepo("Airport Repository"):::repository
        CSVData("CSV Data (Initial & Sample)"):::repository
    end

    AircraftEntity -->|"persists to"| AircraftRepo
    AirlineEntity -->|"persists to"| AirlineRepo
    OtherEntities -->|"persists to"| AirportRepo
    AircraftRepo ---|"loads initial data from"| CSVData
    AirlineRepo ---|"loads initial data from"| CSVData
    AirportRepo ---|"loads initial data from"| CSVData

    %% Infrastructure Layer: Supporting Components & Configuration
    subgraph "Infrastructure Layer"
        ServiceAdvisor("Service Advisor"):::infrastructure
        ServiceRepository("Service Repository"):::infrastructure
        ConfigFiles("Configuration Files"):::infrastructure
    end

    AdminAircraftCreateSvc ---|"utilizes"| ServiceAdvisor
    AdminAircraftCreateSvc ---|"utilizes"| ServiceRepository
    ServiceAdvisor ---|"config sourced from"| ConfigFiles
    ServiceRepository ---|"config sourced from"| ConfigFiles

    %% Click Events
    click JSPViews "https://github.com/dp2-c1-037/acme-ans-d03/tree/main/src/main/resources/WEB-INF/views"
    click AdminAircraftCtrl "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/features/administrator/aircraft/AdministratorAircraftController.java"
    click AdminAirlineCtrl "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/features/administrator/airline/AdministratorAirlineController.java"
    click AdminAirportCtrl "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/features/administrator/airport/AdministratorAirportController.java"
    click AdminAircraftCreateSvc "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/features/administrator/aircraft/AdministratorAircraftCreateService.java"
    click AircraftEntity "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/entities/aircraft/Aircraft.java"
    click AirlineEntity "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/entities/airline/Airline.java"
    click AircraftRepo "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/entities/aircraft/AircraftRepository.java"
    click AirlineRepo "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/entities/airline/AirlineRepository.java"
    click AirportRepo "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/entities/airports/AirportRepository.java"
    click AircraftValidator "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/constraints/AircraftValidator.java"
    click ValidAircraft "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/constraints/ValidAircraft.java"
    click AircraftStatus "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/datatypes/AircraftStatus.java"
    click ServiceAdvisor "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/components/ServiceAdvisor.java"
    click ServiceRepository "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/java/acme/components/ServiceRepository.java"
    click ConfigFiles "https://github.com/dp2-c1-037/acme-ans-d03/blob/main/src/main/resources/application.properties"

    %% Styles
    classDef presentation fill:#f8f9fa,stroke:#343a40,stroke-width:2px;
    classDef controller fill:#e9ecef,stroke:#495057,stroke-width:2px;
    classDef service fill:#dee2e6,stroke:#6c757d,stroke-width:2px;
    classDef entity fill:#fff3cd,stroke:#856404,stroke-width:2px;
    classDef repository fill:#d1ecf1,stroke:#0c5460,stroke-width:2px;
    classDef validator fill:#f8d7da,stroke:#721c24,stroke-width:2px;
    classDef datatype fill:#d4edda,stroke:#155724,stroke-width:2px;
    classDef infrastructure fill:#cce5ff,stroke:#004085,stroke-width:2px;"
```
