org.apache.jena.ontapi.common.OntEnhNodeFactories Maven / Gradle / Ivy

Go to download
/*
 * 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.ontapi.common;

import org.apache.jena.enhanced.EnhGraph;
import org.apache.jena.enhanced.EnhNode;
import org.apache.jena.graph.FrontsNode;
import org.apache.jena.graph.Graph;
import org.apache.jena.graph.Node;
import org.apache.jena.graph.Triple;
import org.apache.jena.ontapi.model.OntObject;
import org.apache.jena.ontapi.utils.Iterators;
import org.apache.jena.ontapi.utils.StdModels;
import org.apache.jena.rdf.model.Model;
import org.apache.jena.rdf.model.RDFNode;
import org.apache.jena.rdf.model.Resource;
import org.apache.jena.rdf.model.Statement;
import org.apache.jena.reasoner.InfGraph;
import org.apache.jena.shared.PrefixMapping;
import org.apache.jena.util.iterator.ExtendedIterator;
import org.apache.jena.vocabulary.RDF;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.stream.Stream;

/**
 * A helper (factory) to produce {@link EnhNodeFactory EnhNode factories} instances or its components.
 */
public class OntEnhNodeFactories {

    @SafeVarargs
    public static EnhNodeFactory createFrom(EnhNodeFinder finder,
                                            Class type,
                                            Class... types) {
        return createFrom(finder,
                Stream.concat(Stream.of(type), Arrays.stream(types)).toList().stream());
    }

    public static EnhNodeFactory createFrom(EnhNodeFinder finder,
                                            Stream> types) {
        return createMulti(Objects.requireNonNull(finder, "Null finder"), types.map(WrappedEnhNodeFactory::new));
    }

    public static EnhNodeFactory createFrom(EnhNodeFinder finder,
                                            EnhNodeFactory factory,
                                            EnhNodeFactory... factories) {
        return createMulti(Objects.requireNonNull(finder, "Null finder"),
                Stream.concat(Stream.of(factory), Arrays.stream(factories)).toList().stream());
    }

    public static EnhNodeFactory createFrom(EnhNodeFactory factory,
                                            EnhNodeFactory... factories) {
        return createMulti(null,
                Stream.concat(Stream.of(factory), Arrays.stream(factories)).toList().stream());
    }

    public static EnhNodeFactory createCommon(Class impl,
                                              EnhNodeFinder finder,
                                              EnhNodeFilter filter,
                                              EnhNodeFilter... additional) {
        return createCommon(new EnhNodeProducer.Default(impl), finder, filter, additional);
    }

    public static EnhNodeFactory createCommon(Class impl,
                                              BiFunction producer,
                                              EnhNodeFinder finder,
                                              EnhNodeFilter filter) {
        return createCommon(new EnhNodeProducer.Default(impl, producer), finder, filter);
    }

    public static EnhNodeFactory createCommon(EnhNodeProducer maker, EnhNodeFinder finder, EnhNodeFilter primary, EnhNodeFilter... additional) {
        return new CommonEnhNodeFactoryImpl(Objects.requireNonNull(maker, "Null maker"),
                Objects.requireNonNull(finder, "Null finder"),
                Objects.requireNonNull(primary, "Null filter").accumulate(additional));
    }

    public static EnhNodeFactory createCommon(Class type,
                                              EnhNodeProducer maker,
                                              EnhNodeFinder finder,
                                              EnhNodeFilter filter) {
        Objects.requireNonNull(type, "Null type");
        return new CommonEnhNodeFactoryImpl(Objects.requireNonNull(maker, "Null maker"),
                Objects.requireNonNull(finder, "Null finder"),
                Objects.requireNonNull(filter, "Null filter")) {

            @Override
            public String toString() {
                return String.format("ObjectFactory[%s]", viewAsString(type));
            }
        };
    }

    public static EnhNodeFinder createFinder(Resource... types) {
        return createFinder(FrontsNode::asNode, types);
    }

    @SafeVarargs
    public static  EnhNodeFinder createFinder(Function asNode, R... types) {
        return eg -> Iterators.distinct(listTriplesForTypes(eg.asGraph(), asNode, types).mapWith(Triple::getSubject));
    }

    private static EnhNodeFactory createMulti(EnhNodeFinder finder, Stream factories) {
        return new CompositeEnhNodeFactoryImpl(finder, null,
                factories.peek(x -> Objects.requireNonNull(x, "Null component-factory")).toArray(EnhNodeFactory[]::new));
    }

    @SafeVarargs
    private static  ExtendedIterator listTriplesForTypes(Graph g, Function asNode, R... types) {
        return Iterators.flatMap(Iterators.of(types).mapWith(asNode), t -> g.find(Node.ANY, RDF.Nodes.type, t));
    }

    /**
     * Answers a short form of the given class-type.
     *
     * @param type {@code Class}-type, not {@code null}
     * @return String
     */
    public static String viewAsString(Class type) {
        return type.getName().replace(OntObject.class.getPackage().getName() + ".", "");
    }

    public static String toPrintString(Node node, EnhGraph graph) {
        if (!(graph instanceof Model m)) {
            return node.toString(PrefixMapping.Standard);
        }
        PrefixMapping pm = PrefixMapping.Factory.create()
                .setNsPrefixes((PrefixMapping) graph)
                .setNsPrefixes(PrefixMapping.Standard);
        if (m.getGraph() instanceof InfGraph) {
            return node.toString(pm);
        }
        RDFNode rdfNode = m.asRDFNode(node);
        if (!rdfNode.isResource()) {
            return node.toString(pm);
        }
        List properties = rdfNode.asResource().listProperties().toList();
        if (properties.isEmpty()) {
            return node.toString(pm);
        }
        StringBuilder sb = new StringBuilder("\n");
        properties.forEach(s -> sb.append(StdModels.toString(s, pm)).append("\n"));
        return sb.toString();
    }
}