# chewiebug/gcviewer architecture

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

- Interactive diagram: https://gitdiagram.com/chewiebug/gcviewer
- Repository: https://github.com/chewiebug/gcviewer

## Overview

##### Project Type & Purpose
- It ships as an executable JAR (and a Mac .app via Maven Assembly) and is built with Maven.
- Its core function is: **read GC logs → parse events → build an in-memory model → render charts & tables → optionally export metrics**.

##### File Structure
- **pom.xml** – Maven build / packaging / assembly config.
- **cicd/** – Build scripts (Docker, CI credentials, Travis/GitHub Actions).
- **src/main/java**: package `com.tagtraum.perf.gcviewer` divided into:
- **imp/** – parsers (“DataReader” implementations per JVM type).
- **exp/** – exporters (“DataWriter” implementations).
- **ctrl/** – controllers & factories (GCModelLoader, GUI controllers, actions).
- **model/** – domain classes (GCEvent, GCModel, GcResource…).
- **view/** – Swing UI (frames, panels, renderers, menu/toolbars).
- **math/**, **util/**, **log/** – helpers for calculations, IO, logging.
- **src/main/assembly** – packaging instructions (e.g. Mac dist).
- **src/test** – unit tests exercising each layer.
- **dependometer/** – static dependency analysis config.
- **doc/** – design/usage docs.

##### Key Insights from README
- Two execution modes: **GUI** (`java -jar gcviewer.jar` double-click) and **CLI** (`java -jar gcviewer.jar gc.log summary.csv [chart.png] [-t FORMAT]`).
- **Supported GC formats** listed in README correspond to DataReader implementations.
- **MVC pattern**: clear separation between model (domain), view (Swing), controller (actions, loaders).
- **Export formats** mapped to DataWriter implementations (CSV, PLAIN, SIMPLE, SUMMARY, CSV_TS).

##### Main Components & Their Relationships
a. **Entry Points**
- **GUI Launcher** (GCViewer.main)
- **CLI Parser** (GCViewerArgsParser → dispatches to summary export or GUI)
b. **Argument Parser** (`GCViewerArgsParser`)
- Recognizes CLI flags, file lists, export format → passes control to loader or exporter.
c. **DataReader Layer** (`imp/`)
- **DataReaderFactory** chooses the correct `DataReader` subtype (Sun, IBM, HPUX, JRockit, Unified JVM Logging…).
- **DataReaderFacade** orchestrates reading and parsing lines into events.
d. **Model Loader** (`ctrl/impl/GCModelLoaderImpl`)
- Consumes parsed events → builds a **GCModel** (model/GCModel) containing timelines, metrics.
e. **Controller Layer** (`ctrl/impl/GCViewerGuiController`, `GCViewerGuiBuilder`)
- Initializes UI, registers listeners, binds model to view.
- Implements user actions (OpenFile, Export, Zoom, Watch, etc.).
f. **View Layer** (`view/`)
- Swing components: main window (`GCViewerGui`), chart panels (`ChartPanelView`), data tables, dialogs.
- **Renderers** produce the visual chart elements.
- **Model-view binding** via listeners and property-change events (view/model packages).
g. **Exporters** (`exp/impl/`)
- **DataWriterFactory** picks CSVDataWriter, PlainDataWriter, PNGDataWriter, SummaryDataWriter, etc.
- Exports model metrics to CSV, PNG, text.
h. **Utilities**
- Math/statistics helpers (`math/`), logging (`log/`), configuration (`util`), localization.
i. **Packaging**
- Maven Assembly builds JAR & Mac `.app`.
- **CI/CD** directory showcases build scripts but is orthogonal to runtime architecture.

##### Architectural Patterns & Design Principles
- **MVC (Model-View-Controller)**:
- Model = `model/GCModel` + events
- View = `view/` Swing components
- Controller = `ctrl/` actions & GUI builders
- **Factory Pattern** for DataReaders and DataWriters.
- **Facade** for parsing (DataReaderFacade).
- **Plugin-style** extensibility: each new GC log format or export format is a new impl class, registered via factory.
- **Separation of Concerns**: parsing, modeling, UI, exporting are decoupled.

##### Final Advice
- Be very detailed: include all 4 layers (parsing, modeling, control, view) plus export.
- **factory-based extension points** (DataReaderFactory, DataWriterFactory).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Entry Points
    EntryGUI["GUI Launcher\nGCViewer.main"]:::entry
    EntryCLI["CLI Launcher\nGCViewerArgsParser"]:::entry
    EntryGUI -->|start GUI| ArgParser
    EntryCLI -->|parse args| ArgParser

    %% Argument Parser
    ArgParser["Arg Parser\nGCViewerArgsParser"]:::parsing
    ArgParser -->|load model| ModelLoaderInterface
    ArgParser -->|export data| DataWriterFactory

    %% Parsing Layer
    subgraph "Parsing Layer" 
        direction TB
        DRFacade["DataReaderFacade"]:::parsing
        DRFactory["DataReaderFactory"]:::parsing
        DRImpl["DataReader Implementations"]:::parsing
    end
    ModelLoaderInterface["GCModelLoader Interface"]:::controller -->|uses| ModelLoaderImpl
    ModelLoaderImpl["GCModelLoaderImpl"]:::controller -->|calls| DRFacade
    DRFacade -->|uses| DRFactory
    DRFactory -->|creates| DRImpl
    DRFacade -->|parses events| ModelLoaderImpl

    %% Model Layer
    ModelLoaderImpl -->|builds| QModel["GCModel"]:::model
    GCEvent["GCEvent"]:::model -->|defines events| QModel

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        ControllerBuilder["GCViewerGuiBuilder"]:::controller
        ControllerGui["GCViewerGuiController"]:::controller
        Actions["User Actions"]:::controller
    end
    QModel -->|notify| ControllerGui
    ControllerBuilder -->|creates UI| ControllerGui
    ControllerGui -->|handles actions| Actions

    %% View Layer
    subgraph "View Layer"
        direction TB
        ViewMain["GCViewerGui"]:::view
        ChartView["ChartPanelView"]:::view
        Renderers["Renderers"]:::view
    end
    ControllerGui -->|update view| ViewMain
    ViewMain -->|display charts| ChartView
    ChartView -->|draw| Renderers
    ViewMain -->|user events| ControllerGui

    %% Exporter Layer
    subgraph "Exporter Layer"
        direction TB
        DataWriterFactory["DataWriterFactory"]:::exporter
        DataWriters["DataWriter Implementations"]:::exporter
    end
    ArgParser -->|export| DataWriterFactory
    DataWriterFactory -->|creates| DataWriters
    QModel -->|provide data| DataWriters

    %% Utilities
    subgraph "Utilities"
        direction TB
        UtilsMath["Math/Statistics"]:::util
        UtilsIO["IO/Logging/Helpers"]:::util
    end
    UtilsMath --> ModelLoaderImpl
    UtilsIO --> DRFacade
    UtilsIO --> ViewMain

    %% Packaging & CI
    Maven["Maven Build & Packaging"]:::util

    %% Click Events
    click EntryGUI "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/GCViewer.java"
    click EntryCLI "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/GCViewerArgsParser.java"
    click DRFacade "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/imp/DataReaderFacade.java"
    click DRFactory "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/imp/DataReaderFactory.java"
    click DRImpl "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/imp/"
    click ModelLoaderInterface "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/ctrl/GCModelLoader.java"
    click ModelLoaderImpl "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/ctrl/impl/GCModelLoaderImpl.java"
    click QModel "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/model/GCModel.java"
    click ControllerBuilder "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/ctrl/impl/GCViewerGuiBuilder.java"
    click ControllerGui "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/ctrl/impl/GCViewerGuiController.java"
    click Actions "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/ctrl/action/"
    click ViewMain "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/view/GCViewerGui.java"
    click ChartView "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/view/ChartPanelView.java"
    click Renderers "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/view/renderer/"
    click DataWriterFactory "https://github.com/chewiebug/gcviewer/blob/develop/src/main/java/com/tagtraum/perf/gcviewer/exp/impl/DataWriterFactory.java"
    click DataWriters "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/exp/impl/"
    click UtilsMath "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/math/"
    click UtilsIO "https://github.com/chewiebug/gcviewer/tree/develop/src/main/java/com/tagtraum/perf/gcviewer/util/"
    click Maven "https://github.com/chewiebug/gcviewer/blob/develop/pom.xml"

    %% Styles
    classDef entry fill:#f9f,stroke:#333,stroke-width:2px
    classDef parsing fill:#bbf,stroke:#333,stroke-width:1px
    classDef model fill:#bfb,stroke:#333,stroke-width:1px
    classDef controller fill:#ffb,stroke:#333,stroke-width:1px
    classDef view fill:#fb7,stroke:#333,stroke-width:1px
    classDef exporter fill:#dcb,stroke:#333,stroke-width:1px
    classDef util fill:#eee,stroke:#333,stroke-width:1px
```
