All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.xowl.infra.store.ProxyObject Maven / Gradle / Ivy

Go to download

Provides storage and querying facilities for xOWL ontologies and RDF graphs

There is a newer version: 2.3.4
Show newest version
/*******************************************************************************
 * Copyright (c) 2015 Laurent Wouters
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 *
 * Contributors:
 *     Laurent Wouters - [email protected]
 ******************************************************************************/
package org.xowl.infra.store;

import org.xowl.infra.lang.owl2.IRI;
import org.xowl.infra.lang.owl2.Ontology;
import org.xowl.infra.store.owl.DynamicNode;
import org.xowl.infra.store.rdf.*;
import org.xowl.infra.store.storage.UnsupportedNodeType;
import org.xowl.infra.utils.collections.*;
import org.xowl.infra.utils.logging.Logger;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

/**
 * Represents an object in an ontology
 *
 * @author Laurent Wouters
 */
public class ProxyObject {
    /**
     * The parent repository
     */
    protected Repository repository;
    /**
     * The containing ontology
     */
    protected Ontology ontology;
    /**
     * The represented entity as a subject RDF node
     */
    protected SubjectNode subject;

    /**
     * Initializes this object
     *
     * @param repository The parent repository
     * @param ontology   The containing ontology
     * @param subject    The represented entity as a subject RDF node
     */
    protected ProxyObject(Repository repository, Ontology ontology, SubjectNode subject) {
        this.repository = repository;
        this.ontology = ontology;
        this.subject = subject;
    }

    /**
     * Gets the parent repository
     *
     * @return The parent repository
     */
    public Repository getRepository() {
        return repository;
    }

    /**
     * Gets the containing ontology
     *
     * @return The containing ontology
     */
    public Ontology getOntology() {
        return ontology;
    }

    /**
     * Gets the represented entity as an RDF IRI node
     *
     * @return The represented entity as an RDF IRI node
     */
    protected SubjectNode getNode() {
        return subject;
    }

    /**
     * Gets the IRI of this object
     *
     * @return The IRI of this object
     */
    public IRI getIRI() {
        return subject.getNodeType() == Node.TYPE_IRI ? repository.getIRI(((IRINode) subject).getIRIValue()) : null;
    }

    /**
     * Gets the value of the IRI of this object
     *
     * @return The value of the IRI of this object
     */
    public String getIRIString() {
        return subject.getNodeType() == Node.TYPE_IRI ? ((IRINode) subject).getIRIValue() : null;
    }

    /**
     * Gets the classifiers of this object
     *
     * @return The classifiers of this object
     */
    public Collection getClassifiers() {
        return queryObjects(node(Vocabulary.rdfType));
    }

    /**
     * Gets the instances of this objects, i.e. objects classified by this object
     *
     * @return the instances of this object
     */
    public Collection getInstances() {
        return queryInverseObjects(node(Vocabulary.rdfType));
    }

    /**
     * Gets the value for the specified object property
     *
     * @param property An object property
     * @return The value
     */
    public ProxyObject getObjectValue(String property) {
        Collection result = queryObjects(node(property));
        if (result.isEmpty())
            return null;
        return result.iterator().next();
    }

    /**
     * Gets the object for which this one is a value for the specified property
     *
     * @param property An object property
     * @return The object
     */
    public ProxyObject getObjectFrom(String property) {
        Collection result = queryInverseObjects(node(property));
        if (result.isEmpty())
            return null;
        return result.iterator().next();
    }

    /**
     * Gets the value for the specified data property
     *
     * @param property A data property
     * @return The value
     */
    public Object getDataValue(String property) {
        Collection result = queryData(node(property));
        if (result.isEmpty())
            return null;
        return result.iterator().next();
    }

    /**
     * Gets the values for the specified object property
     *
     * @param property An object property
     * @return The values
     */
    public Collection getObjectValues(String property) {
        return queryObjects(node(property));
    }

    /**
     * Gets the values for all the set object properties
     *
     * @return The couple of (property IRI, value)
     */
    public Collection> getObjectValues() {
        List> result = new ArrayList<>();
        Iterator> iterator = queryProperties();
        while (iterator.hasNext()) {
            Couple couple = iterator.next();
            if (couple.y instanceof ProxyObject)
                result.add(new Couple<>(couple.x, (ProxyObject) couple.y));
        }
        return result;
    }

    /**
     * Gets the objects for which this one is a value for the specified property
     *
     * @param property An object property
     * @return The objects
     */
    public Collection getObjectsFrom(String property) {
        return queryInverseObjects(node(property));
    }

    /**
     * Gets the values for the specified data property
     *
     * @param property A data property
     * @return The values
     */
    public Collection getDataValues(String property) {
        return queryData(node(property));
    }

    /**
     * Gets the values for all the set data properties
     *
     * @return The couple of (property IRI, value)
     */
    public Collection> getDataValues() {
        List> result = new ArrayList<>();
        Iterator> iterator = queryProperties();
        while (iterator.hasNext()) {
            Couple couple = iterator.next();
            if (!(couple.y instanceof ProxyObject))
                result.add(new Couple<>(couple.x, couple.y));
        }
        return result;
    }

    /**
     * Gets the values for all the set properties
     *
     * @return The couple of (property IRI, value)
     */
    public Collection> getValues() {
        List> result = new ArrayList<>();
        Iterator> iterator = queryProperties();
        while (iterator.hasNext()) {
            result.add(iterator.next());
        }
        return result;
    }

    /**
     * Adds the value of the property
     *
     * @param property The property
     * @param value    The new value
     */
    public void addValue(String property, ProxyObject value) {
        IRINode propertyNode = node(property);
        addValue(propertyNode, value.subject);
    }

    /**
     * Adds the value of the property
     *
     * @param property The property
     * @param value    The new value
     */
    public void addValue(String property, Object value) {
        IRINode propertyNode = node(property);
        addValue(propertyNode, encode(propertyNode, value));
    }

    /**
     * Sets the value of the property
     *
     * @param property The property
     * @param value    The new value
     */
    public void setValue(String property, ProxyObject value) {
        IRINode propertyNode = node(property);
        if (isFunctional(propertyNode)) {
            removeAllValues(propertyNode);
        }
        addValue(propertyNode, value.subject);
    }

    /**
     * Sets the value of the property
     *
     * @param property The property
     * @param value    The new value
     */
    public void setValue(String property, Object value) {
        IRINode propertyNode = node(property);
        if (isFunctional(propertyNode)) {
            removeAllValues(propertyNode);
        }
        addValue(propertyNode, encode(propertyNode, value));
    }

    /**
     * Removes all values of the property
     *
     * @param property The property
     */
    public void removeAllValues(String property) {
        removeAllValues(node(property));
    }

    /**
     * Removes the value of a property
     *
     * @param property The property
     * @param value    The value
     */
    public void removeValue(String property, ProxyObject value) {
        removeValue(node(property), value.subject);
    }

    /**
     * Removes the value of a property
     *
     * @param property The property
     * @param value    The value
     */
    public void removeValue(String property, Object value) {
        IRINode propertyNode = node(property);
        removeValue(propertyNode, encode(propertyNode, value));
    }

    /**
     * Deletes this object from the repository
     */
    public void delete() {
        try {
            // remove all triple of the form
            // [entity ? ?]
            repository.getStore().remove(null, subject, null, null);
            // remove all triple of the form
            // [? ? entity]
            repository.getStore().remove(null, null, null, subject);
        } catch (UnsupportedNodeType ex) {
            // cannot happen
        }
        // clear the internal data
        repository.remove(this);
        repository = null;
        ontology = null;
        subject = null;
    }

    /**
     * Queries all the set properties
     *
     * @return The properties and the values
     */
    private Iterator> queryProperties() {
        return new SkippableIterator<>(new AdaptingIterator<>(repository.getStore().getAll(subject, null, null), new Adapter>() {
            @Override
            public  Couple adapt(X element) {
                Quad quad = (Quad) element;
                Node nodeProperty = quad.getProperty();
                if (nodeProperty.getNodeType() != Node.TYPE_IRI)
                    return null;
                String property = ((IRINode) nodeProperty).getIRIValue();
                Node nodeValue = quad.getObject();
                if (nodeValue.getNodeType() == Node.TYPE_IRI) {
                    return new Couple(property, repository.resolveProxy(((IRINode) nodeValue).getIRIValue()));
                } else if (nodeValue.getNodeType() == Node.TYPE_LITERAL) {
                    return new Couple<>(property, decode((LiteralNode) nodeValue));
                }
                return null;
            }
        }));
    }

    /**
     * Queries the values for the specified property
     *
     * @param property The RDF node for the property
     * @return The corresponding values
     */
    private Collection queryObjects(IRINode property) {
        Collection result = new ArrayList<>();
        // get all triple of the form
        // [entity property ?]
        Iterator iterator = repository.getStore().getAll(subject, property, null);
        while (iterator.hasNext()) {
            Node node = iterator.next().getObject();
            if (node.getNodeType() == Node.TYPE_IRI) {
                ProxyObject po = repository.resolveProxy(((IRINode) node).getIRIValue());
                if (!result.contains(po))
                    result.add(po);
            } else if (node.getNodeType() == Node.TYPE_BLANK) {
                ProxyObject po = repository.resolveProxy(repository.getOntology(IRIs.GRAPH_DEFAULT), (SubjectNode) node);
                if (!result.contains(po))
                    result.add(po);
            }
        }
        return result;
    }

    /**
     * Queries the object for which this on is a value for the specified property
     *
     * @param property The RDF node for the property
     * @return The corresponding objects
     */
    private Collection queryInverseObjects(IRINode property) {
        Collection result = new ArrayList<>();
        // get all triple of the form
        // [entity property ?]
        Iterator iterator = repository.getStore().getAll(null, property, subject);
        while (iterator.hasNext()) {
            Node node = iterator.next().getSubject();
            if (node.getNodeType() == Node.TYPE_IRI) {
                ProxyObject po = repository.resolveProxy(((IRINode) node).getIRIValue());
                if (!result.contains(po))
                    result.add(po);
            } else if (node.getNodeType() == Node.TYPE_BLANK) {
                ProxyObject po = repository.resolveProxy(repository.getOntology(IRIs.GRAPH_DEFAULT), (SubjectNode) node);
                if (!result.contains(po))
                    result.add(po);
            }
        }
        return result;
    }

    /**
     * Queries the values for the specified property
     *
     * @param property The RDF node for the property
     * @return The corresponding values
     */
    private Collection queryData(IRINode property) {
        Collection result = new ArrayList<>();
        // get all triple of the form
        // [entity property ?]
        Iterator iterator = repository.getStore().getAll(subject, property, null);
        while (iterator.hasNext()) {
            Node node = iterator.next().getObject();
            switch (node.getNodeType()) {
                case Node.TYPE_LITERAL:
                    result.add(decode((LiteralNode) node));
                    break;
                case Node.TYPE_DYNAMIC:
                    result.add(((DynamicNode) node).getDynamicExpression());
                    break;
            }
        }
        return result;
    }

    /**
     * Adds the triple for the specified property and value
     *
     * @param property The RDF node for the property
     * @param value    The value
     */
    private void addValue(IRINode property, Node value) {
        try {
            repository.getStore().add(repository.getGraph(ontology), subject, property, value);
        } catch (UnsupportedNodeType ex) {
            // cannot happen
        }
    }

    /**
     * Removes the triple for the specified property and value
     *
     * @param property The RDF node for the property
     * @param value    The value
     */
    private void removeValue(IRINode property, Node value) {
        try {
            repository.getStore().remove(repository.getGraph(ontology), subject, property, value);
        } catch (UnsupportedNodeType ex) {
            // cannot happen
        }
    }

    /**
     * Removes all the triple for the specified property
     *
     * @param property The RDF node for the property
     */
    private void removeAllValues(IRINode property) {
        try {
            // remove all triple of the form
            // [entity property ?]
            repository.getStore().remove(null, subject, property, null);
        } catch (UnsupportedNodeType ex) {
            // cannot happen
        }
    }

    /**
     * Gets whether the specified property is functional
     *
     * @param property The RDF node for the property
     * @return true if the property is functional, false otherwise
     */
    private boolean isFunctional(IRINode property) {
        // do we have the triple:
        // [property rdf:type owl:FunctionalProperty]
        long count = repository.getStore().count(null, property, node(Vocabulary.rdfType), node(Vocabulary.owlFunctionalProperty));
        return count > 1;
    }

    /**
     * Gets the RDF IRI node for the specified IRI
     *
     * @param iri An IRI
     * @return The associated IRI node
     */
    private IRINode node(String iri) {
        return repository.getStore().getIRINode(iri);
    }

    /**
     * Gets the data corresponding to the specified node
     *
     * @param node A RDF Literal node
     * @return The corresponding data
     */
    private Object decode(LiteralNode node) {
        return Datatypes.toNative(node);
    }

    /**
     * Encodes a value as a literal node
     *
     * @param property The target property
     * @param value    A data value
     * @return The literal node
     */
    private LiteralNode encode(IRINode property, Object value) {
        String range = getRangeOf(property);
        Couple data = Datatypes.toLiteral(value);
        return repository.getStore().getLiteralNode(data.x, range, null);
    }

    /**
     * Gets the range of the specified property
     *
     * @param property The RDF node for the property
     * @return The range's IRI
     */
    private String getRangeOf(IRINode property) {
        // get all the triple like
        // [property rdfs:range ?]
        Iterator iterator = repository.getStore().getAll(property, node(Vocabulary.rdfsRange), null);
        if (!iterator.hasNext())
            // range is undefined, return xsd:String
            return Vocabulary.xsdString;
        Node rangeNode = iterator.next().getObject();
        if (iterator instanceof CloseableIterator) {
            try {
                ((CloseableIterator) iterator).close();
            } catch (Exception exception) {
                Logger.DEFAULT.error(exception);
            }
        }
        if (rangeNode.getNodeType() == Node.TYPE_IRI)
            return ((IRINode) rangeNode).getIRIValue();
        // range is defined, but is either a blank, or an anonymous node, return xsd:String
        return Vocabulary.xsdString;
    }

    @Override
    public int hashCode() {
        return subject.hashCode();
    }

    @Override
    public boolean equals(Object object) {
        if (object instanceof ProxyObject) {
            ProxyObject proxy = (ProxyObject) object;
            return this.subject == proxy.subject;
        }
        return false;
    }

    @Override
    public String toString() {
        return subject.toString();
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy