annatto 0.52.0

Converts linguistic data formats based on the graphANNIS data model as intermediate representation and can apply consistency tests.
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
113
114
115
116
117
118
119
120
121
122
123
124
125

use std::{ffi::OsStr, io::BufWriter};

use anyhow::{Context, Error};
use graphannis::{
    AnnotationGraph,
    graph::{Edge, NodeID},
    model::AnnotationComponentType,
};
use graphannis_core::{
    annostorage::ValueSearch,
    graph::{ANNIS_NS, NODE_TYPE},
};
use quick_xml::events::{BytesDecl, Event};

use crate::{progress::ProgressReporter, util::CorpusGraphHelper};

use super::SaltWriter;

pub(super) struct SaltCorpusStructureMapper {}

impl SaltCorpusStructureMapper {
    pub(super) fn new() -> SaltCorpusStructureMapper {
        SaltCorpusStructureMapper {}
    }

    pub(super) fn map_corpus_structure(
        &self,
        graph: &AnnotationGraph,
        output_path: &std::path::Path,
        progress: &ProgressReporter,
    ) -> anyhow::Result<Vec<NodeID>> {
        let corpus_name = output_path
            .file_name()
            .unwrap_or_else(|| OsStr::new("corpus"));

        let mut documents = Vec::new();

        let project_file_path = output_path.join("saltProject.salt");
        let output_file = std::fs::File::create(&project_file_path)?;
        let buffered_output_file = BufWriter::new(output_file);
        let mut writer = quick_xml::Writer::new_with_indent(buffered_output_file, b' ', 2);

        writer.write_event(Event::Decl(BytesDecl::new("1.0", Some("UTF-8"), None)))?;

        let project_elem = writer
            .create_element("saltCommon:SaltProject")
            .with_attribute(("xmlns:sCorpusStructure", "sCorpusStructure"))
            .with_attribute(("xmlns:saltCommon", "saltCommon"))
            .with_attribute(("xmlns:saltCore", "saltCore"))
            .with_attribute(("xmlns:xmi", "http://www.omg.org/XMI"))
            .with_attribute(("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"))
            .with_attribute(("xsi:version", "2.0"));

        // The whole corpus is the equivalent of a corpus graph, so we only
        // output one sCorpusGraph and give it the name of the corpus.

        project_elem.write_inner_content::<_, Error>(|writer| {
            writer
                .create_element("sCorpusGraphs")
                .write_inner_content::<_, Error>(|writer| {
                    writer
                        .create_element("labels")
                        .with_attribute(("xsi:type", "saltCore:SFeature"))
                        .with_attribute(("namespace", "salt"))
                        .with_attribute(("name", "id"))
                        .with_attribute((
                            "value",
                            format!("T::{}", corpus_name.to_string_lossy()).as_str(),
                        ))
                        .write_empty()?;

                    let mut salt_writer =
                        SaltWriter::new(graph, writer, &project_file_path, progress)?;

                    let corpusgraph_helper = CorpusGraphHelper::new(graph);

                    // Map all corpus nodes in the graph
                    let corpus_nodes: graphannis_core::errors::Result<Vec<_>> = graph
                        .get_node_annos()
                        .exact_anno_search(Some(ANNIS_NS), NODE_TYPE, ValueSearch::Some("corpus"))
                        .collect();
                    let corpus_nodes = corpus_nodes?;

                    for n in corpus_nodes.iter() {
                        // Check if this is a document or a (sub)-corpus by testing if there are any incoming PartOfEdges
                        if corpusgraph_helper.is_document(n.node)? {
                            documents.push(n.node);
                            salt_writer
                                .write_graphannis_node(n.node, "sCorpusStructure:SDocument")?;
                        } else {
                            salt_writer
                                .write_graphannis_node(n.node, "sCorpusStructure:SCorpus")?;
                        }
                    }

                    // Map PartOf edges of this corpus/document
                    for partof_component in
                        graph.get_all_components(Some(AnnotationComponentType::PartOf), None)
                    {
                        let partof_gs = graph
                            .get_graphstorage_as_ref(&partof_component)
                            .with_context(|| {
                                format!("Missing graph storage for component {partof_component}")
                            })?;
                        for source in corpus_nodes.iter() {
                            let source = source.node;
                            for target in partof_gs.get_outgoing_edges(source) {
                                let target = target?;
                                let edge = Edge { source, target };
                                salt_writer.write_graphannis_edge(edge, &partof_component)?;
                            }
                        }
                    }

                    // Write out the layer XML nodes
                    salt_writer.write_all_layers()?;
                    Ok(())
                })?;

            Ok(())
        })?;

        Ok(documents)
    }
}