cimoxide-schema 0.5.0

Parser for ENTSO-E RDFS application profile schemas (CGMES, NCP) into a typed specification model
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! Profile families.
//!
//! cimoxide reads two ENTSO-E schema trees that are structurally similar but not
//! identical: CGMES (grid models) and NCP (Network Code Profiles). A `Family`
//! captures every place the two diverge, so the importer and generator stay
//! branch-free and the CGMES output is provably unchanged when NC is added.

/// Everything that differs between one profile family and another.
#[derive(Debug)]
pub struct Family {
    /// Short identifier; also the `--families` token and the module name.
    pub id: &'static str,
    /// Prefix on `Element::type_name` and `CimDataset::by_type` keys.
    /// Empty for the default family, which keeps bare names so every existing
    /// consumer is untouched. `:` cannot occur in a CIM class name, so the two
    /// key spaces are provably disjoint.
    pub type_prefix: &'static str,
    /// Default RDFS glob, relative to the workspace root.
    pub default_schema: &'static str,
    /// Profile forced to priority 1 and used as the origin tie-break.
    /// `None` means pure alphabetical ordering.
    pub base_profile: Option<&'static str>,
    /// Namespaces added to `profile_namespaces` even when no class lives in them.
    pub extra_namespaces: &'static [(&'static str, &'static str)],
    /// NCP writes the classifying `cims:stereotype` first and trails profile tags
    /// (`NC`, `profcim`, `deprecated`), so it needs first-match classification.
    /// CGMES relies on the historical last-wins reading.
    pub stereotype_first_wins: bool,
    /// `(TTL file stem, profile tag)` for a family whose SHACL ships no
    /// per-profile manifests. `None` reads them from `SHACL/Validation/`.
    pub shacl_manifest: Option<&'static [(&'static str, &'static str)]>,
}

pub const CGMES: Family = Family {
    id: "cgmes",
    type_prefix: "",
    default_schema:
        "application-profiles-library/CGMES/RDFS/61970-600-2_*-AP-Voc-RDFS2020.rdf",
    base_profile: Some("EQ"),
    extra_namespaces: &[
        ("md", "http://iec.ch/TC57/61970-552/ModelDescription/1#"),
        ("rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#"),
    ],
    stereotype_first_wins: false,
    shacl_manifest: Some(crate::shacl::cgmes_manifest::MANIFEST),
};

// NCP's DatasetMetadata profile keyword is "DM", which reads like the `dm` XML
// prefix bound to DifferenceModel in CGMES. They are unrelated: profile codes and
// namespace prefixes live in different tables.
pub const NC: Family = Family {
    id: "nc",
    type_prefix: "nc:",
    default_schema: "application-profiles-library/NCP/RDFS/*-AP-Voc-RDFS2020.rdf",
    base_profile: None,
    extra_namespaces: &[("rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#")],
    stereotype_first_wins: true,
    shacl_manifest: None,
};

pub const FAMILIES: &[&Family] = &[&CGMES, &NC];

pub fn by_id(id: &str) -> Option<&'static Family> {
    FAMILIES.iter().copied().find(|f| f.id == id)
}