org.semanticweb.owlapi.model

Interface OWLOntologyFactory

All Superinterfaces:

Serializable

public interface OWLOntologyFactory
extends Serializable

An ontology factory is responsible from creating new ontologies and creating ontologies from ontology document IRIs.

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OWLOntologyFactory.OWLOntologyCreationHandler An OWLOntologyCreationHandler gets notified when the factory has created an empty ontology (during the loading process).

Method Summary

Modifier and Type	Method and Description
boolean	canCreateFromDocumentIRI(IRI documentIRI) Determines if the factory can create an ontology for the specified ontology document IRI.
boolean	canLoad(OWLOntologyDocumentSource documentSource) Determines if the factory can load an ontology for the specified input source.
OWLOntology	createOWLOntology(OWLOntologyManager manager, OWLOntologyID ontologyID, IRI documentIRI, OWLOntologyFactory.OWLOntologyCreationHandler handler) Creates an (empty) ontology.
OWLOntology	loadOWLOntology(OWLOntologyManager manager, OWLOntologyDocumentSource documentSource, OWLOntologyFactory.OWLOntologyCreationHandler handler, OWLOntologyLoaderConfiguration configuration) Creates and loads an OWLOntology.

Method Detail

createOWLOntology

@Nonnull
OWLOntology createOWLOntology(@Nonnull
                                       OWLOntologyManager manager,
                                       @Nonnull
                                       OWLOntologyID ontologyID,
                                       @Nonnull
                                       IRI documentIRI,
                                       @Nonnull
                                       OWLOntologyFactory.OWLOntologyCreationHandler handler)
                                throws OWLOntologyCreationException

Creates an (empty) ontology.

Parameters:

manager - the ontology manager to set.

ontologyID - The ID of the ontology to create. This MUST NOT BE null.

documentIRI - The document IRI of the ontology

handler - The ontology creation handler that will be notified when the ontology has been created. @return The newly created ontology

Returns:

The created ontology

Throws:

OWLOntologyCreationException - if the ontology could not be created.

loadOWLOntology

@Nonnull
OWLOntology loadOWLOntology(@Nonnull
                                     OWLOntologyManager manager,
                                     @Nonnull
                                     OWLOntologyDocumentSource documentSource,
                                     @Nonnull
                                     OWLOntologyFactory.OWLOntologyCreationHandler handler,
                                     @Nonnull
                                     OWLOntologyLoaderConfiguration configuration)
                              throws OWLOntologyCreationException

Creates and loads an OWLOntology.

Parameters:

manager - the ontology manager to set.

documentSource - The document source that provides the means of getting a representation of a document.

handler - A pointer to an OWLOntologyCreationHandler which will be notified immediately after and empty ontology has been created, but before the source data is read and the ontology is loaded with axioms.

configuration - A configuration object which can be used to pass various options to the loader.

Returns:

The newly created and loaded ontology.

Throws:

OWLOntologyCreationException - if the ontology could not be created

canCreateFromDocumentIRI

boolean canCreateFromDocumentIRI(@Nonnull
                                 IRI documentIRI)

Determines if the factory can create an ontology for the specified ontology document IRI.

Parameters:

documentIRI - The document IRI

Returns:

true if the factory can create an ontology given the specified document IRI, or false if the factory cannot create an ontology given the specified document IRI.

canLoad

boolean canLoad(@Nonnull
                OWLOntologyDocumentSource documentSource)

Determines if the factory can load an ontology for the specified input source.

Parameters:

documentSource - The input source from which to load the ontology

Returns:

true if the factory can load from the specified input source.