ontocore-diff 0.14.0

Semantic ontology diff for OntoCore
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum EntityChangeKind {
    Added,
    Removed,
    Renamed,
    Deprecated,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityChange {
    pub kind: EntityChangeKind,
    pub iri: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub previous_iri: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub labels: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AxiomChange {
    pub change: String,
    pub subject: String,
    pub predicate: String,
    pub object: String,
    pub axiom_kind: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AnnotationChange {
    pub change: String,
    pub subject: String,
    pub predicate: String,
    pub object: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImportChange {
    pub change: String,
    pub ontology_id: String,
    pub import_iri: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InferenceChange {
    pub class_iri: String,
    pub change: String,
    pub detail: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum BreakingReason {
    RemovedEntity,
    RenamedIri,
    RemovedSuperclass,
    RemovedImport,
    UnsatisfiableClass,
    DomainRangeChange,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BreakingChange {
    pub reason: BreakingReason,
    pub message: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entity_iri: Option<String>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DiffResult {
    pub entity_changes: Vec<EntityChange>,
    pub axiom_changes: Vec<AxiomChange>,
    pub annotation_changes: Vec<AnnotationChange>,
    pub import_changes: Vec<ImportChange>,
    pub inference_changes: Vec<InferenceChange>,
    pub breaking_changes: Vec<BreakingChange>,
}

impl DiffResult {
    pub fn is_empty(&self) -> bool {
        self.entity_changes.is_empty()
            && self.axiom_changes.is_empty()
            && self.annotation_changes.is_empty()
            && self.import_changes.is_empty()
            && self.inference_changes.is_empty()
            && self.breaking_changes.is_empty()
    }

    pub fn summary_counts(&self) -> DiffSummaryCounts {
        DiffSummaryCounts {
            entities: self.entity_changes.len(),
            axioms: self.axiom_changes.len(),
            annotations: self.annotation_changes.len(),
            imports: self.import_changes.len(),
            inferences: self.inference_changes.len(),
            breaking: self.breaking_changes.len(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DiffSummaryCounts {
    pub entities: usize,
    pub axioms: usize,
    pub annotations: usize,
    pub imports: usize,
    pub inferences: usize,
    pub breaking: usize,
}