Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

3.2 Datentypen und Formate

3.2 Datentypen und Formate

3.2.1 LexID

Siehe Kapitel 2.5 für die vollständige Definition.

3.2.2 UUID

Siehe Kapitel 2.5 für die vollständige Definition.

3.2.3 Weitere Datentypen

TypFormatBeispielValidierung
StringUTF-8"Bundesministerium"MUSS UTF-8 kodiert sein (Regel FMT-01FMT-01 Die Datei MUSS UTF-8-kodiert sein.).
NumberJSON Number42, 3.14, 1000.50MUSS eine JSON-konforme Zahl sein (IEEE 754 double) (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.). DARF ganzzahlige oder dezimale Werte darstellen.
BooleanBooleantrue, falseMUSS ein JSON Boolean (true oder false) sein (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.).
DateTimeRFC 3339"2024-01-01T12:00:00+01:00"MUSS ein date-time nach RFC 3339, Abschnitt 5.6 sein, das JSON-Schema-Format date-time (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.).
EnumString"draft", "inForce", "AND"MUSS ein in der Spezifikation definierter Wert sein (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.). Erlaubte Werte werden im jeweiligen Feld dokumentiert.
ObjectJSON Object{"key": "value"}MUSS ein JSON-Objekt sein (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.).
ArrayJSON Array[1, 2, 3]MUSS ein valides JSON Array sein (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.).

3.2.4 Hash-Format

Hashing und Integritätssicherung der RUML-Datei sind eine Aufgabe des RUML-Containers (siehe Kapitel 7). Die RUML-JSON-Datei enthält keinen Hash ihrer selbst. Die Hashes, die sie enthalten kann, gehören zu anderen Inhalten: derivedFrom.originalHash (3.3), der hash eines Context-Eintrags (4.11) und der digest eines Text-Eintrags (4.12).

Hash-Format (Referenz für Container-Ebene):

Hashes in RUML verwenden das erweiterte Format:

"{algorithm}:{value}"

Beispiel:

"sha3-256:4e03657aea45a94fc7d47c89e3f5a2b7c4d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2"

Unterstützte Algorithmen:

AlgorithmusVerwendungFormat
sha3-256MUSS für alle neuen Container verwendet werden64 hexadezimale Zeichen
sha256DARF für Rückwärtskompatibilität verwendet werden64 hexadezimale Zeichen
blake3DARF für performance-kritische Anwendungen verwendet werden64 hexadezimale Zeichen

Kanonische JSON-Repräsentation:

Für konsistente Hash-Berechnung auf Container-Ebene MUSS die RUML-Datei kanonisiert werden. Die Kanonisierung MUSS RFC 8785 (JSON Canonicalization Scheme) implementieren. Details zum Berechnungsverfahren siehe Kapitel 7.

Authentizität und rechtliche Verbindlichkeit:

Hashes allein gewährleisten keine Authentizität und keine rechtliche Verbindlichkeit. Diese Garantien werden durch Signaturen auf Container-Ebene erreicht (siehe Kapitel 7).

3.2.5 Integritätssicherung

Integritätssicherung — einschließlich Hashing, Signaturen und Zeitstempel — wird vollständig auf Container-Ebene behandelt (siehe Kapitel 7). Inline-Felder wie metadata.hash oder metadata.integrity sind nicht mehr Teil des RUML-Datenmodells.

3.2.6 RUML-Dateistruktur (Top-Level)

Die Top-Level-Struktur einer RUML-Datei ist in Kapitel 2.2 definiert.

Designprinzip: Key = Identifikator bei Map-Strukturen

RUML verwendet durchgängig das Prinzip, dass bei Map-Strukturen (JSON-Objekten) der Key selbst als Identifikator dient. Ein Eintrag DARF seinen eigenen Key daher NICHT als Feld wiederholen: Ein Knoten hat kein lexId-Feld, und Text-, Datapoint- und Context-Objekte haben keine eigene id (Regel FMT-14FMT-14 Ein DataPoint, Text-Eintrag oder Context-Eintrag DARF KEIN id-Feld haben; sein Schlüssel ist seine ID., 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.).

Andere Identifikatoren am Eintrag bleiben davon unberührt. Ein Knoten wird über seine LexID adressiert, trägt aber weiterhin ein ERFORDERLICHES Feld id mit seiner UUID (siehe Kapitel 2.5) — ein eigenständiger Identifikator, keine Kopie des Keys (Regel NODE-01NODE-01 Ein Knoten MUSS id und label haben.).

Dieses Prinzip gilt für alle Map-Strukturen in RUML:

nodes – Key ist die LexID (z.B. "1", "42")

capabilities[{id: "ruml:text-reference"}].data – Key ist die Text-ID (z.B. "text_bgb_823", "text_sgb_12_21")

capabilities[].data – Key ist die Artefakt-ID (z.B. "ctx_bgh_2024", "dp_monthly_income") für die Daten von ruml:datapoints, ruml:context usw.

Vorteile: Keine Redundanz, garantierte Eindeutigkeit durch JSON-Key-Semantik, einfachere Validierung.

Konformitätstests