4.16 ruml:tree-include
4.16 Capability ruml:tree-include
Überblick
| Eigenschaft | Wert |
|---|---|
| Capability-ID | ruml:tree-include |
| Scope | Root-Level (nur Deklaration) + Node-Level |
Standard required | false |
| Node-Level | payload.uri des ruml:tree-include-Eintrags am Knoten |
| Rolle | decision |
Diese Capability macht einen Leaf-Node zum Platzhalter für den Teilbaum eines Knotens einer anderen RUML-Datei: Der referenzierte Teilbaum wird an Stelle des Leaf-Nodes ausgewertet, und sein Status wird zum Status des Leaf-Nodes.
Sie ergänzt ruml:tree-reference, das nur auf Knoten anderer Dateien
verweist. Beide verwenden dieselben Knotenanker; es sind
zwei Capabilities, weil eine Capability genau eine Rolle hat (siehe
Kapitel 4.1).
Warum „include“: Der Name beschreibt die Beziehung aus Sicht des einbindenden Knotens — der
referenzierte Teilbaum ist genau an dieser Stelle Teil dieser Rulemap, ohne kopiert zu werden, wie
bei Akoma Ntoso componentRef, XInclude oder DITA conref.
Abgrenzung zu modularen Knoten: Modulare Knoten verwenden einen
Teilbaum innerhalb derselben Datei wieder. ruml:tree-include wertet den referenzierten
Teilbaum aus wie eine Instanz eines modularen Knotens, dessen Definition in einer anderen Datei
liegt.
Root-Level-Deklaration
"capabilities": [ { "id": "ruml:tree-include" }]Der Root-Level-Eintrag DARF KEINE Payload haben (Regel TREE-01TREE-01 Die Root-Level-Einträge von ruml:tree-reference und ruml:tree-include DÜRFEN KEINE Payload haben. Die ruml:tree-reference-Payload eines Knotens MUSS represents, refersTo (mit mindestens einem Eintrag) oder beide enthalten, und represents und jeder refersTo-Eintrag MÜSSEN genau uri haben; die ruml:tree-include-Payload eines Knotens MUSS uri enthalten. Beide Payloads DÜRFEN KEINE weiteren Felder enthalten.).
Node-Level: Der eingebundene Knoten
{ "id": "ruml:tree-include", "payload": { "uri": "https://rulemapping.org/rulemapping/gmbhg:2025-01-01#node/6e51c5a6-f7ff-43e1-b211-c70bd69937d7" }}| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
uri | String | MUSS | Ein Knotenanker auf den eingebundenen Knoten: <ruml-version-uri>#node/<id>. |
Validierungsregeln:
- Die Payload MUSS
urienthalten und DARF KEINE weiteren Felder enthalten (Regel TREE-01TREE-01 Die Root-Level-Einträge vonruml:tree-referenceundruml:tree-includeDÜRFEN KEINE Payload haben. Dieruml:tree-reference-Payload eines Knotens MUSSrepresents,refersTo(mit mindestens einem Eintrag) oder beide enthalten, undrepresentsund jederrefersTo-Eintrag MÜSSEN genauurihaben; dieruml:tree-include-Payload eines Knotens MUSSurienthalten. Beide Payloads DÜRFEN KEINE weiteren Felder enthalten.), unduriMUSS ein Knotenanker sein (Regel TREE-02TREE-02 Jedeurieiner Baumreferenz oder Einbindung MUSS ein Knotenanker<ruml-version-uri>#node/<id>sein; ein Anker innerhalb des Dokuments (#node/…) ist keiner.). - Ein Knoten mit
ruml:tree-includeDARF KEINE Kinder haben (Regel CAP-07CAP-07 Ein Eintrag einer Capability mit der RolledecisionDARF NICHT an einem Knoten mitchildrenvorkommen.). - Ein Knoten mit
ruml:tree-includeDARF in seinerruml:tree-referenceKEINrepresentshaben (Regel TREE-08TREE-08 Ein Knoten mitruml:tree-includeDARF in seinerruml:tree-referenceKEINrepresentshaben.): Ein Knoten, der einen anderen Knoten einbindet, steht bereits für ihn. - Die Regeln für Knotenanker aus Kapitel 4.15 gelten:
eine unveränderliche Version, dieselbe Version für alle Knotenanker in eine Datei
(
Regel TREE-06TREE-06 Ein Knotenanker MUSS eine unveränderliche RUML-Version benennen; eine Datei, die exportiert oder ausgetauscht wird, DARF KEINEN Anker ohne Version enthalten. Alle Knotenanker einer Datei in dieselbe andere RUML-Datei MÜSSEN dieselbe Version davon verwenden.), und der Zielknoten existiert in dieser Version (Regel TREE-04TREE-04 Der Zielknoten eines Knotenankers MUSS in der referenzierten Version existieren.). - Einbindungen DÜRFEN KEINEN Zyklus über Dateien hinweg bilden (
Regel TREE-09TREE-09 Einbindungen DÜRFEN KEINEN Zyklus über Dateien hinweg bilden, weder direkt noch über weitere Dateien.): Datei A bindet einen Knoten von B ein, und B einen Knoten von A — direkt oder über weitere Dateien.
Mehrere Teilbäume einbinden
Um mehrere Teilbäume einzubinden, verwendet eine Rulemap mehrere Platzhalterknoten. Der Baum legt
dann alles fest, was die Kombination braucht: Die Reihenfolge ist die Reihenfolge der Kinder, die
Verknüpfung ist der Operator des Parent-Nodes, eine Negation ist ein Parent-Node mit einem
NOT_…-Operator (siehe Kapitel 3.6), und jede Einbindung hat
ihr eigenes Label, ihre eigene Erläuterung, eigene Textreferenzen und ein eigenes Ergebnis.
„Gesellschaft wirksam gegründet“ AND├── „Gesellschaftsvertrag notariell beurkundet“ include → gmbhg:2025-01-01#node/6e51…├── „Stammkapital mind. 25.000 €“ include → gmbhg:2025-01-01#node/7791…└── „Eintragung ins Handelsregister“ (eigene Logik)Wie bei modularen Knoten ist Wiederverwendung als Knoten im Baum sichtbar, nicht als verborgene zusätzliche Kinder.
Auswertung
Ein Tool löst den eingebundenen Knoten auf (siehe
Auflösung und Anzeige), wertet ihn mit seinem
Teilbaum nach den Regeln der referenzierten Datei aus und verwendet den ermittelten Status als
Ergebnis der Capability. Hat der Leaf-Node weitere decision-Capabilities, verknüpft decisionMode
ihre Ergebnisse (siehe Kapitel 4.3).
In dieser Version nicht definiert: Wie der eingebundene Teilbaum seine Eingaben erhält — die
Datenpunkte und Fragen, die seine Leaf-Nodes auswerten —, ist in dieser Version der Spezifikation
nicht definiert. Erwogen werden Eingaben, die mit der einbindenden Datei über die Datenpunkt-id
geteilt werden, Eingaben mit einem eigenen Namensraum je referenzierter Datei und eine ausdrückliche
Bindung je Einbindung.
Ein Tool, das eine Einbindung nicht auswerten kann — weil es ruml:tree-include nicht unterstützt
oder weil die referenzierte Version oder der referenzierte Knoten nicht geladen werden kann —,
MUSS undefined als ihr Ergebnis verwenden (siehe
Kapitel 5.0); der Knoten DARF NICHT als erfüllt
behandelt werden.
Verhalten bei modularen Knoten: Eine Einbindung an einem modularen Knoten (modular: true) gilt
für alle Instanziierungen.