org.coode.owlapi.rdfxml.parser.TypeAxiomHandler Maven / Gradle / Ivy

/*
 * This file is part of the OWL API.
 *
 * The contents of this file are subject to the LGPL License, Version 3.0.
 *
 * Copyright (C) 2011, The University of Manchester
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0
 * in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 *
 * Copyright 2011, University of Manchester
 *
 * Licensed 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.coode.owlapi.rdfxml.parser;

import java.util.Set;

import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLLiteral;
import org.semanticweb.owlapi.model.UnloadableImportException;
import org.semanticweb.owlapi.vocab.OWLRDFVocabulary;

/**
 * @author Matthew Horridge, The University Of Manchester, Bio-Health Informatics
 *         Group, Date: 11-Dec-2006
 */
public class TypeAxiomHandler extends BuiltInTypeHandler {

    /**
     * @param consumer
     *        consumer
     */
    public TypeAxiomHandler(OWLRDFConsumer consumer) {
        super(consumer, OWLRDFVocabulary.OWL_AXIOM.getIRI());
    }

    /**
     * @param consumer
     *        consumer
     * @param typeIRI
     *        typeIRI
     */
    public TypeAxiomHandler(OWLRDFConsumer consumer, IRI typeIRI) {
        super(consumer, typeIRI);
    }

    @Override
    public boolean canHandleStreaming(IRI subject, IRI predicate, IRI object) {
        // We can't handle this is a streaming fashion, because we can't
        // be sure that the subject, predicate, object triples have been parsed.
        getConsumer().addAxiom(subject);
        return false;
    }

    /**
     * Gets the IRI of the predicate of the triple that specifies the target of
     * a reified axiom
     * 
     * @return The IRI, by default this is owl:annotatedTarget
     */
    protected OWLRDFVocabulary getTargetTriplePredicate() {
        return OWLRDFVocabulary.OWL_ANNOTATED_TARGET;
    }

    /**
     * Gets the IRI of the predicate of the triple that specifies that predicate
     * of a reified axiom
     * 
     * @return The IRI, by default this is owl:annotatedProperty
     */
    protected OWLRDFVocabulary getPropertyTriplePredicate() {
        return OWLRDFVocabulary.OWL_ANNOTATED_PROPERTY;
    }

    /**
     * Gets the IRI of the predicate of the triple that specifies the source of
     * a reified axiom
     * 
     * @return The IRI, by default this is owl:annotatedSource
     */
    protected OWLRDFVocabulary getSourceTriplePredicate() {
        return OWLRDFVocabulary.OWL_ANNOTATED_SOURCE;
    }

    @Override
    public void handleTriple(IRI subject, IRI predicate, IRI object)
            throws UnloadableImportException {
        IRI annotatedSource = getObjectOfSourceTriple(subject);
        IRI annotatedProperty = getObjectOfPropertyTriple(subject);
        IRI annotatedTarget = getObjectOfTargetTriple(subject);
        OWLLiteral annotatedTargetLiteral = null;
        if (annotatedTarget == null) {
            annotatedTargetLiteral = getTargetLiteral(subject);
        }
        // check that other conditions are not invalid
        if (annotatedSource != null && annotatedProperty != null) {
            consumeTriple(subject, predicate, object);
            Set annotations = getConsumer()
                    .translateAnnotations(subject);
            getConsumer().setPendingAnnotations(annotations);
            if (annotatedTarget != null) {
                getConsumer().handle(annotatedSource, annotatedProperty,
                        annotatedTarget);
            } else if (annotatedTargetLiteral != null) {
                getConsumer().handle(annotatedSource, annotatedProperty,
                        annotatedTargetLiteral);
            }
            if (!annotations.isEmpty()) {
                OWLAxiom ax = getConsumer().getLastAddedAxiom();
                getConsumer().removeAxiom(ax.getAxiomWithoutAnnotations());
            }
        }
    }

    @SuppressWarnings("unused")
    protected OWLAxiom handleAxiomTriples(IRI subjectTriple,
            IRI predicateTriple, IRI objectTriple,
            Set annotations) {
        // Reconstitute the original triple from the reification triples
        return getConsumer().getLastAddedAxiom();
    }

    protected OWLAxiom handleAxiomTriples(IRI subjectTripleObject,
            IRI predicateTripleObject, OWLLiteral con,
            Set annotations) {
        getConsumer().handle(subjectTripleObject, predicateTripleObject, con);
        return getConsumer().getLastAddedAxiom();
    }

    @SuppressWarnings("deprecation")
    private OWLLiteral getTargetLiteral(IRI subject) {
        OWLLiteral con = getConsumer().getLiteralObject(subject,
                getTargetTriplePredicate(), true);
        if (con == null) {
            con = getConsumer().getLiteralObject(subject,
                    OWLRDFVocabulary.RDF_OBJECT.getIRI(), true);
        }
        return con;
    }

    /**
     * Gets the object of the target triple that has the specified main node
     * 
     * @param mainNode
     *        The main node
     * @return The object of the triple that has the specified mainNode as its
     *         subject and the IRI returned by the
     *         {@code TypeAxiomHandler#getSourceTriplePredicate()} method. For
     *         backwards compatibility, a search will also be performed for
     *         triples whos subject is the specified mainNode and predicate
     *         rdf:object
     */
    @SuppressWarnings("deprecation")
    private IRI getObjectOfTargetTriple(IRI mainNode) {
        IRI objectTripleObject = getConsumer().getResourceObject(mainNode,
                getTargetTriplePredicate(), true);
        if (objectTripleObject == null) {
            objectTripleObject = getConsumer().getResourceObject(mainNode,
                    OWLRDFVocabulary.RDF_OBJECT, true);
        }
        if (objectTripleObject == null) {
            objectTripleObject = getConsumer().getResourceObject(mainNode,
                    OWLRDFVocabulary.OWL_PROPERTY_CHAIN, true);
        }
        return objectTripleObject;
    }

    @SuppressWarnings("deprecation")
    private IRI getObjectOfPropertyTriple(IRI subject) {
        IRI predicateTripleObject = getConsumer().getResourceObject(subject,
                getPropertyTriplePredicate(), true);
        if (predicateTripleObject == null) {
            predicateTripleObject = getConsumer().getResourceObject(subject,
                    OWLRDFVocabulary.RDF_PREDICATE, true);
        }
        return predicateTripleObject;
    }

    /**
     * Gets the source IRI for an annotated or reified axiom
     * 
     * @param mainNode
     *        The main node of the triple
     * @return The source object
     * @throws OWLRDFXMLParserMalformedNodeException
     *         malformed node
     */
    @SuppressWarnings("deprecation")
    private IRI getObjectOfSourceTriple(IRI mainNode) {
        IRI subjectTripleObject = getConsumer().getResourceObject(mainNode,
                getSourceTriplePredicate(), true);
        if (subjectTripleObject == null) {
            subjectTripleObject = getConsumer().getResourceObject(mainNode,
                    OWLRDFVocabulary.RDF_SUBJECT, true);
        }
        return subjectTripleObject;
    }
}