# fodohl/seng202-project architecture

> Architecture diagram of the GitHub repository fodohl/seng202-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fodohl/seng202-project
- Repository: https://github.com/fodohl/seng202-project

## Overview

TrashApp is a JavaFX desktop application for finding Christchurch public bins, reporting bin conditions, logging rubbish disposal, and viewing community sustainability information. The principal workflow runs from a user through routed pages and shared application state to data services, local persistence, and TrashDB operations; background tasks maintain synchronized and calculated data. The README also identifies map, home statistics, community, and CSV export capabilities. Several page and task implementations were not sampled, so those feature branches are represented without speculative internal call chains.

Main entry points: [`src/main/java/seng202/team1/data/DataService.java`](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/DataService.java) (Data service), [`src/main/java/seng202/team1/gui/pages`](https://github.com/fodohl/seng202-project/tree/main/src/main/java/seng202/team1/gui/pages) (Feature pages), [`src/main/java/seng202/team1/state/GlobalState.java`](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/state/GlobalState.java) (Shared app state), [`src/main/java/seng202/team1/api/trashdb/TrashDBClient.java`](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/trashdb/TrashDBClient.java) (TrashDB client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Desktop interface"]
  node_app["Application startup<br/>[Main.java]"]
  node_state["Shared app state<br/>[GlobalState.java]"]
  node_router["Page router<br/>[Router.java]"]
  node_pages["Feature pages"]
  node_map["Bin map<br/>[MapPage.java]"]
  node_home["Home statistics<br/>[HomePage.java]"]
  node_community["Community view<br/>[CommunityPage.java]"]
  node_timeline["Activity timeline<br/>[TimelinePage.java]"]
end

subgraph group_domain["Bin and activity data"]
  node_data["Data service<br/>[DataService.java]"]
  node_bins["Bin dataset<br/>[BinDataset.java]"]
  node_report["Bin reports<br/>[StatusReport.java]"]
  node_trashlog["Disposal logs<br/>[TrashLog.java]"]
  node_export["CSV export<br/>[ExportManager.java]"]
end

subgraph group_persistence["Local persistence"]
  node_tables[("Local tables")]
  node_trashdao["Disposal persistence<br/>[TrashLogDAO.java]"]
  node_dbmanager["Database manager"]
end

subgraph group_services["API and background services"]
  node_clients["API client registry<br/>[AppClients.java]"]
  node_trashclient["TrashDB client<br/>[TrashDBClient.java]"]
  node_trashbackend["TrashDB backend"]
  node_photon["Location search<br/>[PhotonClient.java]"]
  node_tasks["Background tasks<br/>[AppTasks.java]"]
  node_preflight["Startup preparation"]
end

node_user(("Desktop user"))
node_photonservice(("Photon geocoder"))

node_user -->|"launches"| node_app
node_app -->|"creates"| node_state
node_state -->|"initializes UI"| node_router
node_user -.->|"navigates"| node_router
node_router -->|"switches pages"| node_pages
node_pages -.->|"includes map"| node_map
node_pages -.->|"includes statistics"| node_home
node_pages -.->|"includes community"| node_community
node_pages -.->|"shows activity"| node_timeline
node_state -->|"creates"| node_data
node_data -->|"loads dataset"| node_bins
node_user -.->|"logs disposal"| node_data
node_data -->|"creates logs"| node_trashlog
node_data -->|"creates reports"| node_report
node_data -->|"uses local tables"| node_tables
node_tables -.->|"accesses logs"| node_trashdao
node_trashdao -.->|"uses connection"| node_dbmanager
node_data -->|"syncs activity"| node_trashclient
node_clients -->|"registers client"| node_trashclient
node_trashclient -->|"invokes backend"| node_trashbackend
node_clients -->|"registers client"| node_photon
node_photon -->|"searches locations"| node_photonservice
node_trashclient -.->|"exports data"| node_export
node_state -->|"creates tasks"| node_tasks
node_tasks -->|"starts preparation"| node_preflight

click node_app "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/Main.java"
click node_state "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/state/GlobalState.java"
click node_router "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/Router.java"
click node_pages "https://github.com/fodohl/seng202-project/tree/main/src/main/java/seng202/team1/gui/pages"
click node_map "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/MapPage.java"
click node_home "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/HomePage.java"
click node_community "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/CommunityPage.java"
click node_timeline "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/TimelinePage.java"
click node_data "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/DataService.java"
click node_bins "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/bin/BinDataset.java"
click node_report "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/types/status/StatusReport.java"
click node_trashlog "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/types/trashlog/TrashLog.java"
click node_export "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/export/ExportManager.java"
click node_tables "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/TableCollection.java"
click node_trashdao "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/DAO/TrashLogDAO.java"
click node_dbmanager "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/DatabaseManager.java"
click node_clients "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/AppClients.java"
click node_trashclient "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/trashdb/TrashDBClient.java"
click node_trashbackend "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/trashdb/TrashDBBackend.java"
click node_photon "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/photon/PhotonClient.java"
click node_tasks "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/tasks/AppTasks.java"
click node_preflight "https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/tasks/preflight/PreflightManager.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_state,node_router,node_pages,node_map,node_home,node_community,node_timeline,node_user toneBlue
class node_data,node_bins,node_report,node_trashlog,node_export toneAmber
class node_tables,node_trashdao,node_dbmanager toneMint
class node_clients,node_trashclient,node_trashbackend,node_photon,node_tasks,node_preflight toneRose
class node_photonservice toneIndigo
```

## Components

### Desktop interface

- [Application startup](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/Main.java): `src/main/java/seng202/team1/Main.java`
- [Shared app state](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/state/GlobalState.java): `src/main/java/seng202/team1/state/GlobalState.java`
- [Page router](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/Router.java): `src/main/java/seng202/team1/gui/Router.java`
- [Feature pages](https://github.com/fodohl/seng202-project/tree/main/src/main/java/seng202/team1/gui/pages): `src/main/java/seng202/team1/gui/pages`
- [Bin map](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/MapPage.java): `src/main/java/seng202/team1/gui/pages/MapPage.java`
- [Home statistics](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/HomePage.java): `src/main/java/seng202/team1/gui/pages/HomePage.java`
- [Community view](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/CommunityPage.java): `src/main/java/seng202/team1/gui/pages/CommunityPage.java`
- [Activity timeline](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/gui/pages/TimelinePage.java): `src/main/java/seng202/team1/gui/pages/TimelinePage.java`

### Bin and activity data

- [Data service](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/DataService.java): `src/main/java/seng202/team1/data/DataService.java`
- [Bin dataset](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/bin/BinDataset.java): `src/main/java/seng202/team1/data/bin/BinDataset.java`
- [Bin reports](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/types/status/StatusReport.java): `src/main/java/seng202/team1/types/status/StatusReport.java`
- [Disposal logs](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/types/trashlog/TrashLog.java): `src/main/java/seng202/team1/types/trashlog/TrashLog.java`
- [CSV export](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/data/export/ExportManager.java): `src/main/java/seng202/team1/data/export/ExportManager.java`

### Local persistence

- [Local tables](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/TableCollection.java): `src/main/java/seng202/team1/database/TableCollection.java`
- [Disposal persistence](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/DAO/TrashLogDAO.java): `src/main/java/seng202/team1/database/DAO/TrashLogDAO.java`
- [Database manager](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/database/DatabaseManager.java): `src/main/java/seng202/team1/database/DatabaseManager.java`

### API and background services

- [API client registry](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/AppClients.java): `src/main/java/seng202/team1/api/AppClients.java`
- [TrashDB client](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/trashdb/TrashDBClient.java): `src/main/java/seng202/team1/api/trashdb/TrashDBClient.java`
- [TrashDB backend](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/trashdb/TrashDBBackend.java): `src/main/java/seng202/team1/api/trashdb/TrashDBBackend.java`
- [Location search](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/api/photon/PhotonClient.java): `src/main/java/seng202/team1/api/photon/PhotonClient.java`
- [Background tasks](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/tasks/AppTasks.java): `src/main/java/seng202/team1/tasks/AppTasks.java`
- [Startup preparation](https://github.com/fodohl/seng202-project/blob/main/src/main/java/seng202/team1/tasks/preflight/PreflightManager.java): `src/main/java/seng202/team1/tasks/preflight/PreflightManager.java`

### Other components

- **Desktop user**
- **Photon geocoder**

## Connections

- Desktop user → Application startup: launches (evidence: `src/main/java/seng202/team1/Main.java`)
- Application startup → Shared app state: creates (evidence: `src/main/java/seng202/team1/Main.java`)
- Shared app state → Page router: initializes UI (evidence: `src/main/java/seng202/team1/state/GlobalState.java`)
- Desktop user → Page router: navigates
- Page router → Feature pages: switches pages (evidence: `src/main/java/seng202/team1/gui/Router.java`)
- Feature pages → Bin map: includes map
- Feature pages → Home statistics: includes statistics
- Feature pages → Community view: includes community
- Feature pages → Activity timeline: shows activity
- Shared app state → Data service: creates (evidence: `src/main/java/seng202/team1/state/GlobalState.java`)
- Data service → Bin dataset: loads dataset (evidence: `src/main/java/seng202/team1/data/DataService.java`)
- Desktop user → Data service: logs disposal
- Data service → Disposal logs: creates logs (evidence: `src/main/java/seng202/team1/data/DataService.java`)
- Data service → Bin reports: creates reports (evidence: `src/main/java/seng202/team1/data/DataService.java`)
- Data service → Local tables: uses local tables (evidence: `src/main/java/seng202/team1/data/DataService.java`)
- Local tables → Disposal persistence: accesses logs
- Disposal persistence → Database manager: uses connection (evidence: `src/main/java/seng202/team1/database/DAO/TrashLogDAO.java`)
- Data service → TrashDB client: syncs activity (evidence: `src/main/java/seng202/team1/data/DataService.java`)
- API client registry → TrashDB client: registers client (evidence: `src/main/java/seng202/team1/api/AppClients.java`)
- TrashDB client → TrashDB backend: invokes backend (evidence: `src/main/java/seng202/team1/api/trashdb/TrashDBClient.java`)
- API client registry → Location search: registers client (evidence: `src/main/java/seng202/team1/api/AppClients.java`)
- Location search → Photon geocoder: searches locations (evidence: `src/main/java/seng202/team1/api/photon/PhotonClient.java`)
- TrashDB client → CSV export: exports data
- Shared app state → Background tasks: creates tasks (evidence: `src/main/java/seng202/team1/state/GlobalState.java`)
- Background tasks → Startup preparation: starts preparation (evidence: `src/main/java/seng202/team1/tasks/AppTasks.java`)
