|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object uk.ac.manchester.cs.owl.owlapi.OWLOntologyManagerImpl
public class OWLOntologyManagerImpl
Author: Matthew Horridge
The University Of Manchester
Bio-Health Informatics Group
Date: 27-Oct-2006
Constructor Summary | |
---|---|
OWLOntologyManagerImpl(OWLDataFactory dataFactory)
|
Method Summary | |
---|---|
java.util.List<OWLOntologyChange> |
addAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that adds a single axiom to an ontology. |
java.util.List<OWLOntologyChange> |
addAxioms(OWLOntology ont,
java.util.Set<? extends OWLAxiom> axioms)
A convenience method that adds a set of axioms to an ontology. |
void |
addImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
|
void |
addIRIMapper(OWLOntologyIRIMapper mapper)
Adds a mapper to this manager. |
void |
addMissingImportListener(MissingImportListener listener)
In the case where silent missing imports handling is enabled, a listener can be attached via this method so that there is a mechanism that allows clients to be informed of the reason when an import cannot be loaded. |
void |
addOntologyChangeListener(OWLOntologyChangeListener listener)
Adds an ontology change listener, which listens to all changes for all ontologies. |
void |
addOntologyChangeListener(OWLOntologyChangeListener listener,
OWLOntologyChangeBroadcastStrategy strategy)
Adds an ontology change listener, which listens to ontology changes. |
void |
addOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
Adds an ontology change progress listener. |
void |
addOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
|
void |
addOntologyFactory(OWLOntologyFactory factory)
Adds an ontology factory that is capable of creating an ontology given a particular document IRI. |
void |
addOntologyLoaderListener(OWLOntologyLoaderListener listener)
Adds an ontology loaded listener to this manager. |
void |
addOntologyStorer(OWLOntologyStorer storer)
Add an ontology storer. |
java.util.List<OWLOntologyChange> |
applyChange(OWLOntologyChange change)
A convenience method that applies just one change to an ontology that is managed by this manager. |
java.util.List<OWLOntologyChange> |
applyChanges(java.util.List<? extends OWLOntologyChange> changes)
Applies a list of changes to some or all of the ontologies that are managed by this manager. |
void |
clearIRIMappers()
Clears any installed IRI mappers |
boolean |
contains(IRI ontologyIRI)
Determines if there is an ontology with the specified IRI, and no version IRI, that is managed by this manager |
boolean |
contains(OWLOntology ontology)
|
boolean |
contains(OWLOntologyID id)
Determines if there is an ontology with the specified id that is managed by this manager |
OWLOntology |
createOntology()
Creates a new (empty) ontology that does not have an ontology IRI (and therefore does not have a version IRI). |
OWLOntology |
createOntology(IRI ontologyIRI)
Creates a new (empty) ontology that has the specified ontology IRI (and no version IRI). |
OWLOntology |
createOntology(IRI ontologyIRI,
IRI versionIRI)
|
OWLOntology |
createOntology(IRI ontologyIRI,
java.util.Set<OWLOntology> ontologies)
Creates a new ontology that has the specified ontology IRI and is initialised to contain the axioms that are contained in the specified ontologies. |
OWLOntology |
createOntology(IRI ontologyIRI,
java.util.Set<OWLOntology> ontologies,
boolean copyLogicalAxiomsOnly)
Creates a new ontology that has the specified ontology IRI and is initialised to contain the axioms that are contained in the specified ontologies. |
OWLOntology |
createOntology(OWLOntologyID ontologyID)
Creates a new (empty) ontology that has the specified ontology ID. |
OWLOntology |
createOntology(java.util.Set<OWLAxiom> axioms)
Creates a new ontology that is initialised to contain specific axioms. |
OWLOntology |
createOntology(java.util.Set<OWLAxiom> axioms,
IRI iri)
Creates a new ontology that has the specified ontology IRI and is initialised to contain specific axioms. |
protected void |
fireBeginChanges(int size)
|
protected void |
fireChangeApplied(OWLOntologyChange change)
|
protected void |
fireEndChanges()
|
protected void |
fireFinishedLoadingEvent(OWLOntologyID ontologyID,
IRI documentIRI,
boolean imported,
OWLOntologyCreationException ex)
|
protected void |
fireMissingImportEvent(MissingImportEvent evt)
|
protected void |
fireStartedLoadingEvent(OWLOntologyID ontologyID,
IRI documentIRI,
boolean imported)
|
java.util.Set<OWLOntology> |
getDirectImports(OWLOntology ontology)
Gets the set of loaded ontologies that the specified ontology is related to via the directlyImports relation as defined in Section 3.4 of the OWL 2 Structural specification |
OWLOntology |
getImportedOntology(OWLImportsDeclaration declaration)
Given an imports declaration, obtains the ontology that this import has been resolved to. |
java.util.Set<OWLOntology> |
getImports(OWLOntology ontology)
Gets the set of ontologies that are in the transitive closure of the directly imports relation. |
java.util.Set<OWLOntology> |
getImportsClosure(OWLOntology ontology)
Gets the imports closure for the specified ontology. |
protected IRI |
getNextAutoGeneratedIRI()
|
java.util.Set<OWLOntology> |
getOntologies()
Gets all of the ontologies that are managed by this manager. |
java.util.Set<OWLOntology> |
getOntologies(OWLAxiom axiom)
Gets the ontologies that are managed by this manager that contain the specified axiom. |
OWLOntology |
getOntology(IRI ontologyIRI)
Gets a previously loaded/created ontology that has the specified ontology IRI and no version IRI. |
OWLOntology |
getOntology(OWLOntologyID ontologyID)
Gets a previously loaded/created ontology that has the specified ontology ID |
IRI |
getOntologyDocumentIRI(OWLOntology ontology)
Gets the document IRI for a given ontology. |
java.util.Collection<OWLOntologyFactory> |
getOntologyFactories()
Gets the ontology factories that are registered with this manager. |
OWLOntologyFormat |
getOntologyFormat(OWLOntology ontology)
Gets the ontology format for the specified ontology. |
OWLDataFactory |
getOWLDataFactory()
Gets a data factory which can be used to create OWL API objects such as classes, properties, individuals, axioms etc. |
OWLOntologyManagerProperties |
getProperties()
|
java.util.List<OWLOntology> |
getSortedImportsClosure(OWLOntology ontology)
Gets the topologically ordered imports closure. |
java.util.Set<OWLOntology> |
getVersions(IRI ontology)
Gets the versions (if any) of the ontology that have the specified IRI |
boolean |
isSilentMissingImportsHandling()
Determines if silent missing imports handling is enabled. |
OWLOntology |
loadOntology(IRI ontologyIRI)
Loads an ontology that is assumed to have the specified ontologyIRI as its IRI or version IRI. |
protected OWLOntology |
loadOntology(IRI ontologyIRI,
OWLOntologyDocumentSource documentSource)
This is the method that all the other load method delegate to. |
OWLOntology |
loadOntologyFromOntologyDocument(java.io.File file)
Loads an ontology from an ontology document contained in a local file. |
OWLOntology |
loadOntologyFromOntologyDocument(java.io.InputStream inputStream)
Loads an ontology from an ontology document obtained from an input stream. |
OWLOntology |
loadOntologyFromOntologyDocument(IRI documentIRI)
Loads an ontology from an ontology document specified by an IRI. |
OWLOntology |
loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource)
A convenience method that load an ontology from an input source. |
void |
makeLoadImportRequest(OWLImportsDeclaration declaration)
Requests that the manager loads an imported ontology that is described by an imports statement. |
void |
ontologyCreated(OWLOntology ontology)
The factory calls this method as soon as it has created an ontology. |
java.util.List<OWLOntologyChange> |
removeAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that removes a single axiom from an ontology. |
java.util.List<OWLOntologyChange> |
removeAxioms(OWLOntology ont,
java.util.Set<? extends OWLAxiom> axioms)
A convenience method that removes a set of axioms from an ontology. |
void |
removeImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
|
void |
removeIRIMapper(OWLOntologyIRIMapper mapper)
Removes a mapper from this manager. |
void |
removeMissingImportListener(MissingImportListener listener)
Removes a previously added missing import listener. |
void |
removeOntology(OWLOntology ontology)
Attempts to remove an ontology. |
void |
removeOntologyChangeListener(OWLOntologyChangeListener listener)
Removes a previously added listener. |
void |
removeOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
Removes a previously added ontology change listener. |
void |
removeOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
|
void |
removeOntologyFactory(OWLOntologyFactory factory)
Removes a previously added factory. |
void |
removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
Removes a previously added ontology loaded listener. |
void |
removeOntologyStorer(OWLOntologyStorer storer)
Removes a previously added storer |
void |
saveOntology(OWLOntology ontology)
Saves the specified ontology. |
void |
saveOntology(OWLOntology ontology,
IRI documentIRI)
Saves the specified ontology, using the specified document IRI to determine where/how the ontology should be saved. |
void |
saveOntology(OWLOntology ontology,
java.io.OutputStream outputStream)
Saves the specified ontology, to the specified output stream |
void |
saveOntology(OWLOntology ontology,
OWLOntologyDocumentTarget documentTarget)
Saves the specified ontology to the specified OWLOntologyDocumentTarget . |
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat)
Saves the specified ontology in the specified ontology format to its document URI. |
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat,
IRI documentIRI)
Saves the specified ontology to the specified document IRI in the specified ontology format. |
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat,
java.io.OutputStream outputStream)
Saves the specified ontology to the specified output stream in the specified ontology format. |
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat,
OWLOntologyDocumentTarget documentTarget)
Saves the specified ontology to the specified output target in the specified ontology format. |
void |
setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy)
Sets the default strategy that is used to broadcast ontology changes. |
void |
setOntologyDocumentIRI(OWLOntology ontology,
IRI documentIRI)
Overrides the current document IRI for a given ontology. |
void |
setOntologyFormat(OWLOntology ontology,
OWLOntologyFormat format)
Sets the format of an ontology |
void |
setSilentMissingImportsHandling(boolean b)
The default behaviour when an import cannot be loaded is to throw an exception. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OWLOntologyManagerImpl(OWLDataFactory dataFactory)
Method Detail |
---|
public OWLOntologyManagerProperties getProperties()
public OWLDataFactory getOWLDataFactory()
OWLOntologyManager
getOWLDataFactory
in interface OWLOntologyManager
public java.util.Set<OWLOntology> getOntologies()
OWLOntologyManager
getOntologies
in interface OWLOntologyManager
getOntologies
in interface OWLOntologySetProvider
public java.util.Set<OWLOntology> getOntologies(OWLAxiom axiom)
OWLOntologyManager
getOntologies
in interface OWLOntologyManager
axiom
- The axioms
public boolean contains(OWLOntology ontology)
public boolean contains(IRI ontologyIRI)
OWLOntologyManager
contains
in interface OWLOntologyManager
ontologyIRI
- The IRI of the ontology to test for (the version IRI is assumed to be null
)
true
if there is an ontology with the specified IRI, and no version IRI, that is managed by this manager,
otherwise false
.public boolean contains(OWLOntologyID id)
OWLOntologyManager
contains
in interface OWLOntologyManager
id
- The id of the ontology to test for
true
if there is an ontology with the specified id that is managed by this manager,
otherwise false
.public OWLOntology getOntology(IRI ontologyIRI)
getOntology
in interface OWLOntologyManager
ontologyIRI
- The IRI of the ontology to be retrieved.
null
if this manager does
not manage an ontology with the specified IRI and no version IRI.public OWLOntology getOntology(OWLOntologyID ontologyID)
getOntology
in interface OWLOntologyManager
ontologyID
- The ID of the ontology to retrieve
null
if this manager does not manage an ontology
with the specified ontology ID.public java.util.Set<OWLOntology> getVersions(IRI ontology)
OWLOntologyManager
getVersions
in interface OWLOntologyManager
ontology
- The ontology IRI
public OWLOntology getImportedOntology(OWLImportsDeclaration declaration)
getImportedOntology
in interface OWLOntologyManager
declaration
- The declaration that points to the imported ontology.
null
if the imports declaration
could not be resolved to an ontology, because the ontology was not loaded or has been removed from this
managerpublic java.util.Set<OWLOntology> getDirectImports(OWLOntology ontology) throws UnknownOWLOntologyException
getDirectImports
in interface OWLOntologyManager
ontology
- The ontology whose direct imports are to be retrieved.
UnknownOWLOntologyException
- if there isn't an ontology in this manager which has the specified IRI.public java.util.Set<OWLOntology> getImports(OWLOntology ontology) throws UnknownOWLOntologyException
getImports
in interface OWLOntologyManager
ontology
- The ontology whose imports are to be retrieved.
OWLOntology
ies that are in the transitive closure of the directly imports relation
of this ontology. If, for what ever reason, an imported ontology could not be loaded, then it will not be contained in the
returned set of ontologies.
UnknownOWLOntologyException
- if there isn't an ontology in this manager which has the specified IRI.public java.util.Set<OWLOntology> getImportsClosure(OWLOntology ontology)
OWLOntologyManager
getImportsClosure
in interface OWLOntologyManager
ontology
- The ontology whose imports closure is to be retrieved.
Set
of ontologies that contains the imports closure for the specified ontology. This set
will also include the specified ontology. Example: if A imports B and B imports C, then calling this
method with A will return the set consisting of A, B and C. If, for what ever reason, an imported
ontology could not be loaded, then it will not be contained in the returned set of ontologies.
If the ontology is not managed by this manager then the empty set will be returned.public java.util.List<OWLOntology> getSortedImportsClosure(OWLOntology ontology) throws UnknownOWLOntologyException
OWLOntologyManager
getSortedImportsClosure
in interface OWLOntologyManager
ontology
- The ontology whose imports closure is to be determined.
UnknownOWLOntologyException
public java.util.List<OWLOntologyChange> applyChanges(java.util.List<? extends OWLOntologyChange> changes)
OWLOntologyManager
applyChanges
in interface OWLOntologyManager
changes
- The changes to be applied.
public java.util.List<OWLOntologyChange> addAxiom(OWLOntology ont, OWLAxiom axiom)
OWLOntologyManager
addAxiom
in interface OWLOntologyManager
ont
- The ontology to add the axiom to.axiom
- The axiom to be added
public java.util.List<OWLOntologyChange> addAxioms(OWLOntology ont, java.util.Set<? extends OWLAxiom> axioms)
OWLOntologyManager
addAxioms
in interface OWLOntologyManager
ont
- The ontology to which the axioms should be added.axioms
- The axioms to be added.
public java.util.List<OWLOntologyChange> removeAxiom(OWLOntology ont, OWLAxiom axiom)
OWLOntologyManager
removeAxiom
in interface OWLOntologyManager
ont
- The ontology to remove the axiom from.axiom
- The axiom to be removed
public java.util.List<OWLOntologyChange> removeAxioms(OWLOntology ont, java.util.Set<? extends OWLAxiom> axioms)
OWLOntologyManager
removeAxioms
in interface OWLOntologyManager
ont
- The ontology from which the axioms should be removed.axioms
- The axioms to be removed.
public java.util.List<OWLOntologyChange> applyChange(OWLOntologyChange change)
OWLOntologyManager
applyChange
in interface OWLOntologyManager
change
- The change to be applied
public void ontologyCreated(OWLOntology ontology)
OWLOntologyFactory.OWLOntologyCreationHandler
ontologyCreated
in interface OWLOntologyFactory.OWLOntologyCreationHandler
ontology
- The newly created ontology.public void setOntologyFormat(OWLOntology ontology, OWLOntologyFormat format)
setOntologyFormat
in interface OWLOntologyFactory.OWLOntologyCreationHandler
setOntologyFormat
in interface OWLOntologyManager
ontology
- The ontologyformat
- The format of the ontologypublic OWLOntologyFormat getOntologyFormat(OWLOntology ontology)
OWLOntologyManager
getOntologyFormat
in interface OWLOntologyManager
ontology
- The ontology whose format it to be obtained.
public OWLOntology createOntology() throws OWLOntologyCreationException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
OWLOntologyCreationException
- if there was a problem creating the ontologypublic OWLOntology createOntology(IRI ontologyIRI) throws OWLOntologyCreationException
OWLOntologyManager
OWLOntologyIRIMapper
s. If no mappers are installed
or the ontology IRI was not mapped to a document IRI by any of the installed mappers, then the ontology document
IRI will be set to the value of ontologyIRI
.
createOntology
in interface OWLOntologyManager
ontologyIRI
- The IRI of the ontology to be created. The ontology IRI will be mapped to a document IRI in
order to determine the type of ontology factory that will be used to create the ontology. If
this mapping is null
then a default (in memory) implementation of the ontology
will most likely be created.
OWLOntologyCreationException
- If the ontology could not be created.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyIRI
(and no version IRI).
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyIRI
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology createOntology(IRI ontologyIRI, IRI versionIRI) throws OWLOntologyCreationException
OWLOntologyCreationException
public OWLOntology createOntology(OWLOntologyID ontologyID) throws OWLOntologyCreationException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
ontologyID
- The ID of the ontology to be created.
The ontology document IRI of the created ontology will be set to the value returned
by any installed OWLOntologyIRIMapper
s. If no mappers are installed
or the ontology IRI was not mapped to a document IRI by any of the installed mappers, then the ontology document
IRI will be set to the value of ontologyIRI
.
OWLOntologyCreationException
- If the ontology could not be created.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyID
(and no version IRI).
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyID
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology createOntology(IRI ontologyIRI, java.util.Set<OWLOntology> ontologies) throws OWLOntologyCreationException
OWLOntologyManager
OWLOntologyIRIMapper
s. If no mappers are installed
or the ontology IRI was not mapped to a document IRI by any of the installed mappers, then the ontology document
IRI will be set to the value of ontologyIRI
.
createOntology
in interface OWLOntologyManager
ontologyIRI
- The IRI of the new ontology.ontologies
- The ontologies whose axioms should be copied into the new ontology
OWLOntologyCreationException
- if there was a problem creating the new ontology, if the new ontology
already exists in this manager.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyIRI
(and no version IRI).
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyIRI
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology createOntology(IRI ontologyIRI, java.util.Set<OWLOntology> ontologies, boolean copyLogicalAxiomsOnly) throws OWLOntologyCreationException
OWLOntologyManager
OWLOntologyIRIMapper
s. If no mappers are installed
or the ontology IRI was not mapped to a document IRI by any of the installed mappers, then the ontology document
IRI will be set to the value of ontologyIRI
.
createOntology
in interface OWLOntologyManager
ontologyIRI
- The IRI of the new ontology.ontologies
- The ontologies whose axioms should be copied into the new ontologycopyLogicalAxiomsOnly
- If set to true
only logical axioms are copied into the new ontology.
If set to false
then all axioms (including annotation axioms) are
copied into the new ontology.
OWLOntologyCreationException
- if there was a problem creating the new ontology, if the new ontology
already exists in this manager.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyIRI
(and no ontology version IRI).
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyIRI
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology createOntology(java.util.Set<OWLAxiom> axioms, IRI iri) throws OWLOntologyCreationException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
axioms
- The axioms that should be copied into the new ontologyiri
- The IRI of the new ontology.
The ontology document IRI of the created ontology will be set to the value returned
by any installed OWLOntologyIRIMapper
s. If no mappers are installed
or the ontology IRI was not mapped to a document IRI by any of the installed mappers, then the ontology document
IRI will be set to the value of ontologyIRI
.
OWLOntologyCreationException
- if there was a problem creating the new ontology, if the new ontology
already exists in this manager.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyIRI
.
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyIRI
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology createOntology(java.util.Set<OWLAxiom> axioms) throws OWLOntologyCreationException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
axioms
- The axioms that should be copied into the new ontology
OWLOntologyCreationException
- if there was a problem creating the new ontology.protected IRI getNextAutoGeneratedIRI()
public OWLOntology loadOntology(IRI ontologyIRI) throws OWLOntologyCreationException
OWLOntologyManager
ontologyIRI
as its IRI or version IRI.
The ontology IRI will be mapped to an ontology document IRI. The mapping will be determined using one of the loaded
OWLOntologyIRIMapper
objects. By default, if no custom OWLOntologyIRIMapper
s have been registered
using the OWLOntologyManager.addIRIMapper(OWLOntologyIRIMapper)
method, or no mapping can be found, the ontology document
IRI is taken to be the specified ontology IRI.
loadOntology
in interface OWLOntologyManager
ontologyIRI
- The IRI that identifies the ontology. It is expected that the ontology will also have this
IRI (although the OWL API will tolerated situations where this is not the case).
OWLOntology
representation of the ontology that was loaded.
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.
UnparsableOntologyException
- if the ontology was being parsed from a document and
the document contained syntax errors.
UnloadableImportException
- if the ontology imports ontologies and one of the imports could not be loaded
for what ever reason. If silent missing imports handling is set to true
then this exception will
not be thrown. The UnloadableImportException
contains information about the import declaration
that triggered the import and the cause of this exception is an OWLOntologyCreationException
which contains information about why the import could not be loaded.
OWLOntologyCreationIOException
- if there was an IOException
when trying to load the ontology.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology with the specified
ontologyIRI
(where the ontology doesn't have a version IRI).
OWLOntologyDocumentAlreadyExistsException
- if the specified ontologyIRI
is mapped to a
ontology document IRI for which there already exists a mapping in this manager.public OWLOntology loadOntologyFromOntologyDocument(IRI documentIRI) throws OWLOntologyCreationException
OWLOntologyManager
OWLOntologyManager.loadOntology(IRI)
method, no mapping is performed on the specified IRI.
loadOntologyFromOntologyDocument
in interface OWLOntologyManager
documentIRI
- The ontology document IRI where the ontology will be loaded from.
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.
UnparsableOntologyException
- if the ontology was being parsed from a document and
the document contained syntax errors.
UnloadableImportException
- if the ontology imports ontologies and one of the imports could not be loaded
for what ever reason. If silent missing imports handling is set to true
then this exception will
not be thrown. The UnloadableImportException
contains information about the import declaration
that triggered the import and the cause of this exception is an OWLOntologyCreationException
which contains information about why the import could not be loaded.
OWLOntologyCreationIOException
- if there was an IOException
when trying to load the ontology.
OWLOntologyDocumentAlreadyExistsException
- if the specified documentIRI
is already
the document IRI for a loaded ontology.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology whose ontology IRI and
version IRI is the same as the ontology IRI and version IRI of the ontology contained in the document pointed
to by documentIRI
.public OWLOntology loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource) throws OWLOntologyCreationException
OWLOntologyManager
loadOntologyFromOntologyDocument
in interface OWLOntologyManager
documentSource
- The input source that describes where the ontology should be loaded from.
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.
UnparsableOntologyException
- if the ontology was being parsed from a document and
the document contained syntax errors.
UnloadableImportException
- if the ontology imports ontologies and one of the imports could not be loaded
for what ever reason. If silent missing imports handling is set to true
then this exception will
not be thrown. The UnloadableImportException
contains information about the import declaration
that triggered the import and the cause of this exception is an OWLOntologyCreationException
which contains information about why the import could not be loaded.
OWLOntologyCreationIOException
- if there was an IOException
when trying to load the ontology.
OWLOntologyDocumentAlreadyExistsException
- if the document IRI of the input source is already
the document IRI for a loaded ontology.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology whose ontology IRI and
version IRI is the same as the ontology IRI and version IRI of the ontology contained in the document
represented by the input source.public OWLOntology loadOntologyFromOntologyDocument(java.io.File file) throws OWLOntologyCreationException
OWLOntologyManager
loadOntologyFromOntologyDocument
in interface OWLOntologyManager
file
- The file that contains a representation of an ontology
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.
UnparsableOntologyException
- if the ontology could not be parsed.
UnloadableImportException
- if the ontology imports ontologies and one of the imports could not be loaded
for what ever reason. If silent missing imports handling is set to true
then this exception will
not be thrown. The UnloadableImportException
contains information about the import declaration
that triggered the import and the cause of this exception is an OWLOntologyCreationException
which contains information about why the import could not be loaded.
OWLOntologyCreationIOException
- if there was an IOException
when trying to load the ontology.
OWLOntologyDocumentAlreadyExistsException
- if the IRI of the specified file is already
the document IRI for a loaded ontology.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology whose ontology IRI and
version IRI is the same as the ontology IRI and version IRI of the ontology contained in the document pointed
to by documentIRI
.public OWLOntology loadOntologyFromOntologyDocument(java.io.InputStream inputStream) throws OWLOntologyCreationException
OWLOntologyManager
loadOntologyFromOntologyDocument
in interface OWLOntologyManager
inputStream
- The input stream that can be used to obtain a representation of an ontology
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.
UnparsableOntologyException
- if the ontology could not be parsed.
UnloadableImportException
- if the ontology imports ontologies and one of the imports could not be loaded
for what ever reason. If silent missing imports handling is set to true
then this exception will
not be thrown. The UnloadableImportException
contains information about the import declaration
that triggered the import and the cause of this exception is an OWLOntologyCreationException
which contains information about why the import could not be loaded.
OWLOntologyCreationIOException
- if there was an IOException
when trying to load the ontology.
OWLOntologyAlreadyExistsException
- if the manager already contains an ontology whose ontology IRI and
version IRI is the same as the ontology IRI and version IRI of the ontology obtained from parsing the content
of the input stream.protected OWLOntology loadOntology(IRI ontologyIRI, OWLOntologyDocumentSource documentSource) throws OWLOntologyCreationException
ontologyIRI
- The URI of the ontology to be loaded. This is only used to
report to listeners and may be null
documentSource
- The input source that specifies where the ontology should be loaded from.
OWLOntologyCreationException
- If the ontology could not be loaded.public void removeOntology(OWLOntology ontology)
OWLOntologyManager
removeOntology
in interface OWLOntologyManager
ontology
- The ontology to be removed. If this manager does not manage the ontology then nothing happens.public IRI getOntologyDocumentIRI(OWLOntology ontology) throws UnknownOWLOntologyException
OWLOntologyManager
getOntologyDocumentIRI
in interface OWLOntologyManager
ontology
- The ontology whose document IRI is to be obtained.
null
.
UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.public void setOntologyDocumentIRI(OWLOntology ontology, IRI documentIRI) throws UnknownOWLOntologyException
OWLOntologyManager
setOntologyDocumentIRI
in interface OWLOntologyManager
ontology
- The ontology that has already been loaded.documentIRI
- The new ontology document IRI
UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.public void saveOntology(OWLOntology ontology) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.
OWLOntologyStorageException
- An exception will be thrown if there is a problem with saving the ontology,
or the ontology can't be saved in the format it was loaded from.
UnknownOWLOntologyException
- if this manager does not manage the specified ontologypublic void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.ontologyFormat
- The format in which the ontology should be saved.
OWLOntologyStorageException
- If the ontology cannot be saved.
UnknownOWLOntologyException
- if the specified ontology is not managed by this managerpublic void saveOntology(OWLOntology ontology, IRI documentIRI) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.documentIRI
- The document IRI where the ontology should be saved to
OWLOntologyStorageException
- If the ontology cannot be saved
UnknownOWLOntologyException
- if the specified ontology is not managed by this manager.public void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, IRI documentIRI) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be savedontologyFormat
- The format in which to save the ontologydocumentIRI
- The document IRI where the ontology should be saved to
OWLOntologyStorageException
- If the ontology could not be saved.
UnknownOWLOntologyException
- if the specified ontology is not managed by the manager.public void saveOntology(OWLOntology ontology, java.io.OutputStream outputStream) throws OWLOntologyStorageException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.outputStream
- The output stream where the ontology will be saved to
OWLOntologyStorageException
- If there was a problem saving this ontology to the specified output streampublic void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, java.io.OutputStream outputStream) throws OWLOntologyStorageException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be savedontologyFormat
- The format in which to save the ontologyoutputStream
- The output stream where the ontology will be saved to.
OWLOntologyStorageException
- If the ontology could not be saved.public void saveOntology(OWLOntology ontology, OWLOntologyDocumentTarget documentTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
OWLOntologyDocumentTarget
.
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.documentTarget
- The output target where the ontology will be saved to.
OWLOntologyStorageException
- If the ontology could not be saved.
UnknownOWLOntologyException
- if the specified ontology is not managed by this manager.public void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, OWLOntologyDocumentTarget documentTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.ontologyFormat
- The output format in which to save the ontologydocumentTarget
- The output target where the ontology will be saved to
OWLOntologyStorageException
- If the ontology could not be saved.
UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.public void addOntologyStorer(OWLOntologyStorer storer)
OWLOntologyManager
addOntologyStorer
in interface OWLOntologyManager
storer
- The storer to be addedpublic void removeOntologyStorer(OWLOntologyStorer storer)
OWLOntologyManager
removeOntologyStorer
in interface OWLOntologyManager
storer
- The storer to be removedpublic void addIRIMapper(OWLOntologyIRIMapper mapper)
OWLOntologyManager
addIRIMapper
in interface OWLOntologyManager
mapper
- The mapper to be added.public void clearIRIMappers()
OWLOntologyManager
clearIRIMappers
in interface OWLOntologyManager
public void removeIRIMapper(OWLOntologyIRIMapper mapper)
OWLOntologyManager
removeIRIMapper
in interface OWLOntologyManager
mapper
- The mapper to be removed. If this manager does not managed the specified mapper then nothing will
happen.public void addOntologyFactory(OWLOntologyFactory factory)
OWLOntologyManager
addOntologyFactory
in interface OWLOntologyManager
factory
- The factory to be added.public void removeOntologyFactory(OWLOntologyFactory factory)
OWLOntologyManager
removeOntologyFactory
in interface OWLOntologyManager
factory
- The factory to be removed.public java.util.Collection<OWLOntologyFactory> getOntologyFactories()
getOntologyFactories
in interface OWLOntologyManager
public void addOntologyChangeListener(OWLOntologyChangeListener listener)
OWLOntologyManager
addOntologyChangeListener
method which takes a
broadcast strategy as an argument should be used.
addOntologyChangeListener
in interface OWLOntologyManager
listener
- The listener to be added.public void setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy)
OWLOntologyManager
setDefaultChangeBroadcastStrategy
in interface OWLOntologyManager
strategy
- The strategy to be used for broadcasting changes. This strategy will override any previously
set broadcast strategy. The strategy should not be null
.org.semanticweb.owlapi.model.DefaultChangeBroadcastStrategy}
,
org.semanticweb.owlapi.model.EDTChangeBroadcastStrategy}
public void addOntologyChangeListener(OWLOntologyChangeListener listener, OWLOntologyChangeBroadcastStrategy strategy)
OWLOntologyManager
addOntologyChangeListener
in interface OWLOntologyManager
listener
- The listener to be added.strategy
- The strategy that should be used for broadcasting changes to the listener.public void addImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
addImpendingOntologyChangeListener
in interface OWLOntologyManager
public void removeImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
removeImpendingOntologyChangeListener
in interface OWLOntologyManager
public void removeOntologyChangeListener(OWLOntologyChangeListener listener)
OWLOntologyManager
removeOntologyChangeListener
in interface OWLOntologyManager
listener
- The listener to be removed.public void addOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
addOntologyChangesVetoedListener
in interface OWLOntologyManager
public void removeOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
removeOntologyChangesVetoedListener
in interface OWLOntologyManager
public void makeLoadImportRequest(OWLImportsDeclaration declaration) throws UnloadableImportException
OWLOntologyManager
makeLoadImportRequest
in interface OWLOntologyManager
declaration
- The declaration that describes the import to be loaded.
UnloadableImportException
- if there was a problem creating and loading the import and
silent missing imports handling is not turned on. If silent missing import handling is turned on then
this exception will not be thrown.public void setSilentMissingImportsHandling(boolean b)
OWLOntologyManager
setSilentMissingImportsHandling
in interface OWLOntologyManager
b
- true
if loading should continue when an imported ontology cannot be loaded, other wise
false
. The default value is false
.public boolean isSilentMissingImportsHandling()
OWLOntologyManager
isSilentMissingImportsHandling
in interface OWLOntologyManager
true
if silent missing imports handler is enabled, otherwise false
.public void addMissingImportListener(MissingImportListener listener)
OWLOntologyManager
addMissingImportListener
in interface OWLOntologyManager
listener
- The listener to be added.public void removeMissingImportListener(MissingImportListener listener)
OWLOntologyManager
removeMissingImportListener
in interface OWLOntologyManager
listener
- The listener to be removed.protected void fireMissingImportEvent(MissingImportEvent evt)
public void addOntologyLoaderListener(OWLOntologyLoaderListener listener)
OWLOntologyManager
addOntologyLoaderListener
in interface OWLOntologyManager
listener
- The listener to be added.public void removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
OWLOntologyManager
removeOntologyLoaderListener
in interface OWLOntologyManager
listener
- The listener to be removed.protected void fireStartedLoadingEvent(OWLOntologyID ontologyID, IRI documentIRI, boolean imported)
protected void fireFinishedLoadingEvent(OWLOntologyID ontologyID, IRI documentIRI, boolean imported, OWLOntologyCreationException ex)
public void addOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
OWLOntologyManager
addOntologyChangeProgessListener
in interface OWLOntologyManager
listener
- The listener to be added.public void removeOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
OWLOntologyManager
removeOntologyChangeProgessListener
in interface OWLOntologyManager
listener
- The listener to be removed.protected void fireBeginChanges(int size)
protected void fireEndChanges()
protected void fireChangeApplied(OWLOntologyChange change)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |