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

Go to download
/*
 * 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 uk.ac.manchester.cs.owl.owlapi;

import java.util.Set;

import org.semanticweb.owlapi.model.AxiomType;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAnnotationAssertionAxiom;
import org.semanticweb.owlapi.model.OWLAnnotationProperty;
import org.semanticweb.owlapi.model.OWLAnnotationSubject;
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.OWLClassAxiom;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLDataProperty;
import org.semanticweb.owlapi.model.OWLDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyExpression;
import org.semanticweb.owlapi.model.OWLDataPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLDatatype;
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.OWLEntity;
import org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentDataPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLFunctionalDataPropertyAxiom;
import org.semanticweb.owlapi.model.OWLFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLHasKeyAxiom;
import org.semanticweb.owlapi.model.OWLImportsDeclaration;
import org.semanticweb.owlapi.model.OWLIndividual;
import org.semanticweb.owlapi.model.OWLInverseFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLInverseObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLIrreflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLLogicalAxiom;
import org.semanticweb.owlapi.model.OWLNamedIndividual;
import org.semanticweb.owlapi.model.OWLNegativeDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLNegativeObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObjectProperty;
import org.semanticweb.owlapi.model.OWLObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyExpression;
import org.semanticweb.owlapi.model.OWLObjectPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLReflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLSameIndividualAxiom;
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.util.OWLAxiomSearchFilter;

@SuppressWarnings("javadoc")
public interface Internals {
    /** a marker interface for objects that identify contained maps - so that
     * getting the keys of a specific map does not require a specific method for
     * each map nor does it require the map to be copied and returned */
    public interface Pointer {}

    /** a marker interface for objects that identify contained sets */
    public interface SimplePointer {}

    Pointer, OWLAxiom> getAxiomsByType();

     boolean add(Pointer pointer, K key, V value);

    void addGeneralClassAxioms(OWLClassAxiom ax);

    /** @param importDeclaration
     *            declaration to be added
     * @return true if the import declaration was not already present, false
     *         otherwise */
    boolean addImportsDeclaration(OWLImportsDeclaration importDeclaration);

    boolean addOntologyAnnotation(OWLAnnotation ann);

    void addPropertyChainSubPropertyAxioms(OWLSubPropertyChainOfAxiom ax);

     boolean contains(Pointer pointer, K k);

     boolean contains(Pointer pointer, K k, V v);

    Pointer
            getAnnotationAssertionAxiomsBySubject();

    Pointer
            getAsymmetricPropertyAxiomsByProperty();

    int getAxiomCount();

     int getAxiomCount(AxiomType axiomType);

    Set getAxioms();

    Pointer getClassAssertionAxiomsByClass();

    Pointer getClassAssertionAxiomsByIndividual();

    Pointer getClassAxiomsByClass();

    Pointer
            getDataPropertyAssertionsByIndividual();

    Pointer
            getDataPropertyDomainAxiomsByProperty();

    Pointer
            getDataPropertyRangeAxiomsByProperty();

    Pointer
            getDataSubPropertyAxiomsByLHS();

    Pointer
            getDataSubPropertyAxiomsByRHS();

    Pointer getDeclarationsByEntity();

    Pointer
            getDifferentIndividualsAxiomsByIndividual();

    Pointer getDisjointClassesAxiomsByClass();

    Pointer
            getDisjointDataPropertyAxiomsByProperty();

    Pointer
            getDisjointObjectPropertyAxiomsByProperty();

    Pointer getDisjointUnionAxiomsByClass();

    Pointer getEquivalentClassesAxiomsByClass();

    Pointer
            getEquivalentDataPropertyAxiomsByProperty();

    Pointer
            getEquivalentObjectPropertyAxiomsByProperty();

    Pointer
            getFunctionalDataPropertyAxiomsByProperty();

    Pointer
            getFunctionalObjectPropertyAxiomsByProperty();

    Set getGeneralClassAxioms();

    Pointer getHasKeyAxiomsByClass();

    Set getImportsDeclarations();

    Pointer
            getInverseFunctionalPropertyAxiomsByProperty();

    Pointer
            getInversePropertyAxiomsByProperty();

    Pointer
            getIrreflexivePropertyAxiomsByProperty();

    int getLogicalAxiomCount();

    Set getLogicalAxioms();

    Pointer
            getNegativeDataPropertyAssertionAxiomsByIndividual();

    Pointer
            getNegativeObjectPropertyAssertionAxiomsByIndividual();

    Pointer
            getObjectPropertyAssertionsByIndividual();

    Pointer
            getObjectPropertyDomainAxiomsByProperty();

    Pointer
            getObjectPropertyRangeAxiomsByProperty();

    Pointer
            getObjectSubPropertyAxiomsByLHS();

    Pointer
            getObjectSubPropertyAxiomsByRHS();

    Set getOntologyAnnotations();

    Pointer getOwlAnnotationPropertyReferences();

    Pointer getOwlAnonymousIndividualReferences();

    Pointer getOwlClassReferences();

    Pointer getOwlDataPropertyReferences();

    Pointer getOwlDatatypeReferences();

    Pointer getOwlIndividualReferences();

    Pointer getOwlObjectPropertyReferences();

    Pointer
            getReflexivePropertyAxiomsByProperty();

    Pointer getSameIndividualsAxiomsByIndividual();

    Pointer getSubClassAxiomsByLHS();

    Pointer getSubClassAxiomsByRHS();

    Pointer
            getSymmetricPropertyAxiomsByProperty();

    Pointer
            getTransitivePropertyAxiomsByProperty();

     Set getValues(Pointer pointer, K key);

     boolean hasValues(Pointer pointer, K key);

     Set getKeyset(Pointer pointer);

    public  Set filterAxioms(OWLAxiomSearchFilter filter,
            K key);

    boolean isDeclared(OWLDeclarationAxiom ax);

    boolean isEmpty();

    boolean addAxiom(OWLAxiom axiom);

    boolean removeAxiom(OWLAxiom axiom);

    void removeGeneralClassAxioms(OWLClassAxiom ax);

    /** @param importDeclaration
     *            declaration to be added
     * @return true if the import declaration was present, false otherwise */
    boolean removeImportsDeclaration(OWLImportsDeclaration importDeclaration);

    boolean removeOntologyAnnotation(OWLAnnotation ann);

     boolean remove(Pointer pointer, K k, V v);

    void removePropertyChainSubPropertyAxioms(OWLSubPropertyChainOfAxiom ax);
}