# claeis/ilivalidator architecture

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

- Interactive diagram: https://gitdiagram.com/claeis/ilivalidator
- Repository: https://github.com/claeis/ilivalidator

## Overview

##### Project type and purpose
- This is a Java-based open-source validation tool (“ilivalidator”) for checking INTERLIS 1+2 transfer files (XTF, ITF).
- It provides both a CLI (`java -jar ilivalidator.jar`) and a Swing-based GUI, supports plugins (see `demoplugin`), and can be built into a native image.

##### File structure
- Top-level build and config:
- `build.gradle`, `settings.gradle`, Gradle wrapper (`gradle/`, `gradlew`, `gradlew.bat`)
- `.travis.yml` for CI
- Core code under `src/org/interlis2/validator`: validation engine, tools (`CheckRepoDataTool`, `CreateIliDataTool`, `UpdateIliDataTool`), `Validator.java`, `ErrorTracker`, `Version.properties`.
- GUI under `src/org/interlis2/validator/gui`: Swing frames/dialogs, resource bundles (`.properties`).
- Plugin example under `demoplugin/src/org/interlis2/validator/demo`: demonstrates IOx plugin loading.
- Native-image configuration under `resources/META-INF/native-image`.
- Tests under `test/src/org/interlis2/validator` and test data under `test/data`.

##### README for additional insights
- Confirms it’s a Java CLI/GUI tool.
- Build via Gradle, binary distribution via `gradle bindist`.
- Documentation in `docs/ilivalidator.rst`.
- No external servers; runs locally on files.

##### Main components and their interactions
a. User interface layer
- CLI launcher (`Main.java`)
- GUI launcher (`MainFrame.java`, dialogs)
b. Core validation engine
- Parser for ITF/XTF files
- Validation rules manager (enable/disable checks, custom messages)
- ErrorTracker collects and formats results
c. Tool modules
- Repository data checker (`CheckRepoDataTool`)
- Data creation tool (`CreateIliDataTool`)
- Data update tool (`UpdateIliDataTool`)
d. Plugin subsystem
- Plugin loader reads from classpath (e.g., `demoplugin`)
- Plugins implement extension points for custom validation
e. Configuration and resources
- Native-image config for GraalVM build
- I18n message bundles
f. Test harness
- Unit tests run via Gradle
- Test data files for various scenarios

##### Architectural patterns and design principles
- Modular separation of core engine, UI, and tools.
- MVC pattern in GUI (view in Swing classes, controller invoking core).
- Plugin pattern for extensibility.
- Gradle build scripts for dependency and lifecycle management.
- Resource-driven configuration (INI files, `.properties`).

##### Putting it all together
- Above it, show two entry points: CLI Launcher and GUI Launcher, both pointing into the engine.
- Below the engine, position Tool Modules as separate blocks invoking the core.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Interface Layer
    subgraph "User Interface"
        CLI["CLI Launcher"]:::frontend
        GUI["GUI Launcher"]:::frontend
    end

    %% Core Engine
    subgraph "Core Validator Engine"
        Engine["Validator.java"]:::core
        ParserITF["ITF Parser"]:::core
        ParserXTF["XTF Parser"]:::core
        Rules["Validation Rules Manager"]:::core
        Error["ErrorTracker"]:::core
        Version["Version.properties"]:::resources
    end

    %% Tool Modules
    subgraph "Tool Modules"
        Repo["CheckRepoDataTool"]:::tool
        Create["CreateIliDataTool"]:::tool
        Update["UpdateIliDataTool"]:::tool
    end

    %% Plugin Subsystem
    subgraph "Plugin Subsystem"
        PluginMgr["Plugin Manager"]:::plugin
        Demo["Demo Plugin"]:::plugin
    end

    %% Resources & Config
    subgraph "Resources & Config"
        I18n_EN["IliValidatorTexts.properties"]:::resources
        I18n_DE["IliValidatorTexts_de.properties"]:::resources
        I18n_ES["IliValidatorTexts_es.properties"]:::resources
        NativeCfg["Native-image Config"]:::resources
        Docs["Documentation (RST)"]:::infra
    end

    %% Build & Test Infrastructure
    subgraph "Build & Test"
        Gradle["Gradle Build System"]:::infra
        JAR["JAR / Native Image"]:::infra
        Tests["Test Suite"]:::infra
    end

    %% Main Flows
    CLI -->|invokes| Engine
    GUI -->|invokes| Engine
    Version -->|provides version| Engine
    Engine -->|parses| ParserITF
    Engine -->|parses| ParserXTF
    ParserITF -->|validates| Rules
    ParserXTF -->|validates| Rules
    Rules -->|reports issues| Error
    Error -->|outputs to| CLI
    Error -->|outputs to| GUI

    Engine -->|used by| Repo
    Engine -->|used by| Create
    Engine -->|used by| Update

    CLI -.->|loads plugins| PluginMgr
    GUI -.->|loads plugins| PluginMgr
    PluginMgr -.->|discovers| Demo

    I18n_EN -->|localizes| GUI
    I18n_DE -->|localizes| GUI
    I18n_ES -->|localizes| GUI
    NativeCfg -->|configures| Gradle
    Docs -->|documents| CLI
    Docs -->|documents| GUI

    Gradle -->|builds| Engine
    Gradle -->|packages| JAR
    Gradle -->|runs| Tests
    Tests -->|validate| Engine
    Tests -->|validate| Repo
    Tests -->|validate| Create
    Tests -->|validate| Update

    %% Click Events
    click CLI "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/Main.java"
    click GUI "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/gui/MainFrame.java"
    click Engine "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/Validator.java"
    click Error "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/impl/ErrorTracker.java"
    click Repo "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/CheckRepoDataTool.java"
    click Create "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/CreateIliDataTool.java"
    click Update "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/UpdateIliDataTool.java"
    click I18n_EN "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/gui/IliValidatorTexts.properties"
    click I18n_DE "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/gui/IliValidatorTexts_de.properties"
    click I18n_ES "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/gui/IliValidatorTexts_es.properties"
    click Version "https://github.com/claeis/ilivalidator/blob/master/src/org/interlis2/validator/Version.properties"
    click Demo "https://github.com/claeis/ilivalidator/blob/master/demoplugin/src/org/interlis2/validator/demo/CheckGebaeudeVersicherungsSystemIoxPlugin.java"
    click NativeCfg "https://github.com/claeis/ilivalidator/blob/master/resources/META-INF/native-image/ch.interlis/ilivalidator/resource-config.json"
    click Gradle "https://github.com/claeis/ilivalidator/blob/master/build.gradle"
    click Docs "https://github.com/claeis/ilivalidator/blob/master/docs/ilivalidator.rst"
    click Tests "https://github.com/claeis/ilivalidator/tree/master/test/src/org/interlis2/validator/"

    %% Styles
    classDef frontend fill:#AED6F1,stroke:#21618C,color:#1B2631
    classDef core fill:#A9DFBF,stroke:#196F3D,color:#145A32
    classDef tool fill:#FCF3CF,stroke:#B7950B,color:#7D6608
    classDef plugin fill:#F5B7B1,stroke:#943126,color:#641E16
    classDef resources fill:#FAD7A0,stroke:#B9770E,color:#7E5109
    classDef infra fill:#D5D8DC,stroke:#566573,color:#1B2631
```
