Skip to content
RUMLRUML

Open Format for Digital Law

1.4 Conformance

1.4 Conformance

This specification defines conformance for four roles: RUML files, RUML parsers, RUML producers and RUML evaluators.

Conformant RUML File

A RUML file is conformant if it:

  • Satisfies the structural requirements of Chapters 2 and 3.
  • Satisfies the referential-integrity requirements for any declared capabilities (Chapter 4).
  • Satisfies the invariants defined in this specification.

A file delivered with a sidecar (.ruml-ext) or evaluation result (.ruml-result) MUST also conform to the corresponding format definitions in Chapter 4.5 and Chapter 5.

Conformant Parser

A parser is conformant if it:

  • Reads without error every conformant RUML file whose $specVersion it accepts (Chapter 2.3) and whose required capabilities it implements.
  • Performs the structural validation described in Chapter 2.6 and Chapter 3.8.
  • Reads the capabilities array first, as Chapter 4.6 requires, and implements the parser obligations catalogued in Chapter 8.7.
  • Processes the RUML Container Format according to Chapter 7.6 when a container is presented.
  • Rejects any file containing a capability declared with required: true that it does not implement (Rule CAP-01CAP-01 A parser MUST reject a file that declares a capability with required: true that the parser does not implement, and MUST NOT process such a file partially.).

A parser MAY additionally implement capability-specific processing for any capability it recognizes. Capability-specific processing rules are stated in each capability specification.

Conformant Producer

A producer is conformant if it:

  • Produces only files that are conformant in the sense above.
  • Sets $specVersion to a version the producer actually targets.
  • Never emits an undefined operator in any status other than draft.
  • Declares every used capability in the root capabilities array.

Conformant Evaluator

An evaluator determines the result of a rulemap. An evaluator is conformant if it:

  • Is a conformant parser.
  • Evaluates the operators as Chapter 3.6 defines, and modular nodes as Chapter 6 defines.
  • Evaluates every decision capability it implements as the specification of that capability defines.
  • Writes a result that conforms to Chapter 5 and carries the version that Chapter 2.3 requires.

Validation Tool

A validation tool is a conformant parser that additionally checks every rule of the catalogue in Chapter 8 whose layer is schema or semantic (Rule CAP-28CAP-28 A validation tool MUST check every rule of this catalogue whose layer is schema or semantic.).

Conformance Levels

This specification does not define multiple conformance levels. A file, parser, producer or evaluator either conforms or it does not.