public interface OWLOntologyManager extends OWLOntologySetProvider, HasDataFactory, HasGetOntologyById, HasApplyChanges, HasAddAxioms, HasContainsOntology
OWLOntologyManager
manages a set of ontologies. It is the main
point for creating, loading and accessing ontologies. OWLOntologyManager
also manages the mapping betweem an ontology and
its ontology document.Modifier and Type | Method and Description |
---|---|
List<OWLOntologyChange> |
addAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that adds a single axiom to an ontology.
|
List<OWLOntologyChange> |
addAxioms(OWLOntology ont,
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.
|
List<OWLOntologyChange> |
applyChange(OWLOntologyChange change)
A convenience method that applies just one change to an ontology that is
managed by this manager.
|
List<OWLOntologyChange> |
applyChanges(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(OWLOntologyID id)
Determines if there is an ontology with the specified id that is managed
by this manager
|
boolean |
containsVersion(IRI ontologyVersionIRI)
Determines if there is an ontology with the specified version IRI, 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,
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,
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(Set<OWLAxiom> axioms)
Creates a new ontology that is initialised to contain specific axioms.
|
OWLOntology |
createOntology(Set<OWLAxiom> axioms,
IRI ontologyIRI)
Creates a new ontology that has the specified ontology IRI and is
initialised to contain specific axioms.
|
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.
|
Set<OWLOntology> |
getImports(OWLOntology ontology)
Gets the set of ontologies that are in the transitive closure of the
directly imports relation.
|
Set<OWLOntology> |
getImportsClosure(OWLOntology ontology)
Gets the imports closure for the specified ontology.
|
Set<OWLOntology> |
getOntologies()
Gets the (possibly empty) set of
OWLOntology objects contained within
this object. |
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.
|
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.
|
Set<OWLOntologyID> |
getOntologyIDsByVersion(IRI ontologyVersionIRI)
Gets a set of OWLOntologyIDs representing ontologies that are managed by
this manager.
|
OWLDataFactory |
getOWLDataFactory()
Gets a data factory which can be used to create OWL API objects such as
classes, properties, individuals, axioms etc.
|
List<OWLOntology> |
getSortedImportsClosure(OWLOntology ontology)
Gets the topologically ordered imports closure.
|
Set<OWLOntology> |
getVersions(IRI ontology)
Gets the versions (if any) of the ontology that have the specified IRI
|
boolean |
isSilentMissingImportsHandling()
Deprecated.
check it on the
OWLOntologyLoaderConfiguration object
instead using
OWLOntologyLoaderConfiguration.getMissingImportHandlingStrategy() |
OWLOntology |
loadOntology(IRI ontologyIRI)
Loads an ontology that is assumed to have the specified
ontologyIRI as its IRI or version IRI. |
OWLOntology |
loadOntologyFromOntologyDocument(File file)
Loads an ontology from an ontology document contained in a local file.
|
OWLOntology |
loadOntologyFromOntologyDocument(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.
|
OWLOntology |
loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource,
OWLOntologyLoaderConfiguration config)
A convenience method that load an ontology from an input source with
specified configuration.
|
void |
makeLoadImportRequest(OWLImportsDeclaration declaration)
Deprecated.
|
void |
makeLoadImportRequest(OWLImportsDeclaration declaration,
OWLOntologyLoaderConfiguration configuration)
Requests that the manager loads an imported ontology that is described by
an imports statement.
|
List<OWLOntologyChange> |
removeAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that removes a single axiom from an ontology.
|
List<OWLOntologyChange> |
removeAxioms(OWLOntology ont,
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 |
removeOntology(OWLOntologyID ontologyID)
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,
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,
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 ontologyFormat)
Sets the format for the specified ontology.
|
void |
setSilentMissingImportsHandling(boolean b)
Deprecated.
set it on the
OWLOntologyLoaderConfiguration object
instead using
OWLOntologyLoaderConfiguration.setMissingImportHandlingStrategy(MissingImportHandlingStrategy)
. |
OWLDataFactory getOWLDataFactory()
getOWLDataFactory
in interface HasDataFactory
Set<OWLOntology> getOntologies()
HasGetOntologies
OWLOntology
objects contained within
this object.getOntologies
in interface HasGetOntologies
null
.Set<OWLOntology> getOntologies(OWLAxiom axiom)
axiom
- The axiomsSet<OWLOntology> getVersions(IRI ontology)
ontology
- The ontology IRIboolean contains(IRI ontologyIRI)
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
.boolean contains(OWLOntologyID id)
contains
in interface HasContainsOntology
id
- The id of the ontology to test fortrue
if there is an ontology with the specified id that
is managed by this manager, otherwise false
.boolean containsVersion(IRI ontologyVersionIRI)
ontologyVersionIRI
- The version IRI of the ontology to test for (the ontology IRI may
be anything)true
if there is an ontology with the specified version
IRI, that is managed by this manager, otherwise false
.Set<OWLOntologyID> getOntologyIDsByVersion(IRI ontologyVersionIRI)
ontologyVersionIRI
- The version IRI to match against all of the known ontologies.OWLOntology getOntology(IRI ontologyIRI)
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.OWLOntology getOntology(OWLOntologyID ontologyID)
getOntology
in interface HasGetOntologyById
ontologyID
- The ID of the ontology to retrievenull
if this
manager does not manage an ontology with the specified ontology
ID.OWLOntology getImportedOntology(OWLImportsDeclaration declaration)
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 managerSet<OWLOntology> getDirectImports(OWLOntology ontology)
ontology
- The ontology whose direct imports are to be retrieved.Set<OWLOntology> getImports(OWLOntology ontology)
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.
If the ontology is not managed by this manager then the empty set
will be returned.Set<OWLOntology> getImportsClosure(OWLOntology ontology)
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.List<OWLOntology> getSortedImportsClosure(OWLOntology ontology)
ontology
- The ontology whose imports closure is to be determined.List<OWLOntologyChange> applyChanges(List<? extends OWLOntologyChange> changes) throws OWLOntologyRenameException
applyChanges
in interface HasApplyChanges
changes
- The changes to be applied.OWLOntologyChangeException
- If one or more of the changes could not be applied. See
subclasses of ontology change exception for more specific
details.OWLOntologyRenameException
- If one or more of the changes is an instance of
SetOntologyID
where the new
OWLOntologyID
already
belongs to an ontology managed by this manager.List<OWLOntologyChange> addAxioms(OWLOntology ont, Set<? extends OWLAxiom> axioms)
addAxioms
in interface HasAddAxioms
ont
- The ontology to which the axioms should be added.axioms
- The axioms to be added.OWLOntologyChangeException
- if there was a problem adding the axiomsList<OWLOntologyChange> addAxiom(OWLOntology ont, OWLAxiom axiom)
ont
- The ontology to add the axiom to.axiom
- The axiom to be addedOWLOntologyChangeException
- if there was a problem adding the axiomList<OWLOntologyChange> removeAxiom(OWLOntology ont, OWLAxiom axiom)
ont
- The ontology to remove the axiom from.axiom
- The axiom to be removedOWLOntologyChangeException
- if there was a problem removing the axiomList<OWLOntologyChange> removeAxioms(OWLOntology ont, Set<? extends OWLAxiom> axioms)
ont
- The ontology from which the axioms should be removed.axioms
- The axioms to be removed.OWLOntologyChangeException
- if there was a problem removing the axiomsList<OWLOntologyChange> applyChange(OWLOntologyChange change) throws OWLOntologyRenameException
change
- The change to be appliedOWLOntologyChangeException
- If the change could not be applied. See subclasses of ontology
change exception for more specific details.OWLOntologyRenameException
- If one or more of the changes is an instance of
SetOntologyID
where the new
OWLOntologyID
already
belongs to an ontology managed by this manager.OWLOntology createOntology() throws OWLOntologyCreationException
OWLOntologyCreationException
- if there was a problem creating the ontologyOWLOntology createOntology(Set<OWLAxiom> axioms) throws OWLOntologyCreationException
axioms
- The axioms that should be copied into the new ontologyOWLOntologyCreationException
- if there was a problem creating the new ontology.OWLOntologyChangeException
- if there was a problem copying the axioms.OWLOntology createOntology(Set<OWLAxiom> axioms, IRI ontologyIRI) throws OWLOntologyCreationException
ontologyIRI
- The IRI of the new ontology. 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
.axioms
- The axioms that should be copied into the new ontologyOWLOntologyCreationException
- if there was a problem creating the new ontology, if the new
ontology already exists in this manager.OWLOntologyChangeException
- if there was a problem copying the axioms.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.OWLOntology createOntology(IRI ontologyIRI) throws OWLOntologyCreationException
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
.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.OWLOntology createOntology(OWLOntologyID ontologyID) throws OWLOntologyCreationException
ontologyID
- The ID of the ontology to be created. 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.OWLOntology createOntology(IRI ontologyIRI, Set<OWLOntology> ontologies, boolean copyLogicalAxiomsOnly) throws OWLOntologyCreationException
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
.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.OWLOntology createOntology(IRI ontologyIRI, Set<OWLOntology> ontologies) throws OWLOntologyCreationException
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
.ontologyIRI
- The IRI of the new ontology.ontologies
- The ontologies whose axioms should be copied into the new ontologyOWLOntologyCreationException
- 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.OWLOntology loadOntology(IRI ontologyIRI) throws OWLOntologyCreationException
ontologyIRI
as its IRI or version IRI. OWLOntologyIRIMapper
objects. By default, if no custom OWLOntologyIRIMapper
s have been
registered using the addIRIMapper(OWLOntologyIRIMapper)
method,
or no mapping can be found, the ontology document IRI is taken to be the
specified ontology IRI.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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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.OWLOntology loadOntologyFromOntologyDocument(IRI documentIRI) throws OWLOntologyCreationException
loadOntology(IRI)
method, no mapping is
performed on the specified IRI.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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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
.OWLOntology loadOntologyFromOntologyDocument(File file) throws OWLOntologyCreationException
file
- The file that contains a representation of an ontologyOWLOntologyCreationException
- 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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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
.OWLOntology loadOntologyFromOntologyDocument(InputStream inputStream) throws OWLOntologyCreationException
inputStream
- The input stream that can be used to obtain a representation of an
ontologyOWLOntologyCreationException
- 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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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.OWLOntology loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource) throws OWLOntologyCreationException
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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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.OWLOntology loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource, OWLOntologyLoaderConfiguration config) throws OWLOntologyCreationException
documentSource
- The input source that describes where the ontology should be
loaded from.config
- the configuration to useOWLOntologyCreationException
- 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 the
MissingImportHandlingStrategy
is set to
MissingImportHandlingStrategy.SILENT
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.void removeOntology(OWLOntology ontology)
ontology
- The ontology to be removed. If this manager does not manage the
ontology then nothing happens.void removeOntology(OWLOntologyID ontologyID)
ontologyID
- The ontology to be removed. If this manager does not manage the
ontology then nothing happens.IRI getOntologyDocumentIRI(OWLOntology ontology)
ontology
- The ontology whose document IRI is to be obtained.null
.UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.void setOntologyDocumentIRI(OWLOntology ontology, IRI documentIRI) throws UnknownOWLOntologyException
ontology
- The ontology that has already been loaded.documentIRI
- The new ontology document IRIUnknownOWLOntologyException
- If the specified ontology is not managed by this manager.OWLOntologyFormat getOntologyFormat(OWLOntology ontology) throws UnknownOWLOntologyException
ontology
- The ontology whose format it to be obtained.UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.void setOntologyFormat(OWLOntology ontology, OWLOntologyFormat ontologyFormat)
ontology
- The ontology whose format is to be set.ontologyFormat
- The format for the specified ontology.UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.void saveOntology(OWLOntology ontology) throws OWLOntologyStorageException
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 ontologyvoid saveOntology(OWLOntology ontology, IRI documentIRI) throws OWLOntologyStorageException
ontology
- The ontology to be saved.documentIRI
- The document IRI where the ontology should be saved toOWLOntologyStorageException
- If the ontology cannot be savedUnknownOWLOntologyException
- if the specified ontology is not managed by this manager.void saveOntology(OWLOntology ontology, OutputStream outputStream) throws OWLOntologyStorageException
ontology
- The ontology to be saved.outputStream
- The output stream where the ontology will be saved toOWLOntologyStorageException
- If there was a problem saving this ontology to the specified
output streamUnknownOWLOntologyException
- if this manager does not manage the specified ontology.void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat) throws OWLOntologyStorageException
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 managervoid saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, IRI documentIRI) throws OWLOntologyStorageException
ontology
- The ontology to be savedontologyFormat
- The format in which to save the ontologydocumentIRI
- The document IRI where the ontology should be saved toOWLOntologyStorageException
- If the ontology could not be saved.UnknownOWLOntologyException
- if the specified ontology is not managed by the manager.void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, OutputStream outputStream) throws OWLOntologyStorageException
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.UnknownOWLOntologyException
- if the specified ontology is not managed by the manager.void saveOntology(OWLOntology ontology, OWLOntologyDocumentTarget documentTarget) throws OWLOntologyStorageException
OWLOntologyDocumentTarget
.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.void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, OWLOntologyDocumentTarget documentTarget) throws OWLOntologyStorageException
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 toOWLOntologyStorageException
- If the ontology could not be saved.UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.void addIRIMapper(OWLOntologyIRIMapper mapper)
mapper
- The mapper to be added.void removeIRIMapper(OWLOntologyIRIMapper mapper)
mapper
- The mapper to be removed. If this manager does not managed the
specified mapper then nothing will happen.void clearIRIMappers()
void addOntologyFactory(OWLOntologyFactory factory)
factory
- The factory to be added.void removeOntologyFactory(OWLOntologyFactory factory)
factory
- The factory to be removed.Collection<OWLOntologyFactory> getOntologyFactories()
void addOntologyStorer(OWLOntologyStorer storer)
storer
- The storer to be addedvoid removeOntologyStorer(OWLOntologyStorer storer)
storer
- The storer to be removedvoid addOntologyChangeListener(OWLOntologyChangeListener listener)
addOntologyChangeListener
method which takes a broadcast strategy
as an argument should be used.listener
- The listener to be added.void addOntologyChangeListener(OWLOntologyChangeListener listener, OWLOntologyChangeBroadcastStrategy strategy)
listener
- The listener to be added.strategy
- The strategy that should be used for broadcasting changes to the
listener.void addImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
listener
- the listener to addvoid removeImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)
listener
- the listener to removevoid addOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
listener
- the listener to addvoid removeOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)
listener
- the listener to removevoid setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy)
strategy
- The strategy to be used for broadcasting changes. This strategy
will override any previously set broadcast strategy. The strategy
should not be null
.DefaultChangeBroadcastStrategy
,
EDTChangeBroadcastStrategy
void removeOntologyChangeListener(OWLOntologyChangeListener listener)
listener
- The listener to be removed.@Deprecated void makeLoadImportRequest(OWLImportsDeclaration declaration) throws UnloadableImportException
makeLoadImportRequest(OWLImportsDeclaration, OWLOntologyLoaderConfiguration)
instead.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.void makeLoadImportRequest(OWLImportsDeclaration declaration, OWLOntologyLoaderConfiguration configuration) throws UnloadableImportException
declaration
- The declaration that describes the import to be loaded.configuration
- The configuration object that passes arguments to the mechanism
used for loading.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.@Deprecated void setSilentMissingImportsHandling(boolean b)
OWLOntologyLoaderConfiguration
object
instead using
OWLOntologyLoaderConfiguration.setMissingImportHandlingStrategy(MissingImportHandlingStrategy)
.b
- true
if loading should continue when an imported ontology
cannot be loaded, other wise false
. The default value is
false
.@Deprecated boolean isSilentMissingImportsHandling()
OWLOntologyLoaderConfiguration
object
instead using
OWLOntologyLoaderConfiguration.getMissingImportHandlingStrategy()
true
if silent missing imports handler is enabled,
otherwise false
.void addMissingImportListener(MissingImportListener listener)
listener
- The listener to be added.void removeMissingImportListener(MissingImportListener listener)
listener
- The listener to be removed.void addOntologyLoaderListener(OWLOntologyLoaderListener listener)
listener
- The listener to be added.void removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
listener
- The listener to be removed.void addOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
listener
- The listener to be added.void removeOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
listener
- The listener to be removed.Copyright © 2017 The University of Manchester. All Rights Reserved.