1.3 Terminology
This section defines the terms used in this specification. Each term is summarized here; the
normative definition is in the chapter cited.
Roles
| Term | Definition | Defined in |
|---|
| Parser | Software that reads a RUML file. | 1.4 |
| Producer | Software that writes a RUML file. | 1.4 |
| Evaluator | Software that determines the result of a rulemap. | 1.4 |
| Validation tool | A parser that checks every schema and semantic rule. | 1.4 |
| Tool, implementation | Software in any of these roles. | 1.4 |
Identifiers
| Term | Definition | Defined in |
|---|
| LexID | Identifier of a node within a RUML file: a positive integer encoded as a string. | 2.5 |
| UUID | Globally unique identifier (UUID v4) of a RUML file (metadata.id) and of each node. | 2.5 |
Structural Elements
| Term | Definition | Defined in |
|---|
| Node | Element of the RUML hierarchy. | 3.5 |
| Root Node | The topmost node, with LexID 1. | 3.5.1 |
| Parent Node | Node with children. | 3.5.1 |
| Leaf Node | Node without children. | 3.5.1 |
| Modular Node | A reusable Node | 6.2 |
Normative Text Anchoring
| Term | Definition | Defined in |
|---|
| Anchor | Link from a node to a text of the same RUML file, or one of its elements: the norm the node represents, or a text it refers-to. | 4.12 |
| documentType | Kind of text a RUML file encodes, such as "law" or "regulation". | 3.3.6 |
Operators
| Term | Definition | Defined in |
|---|
| AND | Conjunction - all children MUST be true. | 3.6.1 |
| OR | Disjunction - at least one child MUST be true. | 3.6.2 |
| XOR | Disjunction over children constructed so that at most one can be true. | 3.6.3 |
| NOT_AND, NOT_OR, NOT_XOR | Negations of the corresponding operators. | |
| DELEGATED | Combination defined by a capability carried in the node. | 3.6.4 |
| undefined | Placeholder operator; permitted only in draft. | 3.6.5 |
Capabilities
| Term | Definition | Defined in |
|---|
| Capability | Declared extension that adds functionality without changing the core structure. | 4.1 |
| Capability role | Function that a capability fulfills in a rulemap, such as decision or data. | 4.1 |
| Capability namespace | Id prefix that determines ownership: ruml: (reserved), ruml:draft/ (experimental), or reverse-domain (third party). | 4.4 |
Status
| Term | Definition | Defined in |
|---|
| Document status | Validity state of a RUML file, such as draft or inForce. | 3.3.3 |
| Node status | Evaluation state of a node, such as true or false; not stored in the RUML file. | 5.0 |
| Term | Definition | Defined in |
|---|
| RUML file | Primary content file (.ruml). | 2.2 |
| RUML-EXT | Sidecar file (.ruml-ext) carrying capability data separately. | 4.5 |
| RUML Result file | File (.ruml-result) holding evaluation results. | 5 |
| Container | ZIP package providing integrity, signatures, and encryption. | 7 |
| Hash | Integrity check value of the form {algorithm}:{value}. | 7.3 |