org.coode.oppl.entity.OWLEntityFactory Maven / Gradle / Ivy

Go to download
package org.coode.oppl.entity;

import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLAnnotationProperty;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLDataProperty;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLNamedIndividual;
import org.semanticweb.owlapi.model.OWLObjectProperty;

/** @author Luigi Iannone */
public interface OWLEntityFactory {
    /** @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @return creation set for class
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    OWLEntityCreationSet createOWLClass(String shortName, IRI baseIRI)
            throws OWLEntityCreationException;

    /** @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @return creation set for object property
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    OWLEntityCreationSet createOWLObjectProperty(String shortName,
            IRI baseIRI) throws OWLEntityCreationException;

    /** @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @return creation set for annotation property
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    OWLEntityCreationSet createOWLAnnotationProperty(
            String shortName, IRI baseIRI) throws OWLEntityCreationException;

    /** @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @return creation set for data property
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    OWLEntityCreationSet createOWLDataProperty(String shortName,
            IRI baseIRI) throws OWLEntityCreationException;

    /** @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @return creation set for individual
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    OWLEntityCreationSet createOWLIndividual(String shortName,
            IRI baseIRI) throws OWLEntityCreationException;

    /** @param type
     *            type
     * @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @param 
     *            class type
     * @return creation set for entity
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
     OWLEntityCreationSet createOWLEntity(Class type,
            String shortName, IRI baseIRI) throws OWLEntityCreationException;

    /** @param type
     *            type
     * @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
    void tryCreate(Class type, String shortName, IRI baseIRI)
            throws OWLEntityCreationException;

    /** @param type
     *            type
     * @param shortName
     *            shortName
     * @param baseIRI
     *            baseIRI
     * @param 
     *            class type
     * @return preview
     * @throws OWLEntityCreationException
     *             OWLEntityCreationException */
     OWLEntityCreationSet preview(Class type,
            String shortName, IRI baseIRI) throws OWLEntityCreationException;
}