uk.ac.manchester.cs.owl.owlapi.OWLSubClassOfAxiomImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of owlapi-osgidistribution Show documentation
There is a newer version: 5.5.0
Show 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 2014, 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.
 * 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 uk.ac.manchester.cs.owl.owlapi;

import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;

import java.util.Collection;
import java.util.Set;

import javax.annotation.Nonnull;

import org.semanticweb.owlapi.model.AxiomType;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAxiomVisitor;
import org.semanticweb.owlapi.model.OWLAxiomVisitorEx;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLObject;
import org.semanticweb.owlapi.model.OWLObjectVisitor;
import org.semanticweb.owlapi.model.OWLObjectVisitorEx;
import org.semanticweb.owlapi.model.OWLSubClassOfAxiom;

/**
 * @author Matthew Horridge, The University Of Manchester, Bio-Health
 *         Informatics Group
 * @since 2.0.0
 */
public class OWLSubClassOfAxiomImpl extends OWLClassAxiomImpl implements
        OWLSubClassOfAxiom {

    private static final long serialVersionUID = 40000L;
    @Nonnull
    private final OWLClassExpression subClass;
    @Nonnull
    private final OWLClassExpression superClass;

    /**
     * @param subClass
     *        subclass
     * @param superClass
     *        superclass
     * @param annotations
     *        annotations
     */
    public OWLSubClassOfAxiomImpl(@Nonnull OWLClassExpression subClass,
            @Nonnull OWLClassExpression superClass,
            @Nonnull Collection annotations) {
        super(annotations);
        this.subClass = checkNotNull(subClass, "subClass cannot be null");
        this.superClass = checkNotNull(superClass, "superClass cannot be null");
    }

    @Override
    public OWLSubClassOfAxiom getAnnotatedAxiom(
            @Nonnull Set annotations) {
        return new OWLSubClassOfAxiomImpl(subClass, superClass,
                mergeAnnos(annotations));
    }

    @Override
    public OWLSubClassOfAxiom getAxiomWithoutAnnotations() {
        if (!isAnnotated()) {
            return this;
        }
        return new OWLSubClassOfAxiomImpl(subClass, superClass, NO_ANNOTATIONS);
    }

    @Override
    public OWLClassExpression getSubClass() {
        return subClass;
    }

    @Override
    public OWLClassExpression getSuperClass() {
        return superClass;
    }

    @Override
    public boolean isGCI() {
        return subClass.isAnonymous();
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof OWLSubClassOfAxiom)) {
            return false;
        }
        if (super.equals(obj)) {
            // superclass is responsible for null, identity, owlaxiom type and
            // annotations
            OWLSubClassOfAxiom other = (OWLSubClassOfAxiom) obj;
            return other.getSubClass().equals(subClass)
                    && other.getSuperClass().equals(superClass);
        }
        return false;
    }

    @Override
    public void accept(OWLAxiomVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    public void accept(OWLObjectVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    public  O accept(OWLAxiomVisitorEx visitor) {
        return visitor.visit(this);
    }

    @Override
    public  O accept(OWLObjectVisitorEx visitor) {
        return visitor.visit(this);
    }

    @Override
    public AxiomType getAxiomType() {
        return AxiomType.SUBCLASS_OF;
    }

    @Override
    protected int compareObjectOfSameType(OWLObject object) {
        OWLSubClassOfAxiom other = (OWLSubClassOfAxiom) object;
        int diff = subClass.compareTo(other.getSubClass());
        if (diff != 0) {
            return diff;
        }
        return superClass.compareTo(other.getSuperClass());
    }
}