unibremen/informatik/OWL2Parser.java

	OWL2Parser.java revision 53680982da7898ae889870da416205a85f0bffad
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.net.URI;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Set;

import org.coode.owlapi.owlxml.renderer.OWLXMLRenderer;
import org.coode.owlapi.rdf.rdfxml.RDFXMLRenderer;
import org.semanticweb.owlapi.apibinding.OWLManager;
import org.semanticweb.owlapi.io.OWLRendererException;
import org.semanticweb.owlapi.io.StreamDocumentSource;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.MissingImportEvent;
import org.semanticweb.owlapi.model.MissingImportHandlingStrategy;
import org.semanticweb.owlapi.model.MissingImportListener;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration;
import org.semanticweb.owlapi.model.OWLOntologyManager;
import org.semanticweb.owlapi.util.OWLOntologyMerger;

import uk.ac.manchester.cs.owl.owlapi.OWLOntologyIRIMapperImpl;
import uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.ManchesterOWLSyntaxRenderer;

public class OWL2Parser {

    private static enum OPTION {
        OWL_XML, MANCHESTER, RDF_XML, OBO, TURTLE
    }

    private static Boolean quick = false;
    private static Boolean cyclic = false;
    protected static final Set<IRI> missingImports = new HashSet<IRI>();
    private static Set<OWLOntology> ontologies;
    private static final Set<OWLOntology> exported = new HashSet<OWLOntology>();
    private static OWLOntologyManager manager =
        setupManagerWithMissingImportListener();
    private static OWLOntologyIRIMapperImpl mapper =
        new OWLOntologyIRIMapperImpl();
    private static URI uri = null;

    public static void main(String[] args) {
        // A simple example of how to load and save an ontology
        try {
            OWLOutputHandler out = new OWLOutputHandler();
            parseArgs(args, out);
            URLConnection con = uri.toURL().openConnection();
            con.addRequestProperty("Accept", "text/plain");
            StreamDocumentSource sds =
                new StreamDocumentSource(con.getInputStream(), IRI.create(uri));
            OWLOntologyLoaderConfiguration config =
                new OWLOntologyLoaderConfiguration();
            config = config
                .setMissingImportHandlingStrategy(MissingImportHandlingStrategy.SILENT);
            OWLOntology ontology =
                manager.loadOntologyFromOntologyDocument(sds, config);
            if ( !missingImports.isEmpty()) {
                IRI ontohub = IRI.create("https://ontohub.org/external/");
                for (IRI mi : missingImports) {
                    mapper.addMapping(mi, ontohub.resolve(mi.toURI().getHost()
                        + mi.toURI().getPath()));
                }
                // reset the manager. clear out imports to avoid duplicates
                manager = setupManagerWithMissingImportListener();
                manager.addIRIMapper(mapper);
                // collect missing imports again to report them in output file.
                missingImports.clear();
                ontology =
                    manager.loadOntologyFromOntologyDocument(sds, config);
            }
            ontologies = getImports(ontology, new HashSet<OWLOntology>());
            out._open();
            if (cyclic) {
                String str = ontology.getOntologyID().getOntologyIRI().toString();
                // we must make a new name
                String merged_name = str + ".merged.owl";
                // System.out.println("NAME: " + merged_name + "\n");
                IRI mergedOntologyIRI = IRI.create(merged_name);
                // System.out.println("MERGED_IRI " + mergedOntologyIRI + "\n");
                OWLOntology merged;
                // Axioms can be excluded when 'quick' Option selected
                if (quick) {
                    merged = manager.createOntology(mergedOntologyIRI);
                } else {
                    OWLOntologyMerger merger = new OWLOntologyMerger(manager);
                    merged =
                        merger.createMergedOntology(manager, mergedOntologyIRI);
                }
                out.renderUsingOption(merged);
            } else {
                ontologies.add(ontology);
                exportImports(out);
            }
            out._close();
        } catch (Exception ex) {
            System.err.println("OWL parse error: " + ex.getMessage());
            ex.printStackTrace();
        }
    }

    // print usage information screen
    private static void showHelpScreen() {
        System.out.println("Usage: processor [<options..>] <URI>\n"
            + "_>_options_<______________\n"
            + " | -o <tp> <fn>  ..write output to file\n"
            + " - - - tp  <- type [: owl xml omn rdf obo dol ttl]\n"
            + " - - - fn  <- filename\n"
            + " | -o-sys <tp> ..write output to system.out\n"
            + " - - - - - tp  <- type\n"
            + " | -qk  ..internal(!) sets 'quick' option\n"
            + " | -h  ..this helptext");
    }

    // parse arguments according to option set
    // fails for unknown or incomplete arguments, or when IRI is not set
    private static void parseArgs(String[] args, OWLOutputHandler out)
        throws Exception
    {
        String inp = "", msg = "OWL2Parser.parseArgs: ";
        if (args.length == 0) {
            throw new Exception(msg + "no arguments provided");
        }
        for (int i = 0; i < args.length; i++ ) {
            String arg = args[i].toLowerCase();
            if (arg.startsWith("-")) {
                if (arg.equals("-o")) {
                    if (!(i < args.length - 2)) {
                        throw new Exception(msg
                            + "insufficient arguments (-o [format] [filename])");
                    }
                    out.add(parseOption(args[++i].toLowerCase(), msg), args[++i]);
                } else if (arg.equals("-o-sys")) {
                    if (!(i < args.length - 1)) {
                        throw new Exception(msg
                            + "insufficient arguments (-o-sys [format])");
                    }
                    out.add(parseOption(args[ ++i].toLowerCase(), msg));
                } else if (arg.equals("-qk") || arg.equals("-q")) {
                    quick = true;
                } else if (arg.equals("-h") || arg.equals("--help")) {
                    showHelpScreen();
                } else {
                    throw new Exception(msg + "unknown command <" + arg + ">");
                }
            } else {
                if (!inp.equals("")) {
                    throw new Exception(msg + "ambigious IRI");
                }
                inp = args[i]; // read again to undo earlier 'toLowerCase'
                if (arg.startsWith("http:") || arg.startsWith("https:")) {
                    uri = new URI(inp);
                } else {
                    uri = new File(inp).toURI();
                }
            }
        }
        if (inp.equals("")) {
            throw new Exception(msg + "IRI not set");
        }
    }

    private static OPTION parseOption(String opt, String err) throws Exception {
        if (opt.equals("xml") || opt.equals("owl")) {
            return OPTION.OWL_XML;
        } else if (opt.equals("omn")) {
            return OPTION.MANCHESTER;
        } else if (opt.equals("rdf")) {
            return OPTION.RDF_XML;
        } else if (opt.equals("obo")) {
            return OPTION.OBO;
        } else if (opt.equals("ttl")) {
            return OPTION.TURTLE;
        }
        throw new Exception(err + "unrecognized owl-format: " + opt);
    }

    private static OWLOntologyManager setupManagerWithMissingImportListener() {
        OWLOntologyManager mgr = OWLManager.createOWLOntologyManager();
        mgr.addMissingImportListener(new HasMissingImports());
        return mgr;
    }

    private static class HasMissingImports implements MissingImportListener {
        @Override
        public void importMissing(MissingImportEvent event) {
            missingImports.add(event.getImportedOntologyURI());
        }
    }

    private static Set<OWLOntology> getImports(OWLOntology ontology,
        Set<OWLOntology> stop)
    {
        Set<OWLOntology> s = new HashSet<OWLOntology>();
        Set<OWLOntology> next = new HashSet<OWLOntology>(stop);
        next.add(ontology);
        for (OWLOntology imported : ontology.getDirectImports()) {
            if (cyclic || next.contains(imported)) {
                cyclic = true;
            } else if (!s.contains(imported)) {
                Set<OWLOntology> i = getImports(imported, next);
                s.add(imported);
                s.addAll(i);
            }
        }
        return s;
    }

    private static void exportImports(OWLOutputHandler out) throws IOException {
        Boolean changed;
        do {
            changed = false;
            for (OWLOntology onto : ontologies) {
                if (exported.containsAll(onto.getDirectImports())) {
                    if (!exported.contains(onto)) {
                        changed = exported.add(onto);
                        out.renderUsingOption(onto);
                    }
                }
            }
        } while (changed);
    }

    // output handler allows and handles a list of output-requests
    protected static class OWLOutputHandler {
        static ArrayList<OWLOntologyWriter> writer =
            new ArrayList<OWLOntologyWriter>();

        void add(OPTION op) throws Exception {
            writer.add(new OWLOntologyWriter(op));
        }

        void add(OPTION op, String filename) throws Exception {
            writer.add(new OWLOntologyWriter(filename, op));
        }

        void _open() throws IOException {
            for (OWLOntologyWriter out : writer) {
                out._open();
            }
        }

        void _close() throws IOException {
            for (OWLOntologyWriter out : writer) {
                out._close();
            }
        }

        // function need to be called once to render and close every output
        void renderUsingOption(OWLOntology onto) throws IOException {
            for (OWLOntologyWriter out : writer) {
                out.renderUsingOption(onto);
            }
        }
    }

    // custem OntolgyWriter bundles a BufferedWriter with an OWL output format
    protected static class OWLOntologyWriter extends BufferedWriter {
        protected static OPTION option;

        OWLOntologyWriter(String fn, OPTION op) throws Exception {
            super(new FileWriter(fn));
            option = op;
        }

        OWLOntologyWriter(OPTION op) throws Exception {
            super(new OutputStreamWriter(System.out));
            option = op;
        }

        void writeMissingImports() throws IOException {
            for (IRI mi : missingImports) {
                write("<Missing>" + mi + "</Missing>\n");
            }
        }

        void _open() throws IOException {
            if (option == OPTION.OWL_XML) {
                write("<Ontologies>\n");
            }
        }

        void _close() throws IOException {
            if (option == OPTION.OWL_XML) {
                writeMissingImports();
                write("\n</Ontologies>\n");
            }
            _close(this);
        }

        void _close(Writer pointer) throws IOException {
            pointer.flush();
            pointer.close();
        }

        void renderUsingOption(OWLOntology onto) throws IOException {
            switch (option) {
                case OWL_XML:
                    renderAsXml(onto);
                    break;
                case MANCHESTER:
                    renderAsOmn(onto);
                    break;
                case RDF_XML:
                    renderAsRdf(onto);
                    break;
                // TODO: the below still need implementation!
                case OBO:
                    renderAsXml(onto);
                    break;
                case TURTLE:
                    renderAsXml(onto);
                    break;
            }
        }

        void renderAsOmn(OWLOntology onto) {
            try {
                ManchesterOWLSyntaxRenderer omnrend =
                    new ManchesterOWLSyntaxRenderer();
                omnrend.render(onto, this);
            } catch (OWLRendererException ex) {
                System.err.println("Error by ManchesterParser!");
                ex.printStackTrace();
            }
        }

        void renderAsXml(OWLOntology onto) {
            try {
                OWLXMLRenderer xmlren = new OWLXMLRenderer();
                File tempFile = File.createTempFile("owlTemp_1", ".xml");
                FileWriter buf = new FileWriter(tempFile);
                if (quick) {
                    onto.getOWLOntologyManager()
                        .removeAxioms(onto,onto.getAxioms());
                }
                xmlren.render(onto, buf);
                _close(buf);
                BufferedReader rBuf =
                    new BufferedReader(new FileReader(tempFile));
                rBuf.readLine(); // ignore the first line containing <?xml version="1.0"?>
                while (rBuf.ready()) {
                    append(rBuf.readLine()).append("\n");
                }
                rBuf.close();
                tempFile.deleteOnExit();
                append("<Loaded name=\"")
                    .append(manager.getOntologyDocumentIRI(onto));
                append("\" ontiri=\"")
                    .append(onto.getOntologyID().getOntologyIRI());
                append("\"/>\n");
            } catch (Exception ex) {
                System.err.println("Error by XMLParser!");
                ex.printStackTrace();
            }
        }

        void renderAsRdf(OWLOntology onto) {
            try {
                RDFXMLRenderer rdfrend = new RDFXMLRenderer(onto, this);
                rdfrend.render();
            } catch (IOException ex) {
                System.err.println("Error by RDFParser!");
                ex.printStackTrace();
            }
        }
    }
}