# openbimrs/gaeb architecture

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

- Interactive diagram: https://gitdiagram.com/openbimrs/gaeb
- Repository: https://github.com/openbimrs/gaeb

## Overview

OpenBIM.rs GAEB is a Rust toolkit for lossless GAEB DA XML parsing, inspection, controlled quantity edits, and validation. The principal flow parses XML into an owned document while retaining original bytes and deriving metadata, diagnostics, and BoQ item views; callers can then inspect or atomically edit it. Separate validation branches provide business-rule checks (including cross-document exchange comparisons) and optional caller-supplied XSD validation dispatched by exact supported profiles. The graph follows explicit calls and README capability statements; unsampled subsystems are included where documented, with uncertain wiring omitted.

Main entry points: [`openbim-gaeb/src/parser.rs`](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/parser.rs) (XML parser), [`openbim-gaeb/src/xsd/collection.rs`](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/xsd/collection.rs) (Schema dispatcher), [`openbim-gaeb/src/business/mod.rs`](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/mod.rs) (Business validator), [`openbim-gaeb/src/business/single.rs`](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/single.rs) (Single-document rules)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Lossless core"]
  node_document["Owned document<br/>[document.rs]"]
  node_xmlparser["XML parser<br/>[parser.rs]"]
  node_metadata["Metadata<br/>[metadata.rs]"]
  node_items["BoQ item views<br/>[model.rs]"]
  node_diagnostics["Parse diagnostics<br/>[diagnostic.rs]"]
  node_quantityedit["Quantity editing<br/>[document.rs]"]
end

subgraph group_profiles["Profile support"]
  node_version["Version recognition<br/>[version.rs]"]
  node_phase["Exchange phases<br/>[phase.rs]"]
  node_support["Support matrix<br/>[support.rs]"]
end

subgraph group_checks["Validation"]
  node_xsdset["Schema dispatcher<br/>[collection.rs]"]
  node_xsdload["Schema loading<br/>[single.rs]"]
  node_businessapi["Business validator<br/>[mod.rs]"]
  node_singlechecks["Single-document rules<br/>[single.rs]"]
  node_pairchecks["Exchange-pair rules<br/>[pair.rs]"]
  node_xmltree["Business XML view<br/>[tree.rs]"]
  node_decimal["Exact decimal math<br/>[decimal.rs]"]
  node_validationreport["Validation report<br/>[validation.rs]"]
end

subgraph group_compat["Public interfaces"]
  node_bindings["Typed bindings<br/>[lib.rs]"]
  node_alias["Short-name re-export<br/>[lib.rs]"]
end

node_caller(("Library caller"))
node_schemafiles["Caller XSD files"]

node_caller -->|"parses XML"| node_document
node_document -->|"parses bytes"| node_xmlparser
node_xmlparser -->|"extracts metadata"| node_metadata
node_xmlparser -->|"extracts items"| node_items
node_xmlparser -->|"reports conflicts"| node_diagnostics
node_xmlparser -->|"recognizes versions"| node_version
node_xmlparser -->|"recognizes phases"| node_phase
node_caller -->|"edits quantity"| node_quantityedit
node_quantityedit -->|"reparses edit"| node_document
node_caller -->|"validates rules"| node_businessapi
node_businessapi -->|"validates document"| node_singlechecks
node_businessapi -->|"validates pair"| node_pairchecks
node_singlechecks -->|"builds XML view"| node_xmltree
node_pairchecks -.->|"compares XML views"| node_xmltree
node_singlechecks -->|"uses arithmetic"| node_decimal
node_pairchecks -->|"uses arithmetic"| node_decimal
node_businessapi -->|"returns report"| node_validationreport
node_caller -->|"loads schemas"| node_xsdset
node_xsdset -->|"loads XSDs"| node_schemafiles
node_xsdset -->|"loads schema roots"| node_xsdload
node_xsdset -->|"dispatches profile"| node_support
node_caller -.->|"opts into types"| node_bindings
node_caller -.->|"uses alias crate"| node_alias

click node_document "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/document.rs"
click node_xmlparser "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/parser.rs"
click node_metadata "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/metadata.rs"
click node_items "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/model.rs"
click node_diagnostics "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/diagnostic.rs"
click node_quantityedit "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/document.rs"
click node_version "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/version.rs"
click node_phase "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/phase.rs"
click node_support "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/support.rs"
click node_xsdset "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/xsd/collection.rs"
click node_xsdload "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/xsd/single.rs"
click node_businessapi "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/mod.rs"
click node_singlechecks "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/single.rs"
click node_pairchecks "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/pair.rs"
click node_xmltree "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/tree.rs"
click node_decimal "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/decimal.rs"
click node_validationreport "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/validation.rs"
click node_bindings "https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb-bindings/src/lib.rs"
click node_alias "https://github.com/openbimrs/gaeb/blob/main/gaeb/src/lib.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_document,node_xmlparser,node_metadata,node_items,node_diagnostics,node_quantityedit toneBlue
class node_version,node_phase,node_support toneAmber
class node_xsdset,node_xsdload,node_businessapi,node_singlechecks,node_pairchecks,node_xmltree,node_decimal,node_validationreport toneMint
class node_bindings,node_alias toneRose
class node_caller,node_schemafiles toneIndigo
```

## Components

### Lossless core

- [Owned document](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/document.rs): `openbim-gaeb/src/document.rs`
- [XML parser](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/parser.rs): `openbim-gaeb/src/parser.rs`
- [Metadata](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/metadata.rs): `openbim-gaeb/src/metadata.rs`
- [BoQ item views](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/model.rs): `openbim-gaeb/src/model.rs`
- [Parse diagnostics](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/diagnostic.rs): `openbim-gaeb/src/diagnostic.rs`
- [Quantity editing](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/document.rs): `openbim-gaeb/src/document.rs`

### Profile support

- [Version recognition](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/version.rs): `openbim-gaeb/src/version.rs`
- [Exchange phases](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/phase.rs): `openbim-gaeb/src/phase.rs`
- [Support matrix](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/support.rs): `openbim-gaeb/src/support.rs`

### Validation

- [Schema dispatcher](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/xsd/collection.rs): `openbim-gaeb/src/xsd/collection.rs`
- [Schema loading](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/xsd/single.rs): `openbim-gaeb/src/xsd/single.rs`
- [Business validator](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/mod.rs): `openbim-gaeb/src/business/mod.rs`
- [Single-document rules](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/single.rs): `openbim-gaeb/src/business/single.rs`
- [Exchange-pair rules](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/pair.rs): `openbim-gaeb/src/business/pair.rs`
- [Business XML view](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/tree.rs): `openbim-gaeb/src/business/tree.rs`
- [Exact decimal math](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/business/decimal.rs): `openbim-gaeb/src/business/decimal.rs`
- [Validation report](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb/src/validation.rs): `openbim-gaeb/src/validation.rs`

### Public interfaces

- [Typed bindings](https://github.com/openbimrs/gaeb/blob/main/openbim-gaeb-bindings/src/lib.rs): `openbim-gaeb-bindings/src/lib.rs`
- [Short-name re-export](https://github.com/openbimrs/gaeb/blob/main/gaeb/src/lib.rs): `gaeb/src/lib.rs`

### Other components

- **Library caller**
- **Caller XSD files**

## Connections

- Library caller → Owned document: parses XML (evidence: `openbim-gaeb/src/document.rs`)
- Owned document → XML parser: parses bytes (evidence: `openbim-gaeb/src/document.rs`)
- XML parser → Metadata: extracts metadata (evidence: `openbim-gaeb/src/lib.rs`)
- XML parser → BoQ item views: extracts items (evidence: `openbim-gaeb/src/lib.rs`)
- XML parser → Parse diagnostics: reports conflicts (evidence: `openbim-gaeb/src/lib.rs`)
- XML parser → Version recognition: recognizes versions (evidence: `openbim-gaeb/src/lib.rs`)
- XML parser → Exchange phases: recognizes phases (evidence: `openbim-gaeb/src/lib.rs`)
- Library caller → Quantity editing: edits quantity (evidence: `openbim-gaeb/src/document.rs`)
- Quantity editing → Owned document: reparses edit (evidence: `README.md`)
- Library caller → Business validator: validates rules (evidence: `openbim-gaeb/src/business/mod.rs`)
- Business validator → Single-document rules: validates document (evidence: `openbim-gaeb/src/business/mod.rs`)
- Business validator → Exchange-pair rules: validates pair (evidence: `openbim-gaeb/src/business/mod.rs`)
- Single-document rules → Business XML view: builds XML view (evidence: `openbim-gaeb/src/business/single.rs`)
- Exchange-pair rules → Business XML view: compares XML views (evidence: `openbim-gaeb/src/business/pair.rs`)
- Single-document rules → Exact decimal math: uses arithmetic (evidence: `openbim-gaeb/src/business/single.rs`)
- Exchange-pair rules → Exact decimal math: uses arithmetic (evidence: `openbim-gaeb/src/business/pair.rs`)
- Business validator → Validation report: returns report (evidence: `openbim-gaeb/src/business/mod.rs`)
- Library caller → Schema dispatcher: loads schemas (evidence: `openbim-gaeb/src/xsd/collection.rs`)
- Schema dispatcher → Caller XSD files: loads XSDs (evidence: `openbim-gaeb/src/xsd/collection.rs`)
- Schema dispatcher → Schema loading: loads schema roots (evidence: `openbim-gaeb/src/xsd/collection.rs`)
- Schema dispatcher → Support matrix: dispatches profile (evidence: `openbim-gaeb/src/xsd/collection.rs`)
- Library caller → Typed bindings: opts into types (evidence: `README.md`)
- Library caller → Short-name re-export: uses alias crate (evidence: `README.md`)
