# rhabbachi/pfe architecture

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

- Interactive diagram: https://gitdiagram.com/rhabbachi/pfe
- Repository: https://github.com/rhabbachi/pfe

## Overview

##### Project Type and Purpose
- This is a multi-module Android mobile application (“TunavMedi”) aimed at physicians. It uses Location-Based Services (GPS) to locate patients and retrieve their medical records.
- The project consists of three Android library/executable modules:
- tunavmedi: the main application (UI, services, broadcast receivers)
- tunavmedi_dal: an abstraction layer defining data access interfaces
- tunavmedi_dal_sqlite: a concrete SQLite-based implementation of those interfaces

##### File Structure Analysis
- Top-level: README, project metadata, postmortem deliverables (report/, poster/, presentation/).
- source/ contains three Android projects:
- tunavmedi/ – application source, resources, tests
- tunavmedi_dal/ – interfaces for authentication and patient handling
- tunavmedi_dal_sqlite/ – contracts and helpers to persist data in SQLite
- scripts/coordinate_generator.py – test data generator for fake geo-points.

##### Key Insights from README
- Core functionality: physician locates patient via GPS and retrieves medical data.
- Work in progress; MIT-licensed mobile app.
- No server component in code; all data is local or loaded via DAL abstraction (future remote DAL possible).

##### Main Architectural Components
a. UI Layer (tunavmedi module)
- Activities (LoginActivity, MainActivity)
- Fragments for patient list, display, options, fake-location generator
- Adapters (PatientsAdapter)
- Dialog fragments for user interactions
b. Application Controllers & Services
- PatientsService – background data retrieval and sync
- BroadcastReceivers (BatteryReceiver, ChargingReceiver, NetworkReceiver) to monitor environment and trigger actions
c. Data Abstraction Layer (tunavmedi_dal module)
- Interfaces: AuthenticationHandler, PatientsHandler
- Data types: Patient, Placemark
- ModuleLoader – selects which DAL implementation to use at runtime
d. Data Persistence Layer (tunavmedi_dal_sqlite module)
- SQLite contracts (CredentialsContract, PatientsContract, PlacemarksContract)
- Helpers (AuthenticationHelper, PatientsHelper, SQLFileHelper)
- DBSetup – initial schema creation
e. External/System Services
- Android LocationManager / GPS provider for patient geolocation
- Android SharedPreferences for storing credentials or settings
f. Testing
- Android instrumentation tests in tunavmedi/tests
- coordinate_generator.py for generating test inputs

##### Relationships and Interactions
- UI → Service: Activities/Fragments call PatientsService to fetch/update patient data.
- Service → DAL Abstraction: PatientsService invokes PatientsHandler interface.
- ModuleLoader → DAL Implementation: at startup, ModuleLoader picks the SQLite handler provided by tunavmedi_dal_sqlite.
- DAL Implementation → SQLite DB: Helpers read/write using Contracts and SQLiteOpenHelper.
- UI → Android LocationManager: Fragments or Services request location updates.
- BroadcastReceivers → Service/UI: environment changes (battery/network) trigger broadcast events handled by the app.

##### Architectural Patterns and Design Principles
- Layered architecture (Presentation → Service/Controller → Data Abstraction → Persistence)
- Strategy/Factory via ModuleLoader for swapping DAL implementations
- MVC/MVP flavor in UI (Activities/Fragments manage views and delegate logic to services)
- Separation of concerns: UI vs. business logic vs. data access
- Modularization: each module compiles and tests independently

##### Technologies, Frameworks, and Libraries
- Android SDK (Activities, Fragments, Services, BroadcastReceivers, SQLite, SharedPreferences)
- Java (core language), JUnit/AndroidTest for testing
- Python script for coordinate generation

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Android Framework"
        LocationManager["LocationManager"]:::android
        SharedPreferences["SharedPreferences"]:::android
    end

    subgraph "tunavmedi (App UI)"
        LoginActivity["LoginActivity"]:::app
        MainActivity["MainActivity"]:::app
        PatientsAdapter["PatientsAdapter"]:::app
        subgraph "Fragments"
            PatientListFragment["PatientListFragment"]:::app
            NotImplementedListFragment["NotImplemetedListFragment"]:::app
            PatientDisplay["PatientDisplay"]:::app
            PatientOptions["PatientOptions"]:::app
            RandomFakeLocation["RandomFakeLocation"]:::app
        end
    end

    subgraph "Service Layer"
        PatientsService["PatientsService"]:::service
    end

    subgraph "Broadcast Receivers"
        BatteryReceiver["BatteryReceiver"]:::service
        ChargingReceiver["ChargingReceiver"]:::service
        NetworkReceiver["NetworkReceiver"]:::service
    end

    ModuleLoader["ModuleLoader"]:::app

    subgraph "tunavmedi_dal (Abstraction)"
        AuthenticationHandler["AuthenticationHandler"]:::dal
        PatientsHandler["PatientsHandler"]:::dal
        PatientType["Patient"]:::dal
        PlacemarkType["Placemark"]:::dal
    end

    subgraph "tunavmedi_dal_sqlite (Persistence)"
        DBSetup["DBSetup"]:::db
        CredentialsContract["CredentialsContract"]:::db
        PatientsContract["PatientsContract"]:::db
        PlacemarksContract["PlacemarksContract"]:::db
        AuthenticationHelper["AuthenticationHelper"]:::db
        PatientsHelper["PatientsHelper"]:::db
        SQLFileHelper["SQLFileHelper"]:::db
    end

    subgraph "Testing & Scripts"
        AppTest["App.java (Test)"]:::ext
        LocationTestKML["locationstest.kml"]:::ext
        CoordinateGen["coordinate_generator.py"]:::ext
    end

    %% Interactions
    LoginActivity -->|calls| PatientsService
    MainActivity -->|calls| PatientsService
    PatientListFragment -->|uses| PatientsAdapter
    PatientListFragment -->|calls| PatientsService
    PatientsService -->|invokes| PatientsHandler
    ModuleLoader -->|selects| AuthenticationHandler
    ModuleLoader -->|selects| PatientsHandler
    AuthenticationHandler ---|datatype| PatientType
    PatientsHandler ---|datatype| PatientType
    PatientsHandler ---|datatype| PlacemarkType
    AuthenticationHandler -->|implemented by| AuthenticationHelper
    PatientsHandler -->|implemented by| PatientsHelper
    AuthenticationHelper -->|uses| CredentialsContract
    PatientsHelper -->|uses| PatientsContract
    PatientsHelper -->|uses| PlacemarksContract
    DBSetup -->|creates schema| CredentialsContract
    DBSetup -->|creates schema| PatientsContract
    DBSetup -->|creates schema| PlacemarksContract
    PatientsService -->|requests| LocationManager
    PatientListFragment -->|requests| LocationManager
    BatteryReceiver -->|triggers| PatientsService
    ChargingReceiver -->|triggers| PatientsService
    NetworkReceiver -->|triggers| PatientsService
    ModuleLoader -->|reads| SharedPreferences
    CoordinateGen -->|generates| PatientListFragment
    AppTest -->|tests| PatientsService
    AppTest -->|tests| LoginActivity

    %% Click events
    click LoginActivity "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/activity/LoginActivity.java"
    click MainActivity "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/activity/MainActivity.java"
    click PatientListFragment "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/fragment/PatientListFragment.java"
    click NotImplementedListFragment "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/fragment/NotImplemetedListFragment.java"
    click PatientDisplay "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/fragment/dialog/PatientDisplay.java"
    click PatientOptions "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/fragment/dialog/PatientOptions.java"
    click RandomFakeLocation "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/fragment/dialog/RandomFakeLocation.java"
    click PatientsAdapter "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/adapter/PatientsAdapter.java"
    click PatientsService "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/service/PatientsService.java"
    click BatteryReceiver "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/broadcastreceiver/BatteryReceiver.java"
    click ChargingReceiver "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/broadcastreceiver/ChargingReceiver.java"
    click NetworkReceiver "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/broadcastreceiver/NetworkReceiver.java"
    click ModuleLoader "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/src/com/tunav/tunavmedi/ModuleLoader.java"
    click AuthenticationHandler "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal/src/com/tunav/tunavmedi/dal/abstraction/AuthenticationHandler.java"
    click PatientsHandler "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal/src/com/tunav/tunavmedi/dal/abstraction/PatientsHandler.java"
    click PatientType "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal/src/com/tunav/tunavmedi/dal/datatype/Patient.java"
    click PlacemarkType "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal/src/com/tunav/tunavmedi/dal/datatype/Placemark.java"
    click DBSetup "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/DBSetup.java"
    click CredentialsContract "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/contract/CredentialsContract.java"
    click PatientsContract "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/contract/PatientsContract.java"
    click PlacemarksContract "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/contract/PlacemarksContract.java"
    click AuthenticationHelper "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/helper/AuthenticationHelper.java"
    click PatientsHelper "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/helper/PatientsHelper.java"
    click SQLFileHelper "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi_dal_sqlite/src/com/tunav/tunavmedi/dal/sqlite/helper/SQLFileHelper.java"
    click AppTest "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/tests/src/com/tunav/tunavmedi/tests/App.java"
    click LocationTestKML "https://github.com/rhabbachi/pfe/blob/master/source/tunavmedi/tests/res/raw/locationstest.kml"
    click CoordinateGen "https://github.com/rhabbachi/pfe/blob/master/scripts/coordinate_generator.py"

    %% Styles
    classDef android fill:#cce5ff,stroke:#004085,color:#004085
    classDef app fill:#d4edda,stroke:#155724,color:#155724
    classDef service fill:#fff3cd,stroke:#856404,color:#856404
    classDef dal fill:#ffe5b4,stroke:#cc8400,color:#cc8400
    classDef db fill:#f8d7da,stroke:#721c24,color:#721c24
    classDef ext fill:#e2e3e5,stroke:#6c757d,color:#6c757d
```
