# hpi-information-systems/metanome architecture

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

- Interactive diagram: https://gitdiagram.com/hpi-information-systems/metanome
- Repository: https://github.com/hpi-information-systems/metanome

## Overview

##### Project Type and Purpose
- Metanome is a modular, full-stack data-profiling platform.
- Core is a Java/Maven multi-module system:
- A backend REST service (runs in Tomcat, exposes HTTP/JSON).
- An Angular/web frontend (separate repo, pulled in as submodule).
- A CLI tool for headless execution.
- Libraries for algorithm integration, helper data structures, testing and packaging.
- Purpose: load profiling algorithms as plugins, run them over input data (file or DB), collect and post-process results, persist them, and serve via an API/UI.

##### File-Structure Analysis
- Top-level modules:
- algorithm_helper: reusable data structures (PLIs, graphs) with unit tests.
- algorithm_integration: defines Algorithm interface, configuration/input/result APIs, plugin loading, execution and JSON serialization.
- algorithm_template_root: skeleton for building new profiling algorithms.
- backend: JAX-RS resources, algorithm loading/execution engine, input generators, result post-processing (analysis, comparison, ranking, visualization), Hibernate-based persistence.
- backendwar: packaged WAR with sample data.
- frontend: web UI (Angular) under WEB-INF, built via Maven.
- metanome-cli: command-line Java client that boots Algorithms or calls the REST API.
- file_upload: Python script to POST files to backend.
- deployment: assembly of Tomcat + frontend + backend for local run.
- testing_algorithms & test_helper: sample algorithms and testing utilities.
- Build orchestration via root pom.xml, sub-module poms, Travis CI (.travis.yml) and Git hooks for license checks.

##### Key Insights from README
- Backend communicates over HTTP REST with web frontend.
- Frontend is an Angular application in a separate repository.
- Build profiles: default (libraries + tests), “deployment-local” (packages Tomcat+frontend+sample data).
- Algorithms are supplied as JAR plugins; configuration and parameter types are pluggable.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    subgraph "Clients"
        Browser["Browser UI"]:::frontend
        CLI["CLI Tool"]:::cli
    end

    %% Frontend
    subgraph "Frontend Layer"
        UI["Angular App"]:::frontend
    end

    %% Backend
    subgraph "Backend Layer"
        REST["REST API"]:::backend

        subgraph "Plugin Manager & Executor"
            Finder["AlgorithmFinder/Analyzer/JarLoader"]:::backend
            Exec["ProcessRegistry/AlgorithmExecutor"]:::backend
        end

        subgraph "Input Generators"
            FileGen["DefaultFileInputGenerator"]:::backend
            DBGen["DefaultDatabaseConnectionGenerator"]:::backend
        end

        subgraph "Post-Processing Pipeline"
            Analyzer["Analyzers"]:::processing
            Comparator["Comparators"]:::processing
            Ranking["Ranking"]:::processing
            Visualization["Visualization JSON"]:::processing
            Store["Result Store"]:::processing
        end

        subgraph "Persistence Layer"
            DB["Results DB Entities + HibernateUtil"]:::persistence
        end
    end

    %% Integration Modules
    subgraph "Integration Modules"
        AlgHelper["Algorithm Helper"]:::lib
        AlgAPI["Algorithm Integration API"]:::lib
        InputIntegration["Input Generators (API)"]:::lib
        ResultReceiver["Result Receivers (API)"]:::lib
    end

    %% Plugins
    subgraph "Algorithms"
        Plugins["Profiling Algorithm Plugins"]:::plugin
    end

    %% Packaging & Deployment
    subgraph "Packaging & Deployment"
        WAR["Packaged WAR"]:::deployment
        Assembly["Local Deployment Assembly"]:::deployment
    end

    %% Connections
    Browser -->|"loads UI"| UI
    UI -->|"HTTP/JSON"| REST
    CLI -->|"REST API"| REST
    CLI -->|"Library calls"| AlgAPI

    REST -->|"loads plugins"| Finder
    Finder --> Exec
    Exec --> FileGen
    Exec --> DBGen
    FileGen --> Exec
    DBGen --> Exec
    Exec --> Plugins
    Exec --> ResultReceiver
    Exec --> Analyzer

    Analyzer --> Comparator
    Comparator --> Ranking
    Ranking --> Visualization
    Visualization --> Store
    Store --> DB

    AlgAPI --> Finder
    Plugins --> AlgAPI
    InputIntegration --> FileGen
    InputIntegration --> DBGen
    ResultReceiver --> Exec

    REST --> WAR
    WAR --> UI

    Assembly --> REST
    Assembly --> UI

    %% Click Events
    click AlgHelper "https://github.com/hpi-information-systems/metanome/tree/master/algorithm_helper/src/main/java/de/metanome/algorithm_helper"
    click AlgAPI "https://github.com/hpi-information-systems/metanome/tree/master/algorithm_integration/src/main/java/de/metanome/algorithm_integration"
    click InputIntegration "https://github.com/hpi-information-systems/metanome/tree/master/algorithm_integration/src/main/java/de/metanome/algorithm_integration/input"
    click ResultReceiver "https://github.com/hpi-information-systems/metanome/tree/master/algorithm_integration/src/main/java/de/metanome/algorithm_integration/result_receiver"
    click Finder "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/algorithm_loading"
    click Exec "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/algorithm_execution"
    click FileGen "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/input/file"
    click DBGen "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/input/database"
    click Analyzer "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/result_postprocessing/result_analyzer"
    click Comparator "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/result_postprocessing/result_comparator"
    click Ranking "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/result_postprocessing/result_ranking"
    click Visualization "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/result_postprocessing/visualization"
    click Store "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/result_postprocessing/result_store"
    click DB "https://github.com/hpi-information-systems/metanome/tree/master/backend/src/main/java/de/metanome/backend/results_db"
    click Plugins "https://github.com/hpi-information-systems/metanome/tree/master/testing_algorithms/[example_*]_algorithm/src/main/java/de/metanome/algorithms/testing"
    click CLI "https://github.com/hpi-information-systems/metanome/tree/master/metanome-cli/src/main/java/de/metanome/cli"
    click UI "https://github.com/hpi-information-systems/metanome/tree/master/frontend/src"
    click UI "https://github.com/hpi-information-systems/metanome/tree/master/frontend/WEB-INF"
    click WAR "https://github.com/hpi-information-systems/metanome/tree/master/backendwar/WEB-INF"
    click WAR "https://github.com/hpi-information-systems/metanome/tree/master/backendwar/src/main/resources/inputData"
    click Assembly "https://github.com/hpi-information-systems/metanome/blob/master/deployment/configs/local/assembly-local.xml"
    click Assembly "https://github.com/hpi-information-systems/metanome/blob/master/deployment/run.sh"

    %% Styles
    classDef frontend fill:#E8F1F2,stroke:#333,stroke-width:1px
    classDef backend fill:#FFE4C4,stroke:#333,stroke-width:1px
    classDef lib fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef plugin fill:#FFFACD,stroke:#333,stroke-width:1px
    classDef processing fill:#E6E6FA,stroke:#333,stroke-width:1px
    classDef persistence fill:#98FB98,stroke:#333,stroke-width:1px
    classDef cli fill:#F0E68C,stroke:#333,stroke-width:1px
    classDef deployment fill:#FFA07A,stroke:#333,stroke-width:1px
```
