org.semanticweb.owlapi.util.OWLClassExpressionCollector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/*
 * 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.semanticweb.owlapi.util;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAnnotationAssertionAxiom;
import org.semanticweb.owlapi.model.OWLAnnotationProperty;
import org.semanticweb.owlapi.model.OWLAnnotationPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLAnnotationPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLAnonymousIndividual;
import org.semanticweb.owlapi.model.OWLAsymmetricObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLClassAssertionAxiom;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLDataAllValuesFrom;
import org.semanticweb.owlapi.model.OWLDataComplementOf;
import org.semanticweb.owlapi.model.OWLDataExactCardinality;
import org.semanticweb.owlapi.model.OWLDataHasValue;
import org.semanticweb.owlapi.model.OWLDataIntersectionOf;
import org.semanticweb.owlapi.model.OWLDataMaxCardinality;
import org.semanticweb.owlapi.model.OWLDataMinCardinality;
import org.semanticweb.owlapi.model.OWLDataOneOf;
import org.semanticweb.owlapi.model.OWLDataProperty;
import org.semanticweb.owlapi.model.OWLDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLDataSomeValuesFrom;
import org.semanticweb.owlapi.model.OWLDataUnionOf;
import org.semanticweb.owlapi.model.OWLDatatype;
import org.semanticweb.owlapi.model.OWLDatatypeDefinitionAxiom;
import org.semanticweb.owlapi.model.OWLDatatypeRestriction;
import org.semanticweb.owlapi.model.OWLDeclarationAxiom;
import org.semanticweb.owlapi.model.OWLDifferentIndividualsAxiom;
import org.semanticweb.owlapi.model.OWLDisjointClassesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointDataPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointUnionAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentDataPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLFacetRestriction;
import org.semanticweb.owlapi.model.OWLFunctionalDataPropertyAxiom;
import org.semanticweb.owlapi.model.OWLFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLHasKeyAxiom;
import org.semanticweb.owlapi.model.OWLInverseFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLInverseObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLIrreflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLLiteral;
import org.semanticweb.owlapi.model.OWLNamedIndividual;
import org.semanticweb.owlapi.model.OWLNegativeDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLNegativeObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObjectAllValuesFrom;
import org.semanticweb.owlapi.model.OWLObjectComplementOf;
import org.semanticweb.owlapi.model.OWLObjectExactCardinality;
import org.semanticweb.owlapi.model.OWLObjectHasSelf;
import org.semanticweb.owlapi.model.OWLObjectHasValue;
import org.semanticweb.owlapi.model.OWLObjectIntersectionOf;
import org.semanticweb.owlapi.model.OWLObjectInverseOf;
import org.semanticweb.owlapi.model.OWLObjectMaxCardinality;
import org.semanticweb.owlapi.model.OWLObjectMinCardinality;
import org.semanticweb.owlapi.model.OWLObjectOneOf;
import org.semanticweb.owlapi.model.OWLObjectProperty;
import org.semanticweb.owlapi.model.OWLObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLObjectSomeValuesFrom;
import org.semanticweb.owlapi.model.OWLObjectUnionOf;
import org.semanticweb.owlapi.model.OWLObjectVisitorEx;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLReflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLSameIndividualAxiom;
import org.semanticweb.owlapi.model.OWLSubAnnotationPropertyOfAxiom;
import org.semanticweb.owlapi.model.OWLSubClassOfAxiom;
import org.semanticweb.owlapi.model.OWLSubDataPropertyOfAxiom;
import org.semanticweb.owlapi.model.OWLSubObjectPropertyOfAxiom;
import org.semanticweb.owlapi.model.OWLSubPropertyChainOfAxiom;
import org.semanticweb.owlapi.model.OWLSymmetricObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLTransitiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.SWRLAtom;
import org.semanticweb.owlapi.model.SWRLBuiltInAtom;
import org.semanticweb.owlapi.model.SWRLClassAtom;
import org.semanticweb.owlapi.model.SWRLDataPropertyAtom;
import org.semanticweb.owlapi.model.SWRLDataRangeAtom;
import org.semanticweb.owlapi.model.SWRLDifferentIndividualsAtom;
import org.semanticweb.owlapi.model.SWRLIndividualArgument;
import org.semanticweb.owlapi.model.SWRLLiteralArgument;
import org.semanticweb.owlapi.model.SWRLObjectPropertyAtom;
import org.semanticweb.owlapi.model.SWRLRule;
import org.semanticweb.owlapi.model.SWRLSameIndividualAtom;
import org.semanticweb.owlapi.model.SWRLVariable;

/**
 * Author: Matthew Horridge

 * The University of Manchester

 * Bio-Health Informatics Group

 * Date: 14-Jun-2010
 * 

 * Collects all of the nested class expression that are used in some OWLObject.  For example, given
 * SubClassOf(ObjectUnionOf(D C) ObjectSomeValuesFrom(R F)) the collector could be used to obtain
 * ObjectUnionOf(D C), D, C, ObjectSomeValuesFrom(R F), F
 */
public class OWLClassExpressionCollector implements OWLObjectVisitorEx> {

    @Override
    public Set visit(IRI iri) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDatatype node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLObjectProperty property) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLAnonymousIndividual individual) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(SWRLClassAtom node) {
        return node.getPredicate().accept(this);
    }


    @Override
    public Set visit(OWLObjectInverseOf property) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLDataRangeAtom node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLAnnotation node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLDataOneOf node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLDataProperty property) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLObjectPropertyAtom node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLDataIntersectionOf node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLNamedIndividual individual) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLDataUnionOf node) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLSubClassOfAxiom axiom) {
        Set result = new HashSet();
        result.addAll(axiom.getSubClass().accept(this));
        result.addAll(axiom.getSuperClass().accept(this));
        return result;
    }


    @Override
    public Set visit(OWLAnnotationPropertyRangeAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLOntology ontology) {
        Set result = new HashSet();
        for(OWLAxiom ax : ontology.getLogicalAxioms()) {
            result.addAll(ax.accept(this));
        }
        return result;
    }


    @Override
    public Set visit(OWLDatatypeRestriction node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLBuiltInAtom node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLAnnotationProperty property) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLClass ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(SWRLVariable node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLLiteral node) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectIntersectionOf ce) {
        Set result = new HashSet();
        result.add(ce);
        for(OWLClassExpression op : ce.getOperands()) {
            result.addAll(op.accept(this));
        }
        return result;
    }


    @Override
    public Set visit(OWLNegativeObjectPropertyAssertionAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLIndividualArgument node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLObjectUnionOf ce) {
        Set result = new HashSet();
        result.add(ce);
        for(OWLClassExpression op : ce.getOperands()) {
            result.addAll(op.accept(this));
        }
        return result;
    }


    @Override
    public Set visit(OWLFacetRestriction node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLLiteralArgument node) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLAsymmetricObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectComplementOf ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getOperand().accept(this));
        return result;
    }


    @Override
    public Set visit(SWRLSameIndividualAtom node) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectSomeValuesFrom ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getFiller().accept(this));
        return result;
    }


    @Override
    public Set visit(OWLReflexiveObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(SWRLDifferentIndividualsAtom node) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectAllValuesFrom ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getFiller().accept(this));
        return result;
    }

    @Override
    public Set visit(OWLDisjointClassesAxiom axiom) {
        Set result = new HashSet();
        for(OWLClassExpression ce : axiom.getClassExpressions()) {
            result.addAll(ce.accept(this));
        }
        return result;
    }

    @Override
    public Set visit(OWLObjectHasValue ce) {
        return Collections.singleton(ce);
    }

    @Override
    public Set visit(OWLDataPropertyDomainAxiom axiom) {
        return axiom.getDomain().accept(this);
    }

    @Override
    public Set visit(OWLObjectMinCardinality ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getFiller().accept(this));
        return result;
    }

    @Override
    public Set visit(OWLObjectPropertyDomainAxiom axiom) {
        return axiom.getDomain().accept(this);
    }

    @Override
    public Set visit(OWLObjectExactCardinality ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getFiller().accept(this));
        return result;
    }


    @Override
    public Set visit(OWLEquivalentObjectPropertiesAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectMaxCardinality ce) {
        Set result = new HashSet();
        result.add(ce);
        result.addAll(ce.getFiller().accept(this));
        return result;
    }

    @Override
    public Set visit(OWLObjectHasSelf ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(OWLNegativeDataPropertyAssertionAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLObjectOneOf ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(OWLDifferentIndividualsAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDataSomeValuesFrom ce) {
        return Collections.singleton(ce);
    }

    @Override
    public Set visit(OWLDataAllValuesFrom ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(OWLDisjointDataPropertiesAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDataHasValue ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(OWLDisjointObjectPropertiesAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDataMinCardinality ce) {
        return Collections.singleton(ce);
    }

    @Override
    public Set visit(OWLObjectPropertyRangeAxiom axiom) {
        return axiom.getRange().accept(this);
    }

    @Override
    public Set visit(OWLDataExactCardinality ce) {
        return Collections.singleton(ce);
    }

    @Override
    public Set visit(OWLDataMaxCardinality ce) {
        return Collections.singleton(ce);
    }


    @Override
    public Set visit(OWLObjectPropertyAssertionAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLFunctionalObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLSubObjectPropertyOfAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDisjointUnionAxiom axiom) {
        Set result = new HashSet();
        result.add(axiom.getOWLClass());
        for(OWLClassExpression ce : axiom.getClassExpressions()) {
            result.addAll(ce.accept(this));
        }
        return result;
    }

    @Override
    public Set visit(OWLDeclarationAxiom axiom) {
        return axiom.getEntity().accept(this);
    }


    @Override
    public Set visit(OWLAnnotationAssertionAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLSymmetricObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLDataPropertyRangeAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLFunctionalDataPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLEquivalentDataPropertiesAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLClassAssertionAxiom axiom) {
        return axiom.getClassExpression().accept(this);
    }

    @Override
    public Set visit(OWLEquivalentClassesAxiom axiom) {
        Set result = new HashSet();
        for(OWLClassExpression ce : axiom.getClassExpressions()) {
            result.addAll(ce.accept(this));
        }
        return result;
    }


    @Override
    public Set visit(OWLDataPropertyAssertionAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLTransitiveObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLIrreflexiveObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLSubDataPropertyOfAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLInverseFunctionalObjectPropertyAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLSameIndividualAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLSubPropertyChainOfAxiom axiom) {
        return Collections.emptySet();
    }


    @Override
    public Set visit(OWLInverseObjectPropertiesAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLHasKeyAxiom axiom) {
        return axiom.getClassExpression().accept(this);
    }

    @Override
    public Set visit(OWLDatatypeDefinitionAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(SWRLRule rule) {
        Set result = new HashSet();
        for(SWRLAtom atom : rule.getBody()) {
            result.addAll(atom.accept(this));
        }
        for(SWRLAtom atom : rule.getHead()) {
            result.addAll(atom.accept(this));
        }
        return result;
    }

    @Override
    public Set visit(OWLSubAnnotationPropertyOfAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLAnnotationPropertyDomainAxiom axiom) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(OWLDataComplementOf node) {
        return Collections.emptySet();
    }

    @Override
    public Set visit(SWRLDataPropertyAtom node) {
        return Collections.emptySet();
    }
}