Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

3.5 Node-Objekt

3.5 Node-Objekt (Kernarchitektur)

3.5.1 Knotentypen nach Rolle

In der flachen Map-Architektur sind alle Knoten direkt im nodes-Objekt gespeichert. Die Knotentypen ergeben sich aus ihrer logischen Rolle in der Hierarchie, die durch die lexId und children-Referenzen definiert wird:

TypLogische RolleBeschreibungErkennungsmerkmal
rootWurzelDer oberste Knoten der RulemapHat den Key "1" im nodes-Objekt (LexID 1)
parentVerzweigungKnoten mit eigenen KindernHat ein nicht-leeres children-Array
leafBlattEndknoten ohne KinderHat kein children-Array

Für die Knotentypen gelten folgende Regeln:

  • Der Root-Knoten MUSS vorhanden sein (Regel FMT-08FMT-08 rulemap.nodes MUSS einen Eintrag mit dem Schlüssel "1" enthalten, den Root-Knoten.).
  • Der Root-Knoten DARF NICHT im children-Array eines Knotens vorkommen (Regel NODE-05NODE-05 Der Root-Knoten "1" DARF in KEINEM children-Array vorkommen.).
  • Ein children-Array DARF NICHT leer sein (Regel NODE-06NODE-06 children DARF NICHT leer sein.).

Wichtig: Der Typ DARF NICHT explizit gespeichert werden, da er sich aus der Struktur ergibt (Regel NODE-03NODE-03 Ein Knoten DARF KEINE anderen Felder als die aus 3.5 haben; insbesondere DARF er NICHT seine LexID (lexId), seinen Parent-Node oder seinen Typ speichern.).

Laufzeit-Status: Der Auswertungsstatus eines Knotens (pending, true, false, undefined, ignored) wird zur Laufzeit berechnet und ist NICHT Teil der Node-Definition. Die Speicherung von Auswertungsergebnissen erfolgt ausschließlich in einer separaten RUML-Result-Datei (.ruml-result) (siehe Kapitel 5).

3.5.2 Pflichtfelder eines Knotens

FeldTypBeschreibung
idUUIDMUSS vorhanden sein (Regel NODE-01NODE-01 Ein Knoten MUSS id und label haben.). MUSS innerhalb der Datei eindeutig sein, auch gegenüber metadata.id (Regel NODE-08NODE-08 Die id eines Knotens DARF NICHT gleich der id eines anderen Knotens oder metadata.id sein.). MUSS dem Format aus 3.2.2 entsprechen (Regel FMT-10FMT-10 Jede UUID MUSS eine kleingeschriebene UUID der Version 4 sein (Muster in 2.5).).
labelStringMUSS eine menschenlesbare Bezeichnung enthalten (Regel NODE-01NODE-01 Ein Knoten MUSS id und label haben.). MUSS mindestens 1 Zeichen haben (Regel NODE-09NODE-09 label DARF NICHT leer sein.).

Hinweis zur LexID: Die LexID eines Knotens ergibt sich aus dem Key im nodes-Objekt (siehe 3.2.1). Ein separates lexId-Feld ist NICHT erforderlich und DARF NICHT verwendet werden (Regel NODE-03NODE-03 Ein Knoten DARF KEINE anderen Felder als die aus 3.5 haben; insbesondere DARF er NICHT seine LexID (lexId), seinen Parent-Node oder seinen Typ speichern.).

3.5.2a Das Feld operator

Das Feld operator (Typ Enum) legt fest, wie ein Knoten die Ergebnisse seiner Kinder verknüpft.

  • Ein Parent-Node MUSS einen operator haben; er gilt für ALLE direkten Kinder (Regel NODE-12NODE-12 Ein Knoten mit children MUSS operator haben.).
  • Ein Leaf-Node hat nichts zu verknüpfen. Er DARF KEINEN operator haben, außer metadata.status ist draft; in einem Entwurf DARF ein Leaf-Node jeden Operator haben, und ein Evaluator ignoriert ihn (Regel NODE-07NODE-07 Ein Parser MUSS die optionalen Knotenfelder aus 3.5.3 akzeptieren, ob vorhanden oder nicht, außer operator an einem Leaf-Node: Ein Leaf-Node DARF KEINEN operator haben, außer metadata.status ist draft; in einem Entwurf MUSS ein Parser jeden der acht Operatoren aus 3.6 an einem Leaf-Node akzeptieren.).
  • Der Wert MUSS einer der in 3.6 definierten Operatoren sein (Regel OP-01OP-01 operator MUSS einer der acht Werte aus 3.6 sein.).

3.5.3 Optionale Felder eines Knotens

Ein Knoten DARF jedes der folgenden Felder haben; ein Parser MUSS jedes davon akzeptieren, ob vorhanden oder nicht (Regel NODE-07NODE-07 Ein Parser MUSS die optionalen Knotenfelder aus 3.5.3 akzeptieren, ob vorhanden oder nicht, außer operator an einem Leaf-Node: Ein Leaf-Node DARF KEINEN operator haben, außer metadata.status ist draft; in einem Entwurf MUSS ein Parser jeden der acht Operatoren aus 3.6 an einem Leaf-Node akzeptieren.).

FeldTypBeschreibung
altTextStringDARF einen alternativen/vollständigen Text enthalten. SOLLTE für UI-Darstellung (Tooltips, Screen-Reader) verwendet werden. Wenn nicht gesetzt, SOLLTE label verwendet werden.
descriptionStringDARF eine ausführliche Beschreibung enthalten. DARF 10.000 Zeichen NICHT überschreiten (Regel NODE-11NODE-11 description DARF 10.000 Zeichen NICHT überschreiten.).
childrenArray[String]DARF eine geordnete Liste von Kind-Referenzen enthalten. Jeder Eintrag MUSS eine LexID-Referenz sein (String, siehe 2.5) (Regel FMT-11FMT-11 Jeder Schlüssel von rulemap.nodes und jeder Eintrag von children MUSS eine LexID sein, ein String, der ^[1-9][0-9]*$ entspricht.). Jede referenzierte LexID MUSS im nodes-Objekt existieren (Regel NODE-10NODE-10 Jeder Eintrag von children MUSS ein Schlüssel von rulemap.nodes sein.). Dieselbe LexID SOLLTE NICHT mehr als einmal in einem children-Array vorkommen. Die Reihenfolge ist signifikant.
capabilitiesArrayDARF capability-spezifische Daten für diesen Knoten enthalten, als geordnete Liste von { id, payload }-Einträgen; jeder Eintrag MUSS beide Felder haben (Regel CAP-17CAP-17 Jeder Eintrag der capabilities eines Knotens MUSS id und payload haben, und payload MUSS ein Objekt sein.). Jede id MUSS einer in der Datei deklarierten Capability entsprechen (Regel CAP-15CAP-15 Die id jedes Eintrags der capabilities eines Knotens MUSS in den Root-capabilities deklariert sein.). Über capabilities werden u.a. ruml:query, ruml:actions und ruml:ai-query bereitgestellt. Siehe Kapitel 4.3.
metadataObjectDARF zusätzliche Metadaten enthalten. SOLLTE für nicht-strukturelle Informationen verwendet werden.
decisionModeEnumDARF den Kombinationsmodus für mehrere entscheidungsrelevante Capabilities definieren. Nur relevant bei Leaf-Nodes mit mehr als einer decision-Capability. Erlaubte Werte: fallback, agreement, majority. Standard: fallback. Siehe Kapitel 4.3.
modularBooleanKennzeichnet den Knoten als modularen Knoten (Definition siehe 6.2). Ein modularer Knoten MUSS modular: true haben (Regel MOD-01MOD-01 Ein Knoten, dessen LexID mehr als einmal in den children-Arrays der Rulemap vorkommt (eine Selbstreferenz zählt mit), MUSS modular: true haben.); ein Knoten, der nicht modular ist, SOLLTE es NICHT haben.

Wichtige Regeln:

  • Einschränkungen für entscheidungsrelevante Capabilities (ruml:query, ruml:ai-query) werden in der jeweiligen Capability-Spezifikation definiert (siehe Kapitel 4.8)
  • Die Norm, die ein Knoten repräsentiert, und die Texte, auf die er sich bezieht, werden über den capabilities-Eintrag mit id: "ruml:text-reference" bereitgestellt (Anker in refs, siehe Kapitel 4.12)
  • Die id jedes Eintrags im capabilities-Array eines Knotens MUSS im Root-Level-capabilities-Array derselben Datei deklariert sein (referenzielle Integrität, Regel CAP-15 in Kapitel 08) (Regel CAP-15CAP-15 Die id jedes Eintrags der capabilities eines Knotens MUSS in den Root-capabilities deklariert sein.). Die vollständige Spezifikation findet sich in Kapitel 4.3.

Capability-gelieferte Node-Erweiterungen

Folgende Konzepte sind keine direkten Node-Felder, sondern werden über capabilities bereitgestellt:

CapabilityNode-FeldBeschreibung
ruml:querycapabilities-Eintrag id: "ruml:query"Datenbasierte Abfrage-Expression für Leaf-Nodes — siehe Kapitel 4.8
ruml:actionscapabilities-Eintrag id: "ruml:actions"Actions für onTrue, onFalse, onUndefined — siehe Kapitel 4.10
ruml:ai-querycapabilities-Eintrag id: "ruml:ai-query"LLM-basierte Entscheidung — siehe Kapitel 4.9
ruml:text-referencecapabilities-Eintrag id: "ruml:text-reference"Verweise auf normative Texte (Gesetze, Verordnungen) — siehe Kapitel 4.12

3.5.4 Knotenpositionen (Pfade)

Knotenpositionen (Pfade) werden zur Laufzeit aus der Baumstruktur berechnet und sind NICHT Teil der RUML-Datei. Die hierarchische Position eines Knotens ergibt sich vollständig aus den children-Arrays und der lexId-Struktur im nodes-Objekt.

Bei modularen Knoten (siehe Kapitel 6) kann derselbe Knoten über verschiedene Pfade im Baum erreicht werden. Die Pfade werden zur Laufzeit berechnet und im results-Objekt der RUML-Result-Datei (siehe Kapitel 5) als Schlüssel für die Auswertungsergebnisse verwendet.

Konformitätstests