IF Commons GitHub

governance/elements

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0003-governance FR-005, 0003-governance FR-006

The elements of a domain and the graph they make (commons data 0003-governance FR-005, FR-006): every element with its identity, kind, name, definition, parent and annotations, in a fixed order, and the graph of what holds what and what refers to what. The logical and the physical layers link their own elements to these identities.

Source: commons/data/governance/elements.ts

2 of 6 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

Edgeinterfaceno test imports it
interface Edge

An edge of the trace graph.

MemberTypeWhat it is
fromElementId
toElementId
kindEdgeKind
EdgeKindtypeno test imports it
type EdgeKind = "contains" | "identifies" | "references";

What an edge of the trace graph says.

Elementinterfaceno test imports it
interface Element

An element of a domain.

MemberTypeWhat it is
idElementId
kindElementKind
namestring
definitionstring
parent?ElementIdWhat holds it; none for the domain.
annotationsreadonly Annotation[]
elementsOffunction
function elementsOf(d: Domain): readonly Element[]

Every element of a domain, in a fixed order: the domain, then each concept with its attributes and its relationships, then each code list with its codes.

ParameterWhat it is
dthe domain

Returns: the elements

Imported by 43 tests of the run (43 passed, 0 failed): the library's results

TraceGraphinterfaceno test imports it
interface TraceGraph

The elements of a domain and how they are joined.

MemberTypeWhat it is
nodesreadonly Element[]
edgesreadonly Edge[]
traceGraphfunction
function traceGraph(d: Domain): TraceGraph

The trace graph of a domain: its elements as nodes, and as edges contains (from an element to what it holds), identifies (from a concept to its identifying attributes) and references (from a relationship to the concept it points to, and from an attribute of a code list to the list).

ParameterWhat it is
dthe domain

Returns: the graph

Imported by 4 tests of the run (4 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.