org.apache.jena.shacl.Imports Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jena-shacl Show documentation
SHACL engine for Apache Jena
There is a newer version: 5.2.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jena.shacl;

import static org.apache.jena.atlas.iterator.Iter.iter;
import static org.apache.jena.sparql.graph.NodeConst.nodeOwlImports;
import static org.apache.jena.sparql.graph.NodeConst.nodeOwlOntology;
import static org.apache.jena.sparql.graph.NodeConst.nodeRDFType;

import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.apache.jena.atlas.lib.Pair;
import org.apache.jena.graph.Graph;
import org.apache.jena.graph.GraphUtil;
import org.apache.jena.graph.Node;
import org.apache.jena.irix.IRIs;
import org.apache.jena.riot.RDFDataMgr;
import org.apache.jena.riot.RiotParseException;
import org.apache.jena.riot.other.G;
import org.apache.jena.riot.other.RDFDataException;
import org.apache.jena.sparql.graph.GraphFactory;

/**
 * Import processing.
 * 
 * Imports are triggered by a base (a single triple "? rdf:type owl:Ontology")
 * and imports (triples "base owl:Imports URI").
 * 
 * If there are other "? owl:imports ?" triples, they are ignored.
 */
public class Imports {
    private Imports() {}

    /**
     * Load a graph and process owl:imports to create a new, single graph.
     */
    public static Graph loadWithImports(String url) {
        url = IRIs.resolve(url);
        Graph graph = RDFDataMgr.loadGraph(url);
        return withImportsWorker(url, graph);
    }

    /**
     * Process and return the owl:imports closure of a graph. The graph is included
     * in the results. Note that without knowing the URI, the start graph may be read
     * again if it is named as an import.
     */
    public static Graph withImports(Graph graph) {
        return withImportsWorker(null, graph);
    }

    /**
     * Process and return the owl:imports closure of a graph.
     * The graph is included in the results.
     */
    public static Graph withImports(String url, Graph graph) {
        url = IRIs.resolve(url);
        return withImportsWorker(url, graph);
    }

    private static Graph withImportsWorker(String url, Graph graph) {
        // Partial check for any imports. Are there any imports triples?
        boolean hasImports = G.contains(graph, null, nodeOwlImports, null);
        if ( ! hasImports )
            return graph;
        // Probably some work to do.
        // This is "import self", and start the "visited".
        Graph acc = GraphFactory.createDefaultGraph();
        GraphUtil.addInto(acc, graph);
        Set visited = new HashSet<>();
        if ( url != null )
            visited.add(url);
        processImports(visited, graph, acc);
        return acc;
    }

    /** Carefully traverse the imports, loading graphs. */
    private static void processImports(Set visited, Graph graph, Graph acc) {
        List imports = imports(graph);
        for ( Node imported : imports ) {
            if ( ! imported.isURI() )
                // Ignore non-URIs.
                continue;
            String uri = imported.getURI();
            if ( visited.contains(uri) )
                continue;
            visited.add(uri);
            // Read into a temporary graph to isolate errors.
            try {
                Graph g2 = RDFDataMgr.loadGraph(uri);
                GraphUtil.addInto(acc, g2);
                processImports(visited, g2, acc);
            } catch (RiotParseException ex) {
                //FmtLog.error(Imports.class, "Parse error reading '%s': %s", uri, ex.getMessage());
                throw ex;
            }
        }
    }

    /** Return the imports for a graph */
    public static List imports(Graph graph) {
        Pair> pair = baseAndImports(graph);
        return pair.getRight();
    }

    /**
     * Locate the base (a single triple ? rdf:type owl:Ontology)
     * and imports (triples "base owl:Imports URI").
     * May return null for the base in which case all imports are returned.
     *
     */
    public static Pair> baseAndImports(Graph graph) {
        Node base = null;
        if ( G.containsOne(graph, null, nodeRDFType, nodeOwlOntology) ) {
            base = G.getOnePO(graph, nodeRDFType, nodeOwlOntology);
        }
        List imports = allImports(base, graph);
        return Pair.create(base, imports);
    }

    /**
     * Locate the base (a single triple ? rdf:type owl:Ontology).
     * If none or more than one matching triple, then return null.
     */
    public static Node base(Graph graph) {
        // Filter for URI?
        try {
            return G.getZeroOrOnePO(graph, nodeRDFType, nodeOwlOntology);
        } catch (RDFDataException ex) { return null; }
    }

    /**
     * Locate any imports (triples "base owl:Imports URI").
     * Base may be a wildcard indicating "any owl:imports".
     */
    public static List allImports(Node base, Graph graph) {
        List imports = iter(G.listSP(graph, base, nodeOwlImports)).filter(Node::isURI).collect(Collectors.toList());
        return imports;
    }
}