# jfree/jfreechart architecture

> Architecture diagram of the GitHub repository jfree/jfreechart, 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/jfree/jfreechart
- Repository: https://github.com/jfree/jfreechart

## Overview

##### Project type and purpose
- This is a Java library (JFreeChart) for creating 2D/3D charts on the JVM.
- It provides core chart objects (plots, axes, renderers), data models (datasets), and output adapters (Swing panels, SVG/PNG/PDF encoders, JavaScript helpers).
- It is packaged as a single Maven module (pom.xml) and distributed to Maven Central under groupId org.jfree.

##### File structure
- Top-level:
- pom.xml – Maven build descriptor
- src/main/java – core Java code under org.jfree.chart and org.jfree.data
- src/main/resources – localization bundles for chart/editor/plot/ui
- src/main/javadoc – generated API docs
- src/test/java – extensive JUnit tests organized by package
- svg/js – JavaScript demo/helpers (KeyedValuesDataset.js, Utils.js)
- svg/lib – built JS helpers
- LICENSE, README.md, examples under svg/EQTBarChartDemo1.html
- Key packages:
- org.jfree.data.* – dataset interfaces & implementations (XY, category, time series, statistics, gantt, flow, general, io, json, xml)
- org.jfree.chart.* – chart/core: ChartFactory, JFreeChart, ChartUtils, ChartThemes, Hints
- org.jfree.chart.axis, plot, renderer, annotations, swing, imagemap, encoders
- Internal utility packages: org.jfree.chart.internal, util
- Build & CI:
- .github/workflows/ci.yaml – Maven build/test on GitHub Actions
- No external microservices: it’s a self-contained library.

##### README for additional insights
- Requires JDK 11+, uses Maven “mvn clean install”
- Supports client-side (Swing, JavaFX extension) and server-side export (SVG, PNG, PDF)
- Encourages external demos (JFree-Demos, JFree-FXDemos)
- Modular code: no JCommon dependency; all needed code integrated.

a. Main components
1. Data Layer (org.jfree.data.*)
2. Core Chart Engine (org.jfree.chart.*)
3. Plot Modules (axis, plot, renderer, annotations)
4. Output Adapters
- Swing UI (org.jfree.chart.swing)
- SVG/PNG/PDF Exporters (org.jfree.chart.encoders, ChartUtils)
- HTML image map & JS helpers (org.jfree.chart.imagemap, svg/js)
5. Utilities & Internals (org.jfree.chart.internal, util)
6. Resources (localization bundles)
7. Tests (src/test/java)
b. Relationships & interactions
- Application code → obtains dataset(s) → passes to ChartFactory → returns JFreeChart instance
- JFreeChart holds Plot which references Axes + Renderers + Datasets
- ChartUtils or Encoder modules take BufferedImage and encode to PNG/SVG/PDF
- Imagemap builders generate HTML <map> definitions based on ChartRenderingInfo
- JS helpers complement client-side interactivity for exported SVG/HTML
c. Architectural patterns/design principles
- Separation of concerns: data vs. chart model vs. rendering vs. UI vs. export
- Factory pattern: ChartFactory for creating common chart types
- Visitor pattern: ChartElementVisitor traverses chart elements
- Strategy pattern: different Renderer implementations, Encoder implementations
- Observer pattern: Listeners for chart change events, dataset change events
- Modular packaging by feature (data, chart, plot, renderer, swing, encoders)
d. Key technologies/frameworks
- Java 11+
- Java2D (AWT/Swing)
- Maven for build & dependency management
- JUnit 4/5 for tests
- GitHub Actions for CI
- Optional JavaScript for web demos

##### Details to capture
- ChartRenderingInfo flowing to Encoder and Imagemap modules
- Maven module boundary (pom.xml)
- Mention external endpoints (Maven Central, GitHub) as external sinks/sources

Summary for the engineer:
- Break the project into: Data, Core Engine, Plot Modules, Output Adapters, Utilities, Resources, Tests.
- Flows: Application → ChartFactory → Chart Model → Plot → Renderer → Output.
- Be precise about layering and extension points.

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Entities
    Application["Client Application"]:::external
    MavenCentral["Maven Central"]:::external
    GitHub["GitHub"]:::external

    %% Layers
    Application -->|"uses"| DataLayer
    Application -->|"invokes"| CoreEngine

    DataLayer["Data Layer\n(org.jfree.data.*)"]:::core
    CoreEngine["Core Chart Engine\n(org.jfree.chart.*)"]:::core
    DataLayer -->|"provides datasets to"| CoreEngine

    subgraph "Plot Modules"
        direction TB
        Axis["Axis Package\n(org.jfree.chart.axis)"]:::core
        PlotPkg["Plot Package\n(org.jfree.chart.plot)"]:::core
        Renderer["Renderer Package\n(org.jfree.chart.renderer)"]:::core
        Annotations["Annotations Package\n(org.jfree.chart.annotations)"]:::core
    end

    CoreEngine -->|"creates Plot using"| PlotPkg
    PlotPkg -->|"uses"| Axis
    PlotPkg -->|"assigns"| Renderer
    PlotPkg -->|"attaches"| Annotations

    subgraph "Output Adapters"
        direction TB
        SwingUI["Swing UI Adapter\n(org.jfree.chart.swing)"]:::adapters
        ChartEditor["Swing Chart Editor\n(org.jfree.chart.swing.editor)"]:::adapters
        Encoders["Image Encoders\n(org.jfree.chart.encoders)"]:::adapters
        Imagemap["HTML Image Maps\n(org.jfree.chart.imagemap)"]:::adapters
        JSHelpers["JavaScript Helpers\n(svg/js)"]:::adapters
    end

    Renderer -->|"renders via Java2D to Swing"| SwingUI
    SwingUI -->|"provides Chart Panel"| ChartEditor
    Renderer -->|"renders off-screen"| Encoders
    CoreEngine -->|"generates ChartRenderingInfo"| Imagemap
    Imagemap -->|"uses"| JSHelpers

    subgraph "Utilities & Internals"
        direction TB
        InternalUtils["Internal Utilities\n(org.jfree.chart.internal)"]:::utils
        GeneralUtils["General Utilities\n(org.jfree.chart.util)"]:::utils
    end

    Utilities_Internal:::dummy
    InternalUtils -.-> DataLayer
    InternalUtils -.-> CoreEngine
    GeneralUtils -.-> PlotPkg
    GeneralUtils -.-> Renderer

    subgraph "Resources"
        direction TB
        LocalizationBundles["Localization Bundles\n(src/main/resources)"]:::resources
    end

    LocalizationBundles -.-> CoreEngine
    LocalizationBundles -.-> PlotPkg
    LocalizationBundles -.-> DataLayer

    subgraph "Tests"
        direction TB
        Tests["JUnit Tests\n(src/test/java)"]:::test
    end

    Tests -.-> DataLayer
    Tests -.-> CoreEngine

    subgraph "Build & CI"
        direction TB
        MavenPOM["Maven POM\n(pom.xml)"]:::build
        GitHubCI["GitHub Actions CI\n(.github/workflows/ci.yaml)"]:::build
    end

    GitHub -->|triggers| GitHubCI
    GitHubCI -->|builds via| MavenPOM
    MavenPOM -->|deploys to| MavenCentral

    %% Legend
    subgraph "Legend"
        direction TB
        C1["Core Packages"]:::core
        C2["Adapters"]:::adapters
        C3["Utilities"]:::utils
        C4["Resources/Tests"]:::resources
        C5["External/Build"]:::external
    end

    %% Click Events
    click DataLayer "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/data"
    click CoreEngine "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart"
    click Axis "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/axis"
    click PlotPkg "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/plot"
    click Renderer "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/renderer"
    click Annotations "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/annotations"
    click SwingUI "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/swing"
    click ChartEditor "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/swing/editor"
    click Encoders "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/encoders"
    click Imagemap "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/imagemap"
    click JSHelpers "https://github.com/jfree/jfreechart/tree/master/svg/js"
    click InternalUtils "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/internal"
    click GeneralUtils "https://github.com/jfree/jfreechart/tree/master/src/main/java/org/jfree/chart/util"
    click LocalizationBundles "https://github.com/jfree/jfreechart/tree/master/src/main/resources"
    click Tests "https://github.com/jfree/jfreechart/tree/master/src/test/java"
    click MavenPOM "https://github.com/jfree/jfreechart/blob/master/pom.xml"
    click GitHubCI "https://github.com/jfree/jfreechart/blob/master/.github/workflows/ci.yaml"

    %% Styles
    classDef core fill:#cce5ff,stroke:#004085,color:#004085
    classDef adapters fill:#d4edda,stroke:#155724,color:#155724
    classDef utils fill:#fff3cd,stroke:#856404,color:#856404
    classDef resources fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef test fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef build fill:#f5c6cb,stroke:#721c24,color:#721c24
    classDef external fill:#f8d7da,stroke:#721c24,color:#721c24
```
