|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OWLOntologyManager
Author: Matthew Horridge
The University Of Manchester
Bio-Health Informatics Group Date: 24-Oct-2006
The OWLOntologyManager
manages a set of ontologies. It is the main point for creating, loading and
accessing ontologies.
Method Summary | |
---|---|
java.util.List<OWLOntologyChange> |
addAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that adds a single axioms 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 |
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)
|
void |
addOntologyFactory(OWLOntologyFactory factory)
Adds an ontology factory that is capable of creating an ontology given a particular physical IRI. |
void |
addOntologyLoaderListener(OWLOntologyLoaderListener listener)
|
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(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,
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 ontologyIRI)
Creates a new ontology that has the specified ontology IRI and is initialised to contain specific axioms. |
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. |
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 |
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. |
java.net.URI |
getPhysicalURIForOntology(OWLOntology ontology)
Gets the physical IRI for a given ontology. |
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 the ontology specified by the ontologyIRI parameter. |
OWLOntology |
loadOntology(OWLOntologyInputSource inputSource)
A convenience method that load an ontology from an input source. |
OWLOntology |
loadOntologyFromPhysicalURI(java.net.URI uri)
A convenience method that loads an ontology from a physical URI. |
void |
makeLoadImportRequest(OWLImportsDeclaration declaration)
Requests that the manager loads an imported ontology that is described by an imports statement. |
java.util.List<OWLOntologyChange> |
removeAxiom(OWLOntology ont,
OWLAxiom axiom)
A convenience method that removes a single axioms 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 |
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)
|
void |
removeOntologyFactory(OWLOntologyFactory factory)
Removes a previously added factory. |
void |
removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
|
void |
removeOntologyStorer(OWLOntologyStorer storer)
Removes a previously added storer |
void |
saveOntology(OWLOntology ontology)
Saves the specified ontology. |
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat)
|
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat,
OWLOntologyOutputTarget outputTarget)
|
void |
saveOntology(OWLOntology ontology,
OWLOntologyFormat ontologyFormat,
java.net.URI physicalURI)
|
void |
saveOntology(OWLOntology ontology,
OWLOntologyOutputTarget outputTarget)
|
void |
saveOntology(OWLOntology ontology,
java.net.URI physicalURI)
Saves the specified ontology, using the specified IRI to determine where/how the ontology should be saved. |
void |
setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy)
Sets the default strategy that is used to broadcast ontology changes. |
void |
setOntologyFormat(OWLOntology ontology,
OWLOntologyFormat ontologyFormat)
Sets the format for the specified ontology. |
void |
setPhysicalURIForOntology(OWLOntology ontology,
java.net.URI physicalURI)
Overrides the current physical URI for a given ontology. |
void |
setSilentMissingImportsHandling(boolean b)
The default behaviour when an import cannot be loaded is to throw an exception. |
Method Detail |
---|
OWLDataFactory getOWLDataFactory()
java.util.Set<OWLOntology> getOntologies()
getOntologies
in interface OWLOntologySetProvider
java.util.Set<OWLOntology> getOntologies(OWLAxiom axiom)
axiom
- The axioms
java.util.Set<OWLOntology> getVersions(IRI ontology)
ontology
- The ontology IRI
boolean 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)
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
.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)
ontologyID
- The ID of the ontology to retrieve
null
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
managerjava.util.Set<OWLOntology> getDirectImports(OWLOntology ontology) throws UnknownOWLOntologyException
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.java.util.Set<OWLOntology> getImports(OWLOntology ontology) throws UnknownOWLOntologyException
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.java.util.Set<OWLOntology> getImportsClosure(OWLOntology ontology) throws UnknownOWLOntologyException
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.
UnknownOWLOntologyException
- if there isn't an ontology in this manager which has the specified IRI.java.util.List<OWLOntology> getSortedImportsClosure(OWLOntology ontology) throws UnknownOWLOntologyException
ontology
- The ontology whose imports closure is to be determined.
UnknownOWLOntologyException
- if there isn't an ontology in this manager that corresponds to the specified
ontologyjava.util.List<OWLOntologyChange> applyChanges(java.util.List<? extends OWLOntologyChange> changes) throws OWLOntologyChangeException
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.java.util.List<OWLOntologyChange> addAxioms(OWLOntology ont, java.util.Set<? extends OWLAxiom> axioms) throws OWLOntologyChangeException
ont
- The ontology to which the axioms should be added.axioms
- The axioms to be added.
OWLOntologyChangeException
- if there was a problem adding the axiomsjava.util.List<OWLOntologyChange> addAxiom(OWLOntology ont, OWLAxiom axiom) throws OWLOntologyChangeException
ont
- The ontology to add the axiom to.axiom
- The axiom to be added
OWLOntologyChangeException
- if there was a problem adding the axiomjava.util.List<OWLOntologyChange> removeAxiom(OWLOntology ont, OWLAxiom axiom) throws OWLOntologyChangeException
ont
- The ontology to remove the axiom from.axiom
- The axiom to be removed
OWLOntologyChangeException
- if there was a problem removing the axiomjava.util.List<OWLOntologyChange> removeAxioms(OWLOntology ont, java.util.Set<? extends OWLAxiom> axioms) throws OWLOntologyChangeException
ont
- The ontology from which the axioms should be removed.axioms
- The axioms to be removed.
OWLOntologyChangeException
- if there was a problem removing the axiomsjava.util.List<OWLOntologyChange> applyChange(OWLOntologyChange change) throws OWLOntologyChangeException
change
- The change to be applied
OWLOntologyChangeException
- If the change could not be applied. See subclasses of ontology change
exception for more specific details.OWLOntology createOntology() throws OWLOntologyCreationException
OWLOntologyCreationException
- if there was a problem creating the ontologyOWLOntology createOntology(java.util.Set<OWLAxiom> axioms) throws OWLOntologyCreationException, OWLOntologyChangeException
axioms
- The axioms that 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.
OWLOntologyChangeException
- if there was a problem copying the axioms.OWLOntology createOntology(java.util.Set<OWLAxiom> axioms, IRI ontologyIRI) throws OWLOntologyCreationException, OWLOntologyChangeException
ontologyIRI
- The IRI of the new ontology.axioms
- The axioms that 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.
OWLOntologyChangeException
- if there was a problem copying the axioms.OWLOntology createOntology(IRI ontologyIRI) throws OWLOntologyCreationException
ontologyIRI
- The IRI of the ontology to be created. The ontology IRI will be mapped to a physical 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.OWLOntology createOntology(OWLOntologyID ontologyID) throws OWLOntologyCreationException
ontologyID
- The ID of the ontology to be created. The ontology IRI will be mapped to a physical 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.OWLOntology createOntology(IRI ontologyIRI, java.util.Set<OWLOntology> ontologies, boolean copyLogicalAxiomsOnly) throws OWLOntologyCreationException, OWLOntologyChangeException
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.
OWLOntologyChangeException
- if there was a problem copying the axioms.OWLOntology createOntology(IRI ontologyIRI, java.util.Set<OWLOntology> ontologies) throws OWLOntologyCreationException, OWLOntologyChangeException
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.
OWLOntologyChangeException
- if there was a problem copying the axioms.OWLOntology loadOntology(IRI ontologyIRI) throws OWLOntologyCreationException
ontologyIRI
parameter. Note that this is NOT the
physical IRI that points to a concrete representation (e.g. an RDF/XML OWL file) of an ontology. The mapping to
a physical IRI will be determined by using one of the loaded OWLOntologyIRIMapper
s.
ontologyIRI
- The ontology IRI (sometimes called logical IRI of the ontology to be loaded)
OWLOntology
representation of the ontology that was loaded. If an ontology with the
specified IRI is already loaded then that ontology will be returned.
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.OWLOntology loadOntologyFromPhysicalURI(java.net.URI uri) throws OWLOntologyCreationException
uri
- The physical URI which points to a concrete representation of an ontology.
OWLOntologyCreationException
- If the ontology could not be created and loaded.OWLOntology loadOntology(OWLOntologyInputSource inputSource) throws OWLOntologyCreationException
inputSource
- The input source that describes where the ontology should be loaded from.
OWLOntologyCreationException
- if there was a problem loading the ontology from the specified input source,
or if the ontology imports other ontologies the exception is thrown if there was a problem handing imports.void removeOntology(OWLOntology ontology)
ontology
- The ontology to be removed. If this manager does not manage the ontology then nothing happens.java.net.URI getPhysicalURIForOntology(OWLOntology ontology) throws UnknownOWLOntologyException
ontology
- The ontology whose physical IRI is to be obtained.
UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.void setPhysicalURIForOntology(OWLOntology ontology, java.net.URI physicalURI) throws UnknownOWLOntologyException
ontology
- The ontology that has already been loaded.physicalURI
- The new physcial URI
UnknownOWLOntologyException
- 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.void saveOntology(OWLOntology ontology) throws OWLOntologyStorageException, UnknownOWLOntologyException
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
void saveOntology(OWLOntology ontology, java.net.URI physicalURI) throws OWLOntologyStorageException, UnknownOWLOntologyException
ontology
- The ontology to be saved.physicalURI
- The physical URI that specified how and where the ontology should be saved.
OWLOntologyStorageException
- If the ontology cannot be saved.
UnknownOWLOntologyException
void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyStorageException
UnknownOWLOntologyException
void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, java.net.URI physicalURI) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyStorageException
UnknownOWLOntologyException
void saveOntology(OWLOntology ontology, OWLOntologyOutputTarget outputTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyStorageException
UnknownOWLOntologyException
void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, OWLOntologyOutputTarget outputTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyStorageException
UnknownOWLOntologyException
void addIRIMapper(OWLOntologyIRIMapper mapper)
mapper
- The mapper to be added.void removeIRIMapper(OWLOntologyIRIMapper mapper)
mapper
- The mapper to be removed.void clearIRIMappers()
void addOntologyFactory(OWLOntologyFactory factory)
factory
- The factory to be added.void removeOntologyFactory(OWLOntologyFactory factory)
factory
- The factory to be removed.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 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.void makeLoadImportRequest(OWLImportsDeclaration declaration) throws OWLOntologyCreationException
declaration
- The declaration that describes the import to be loaded.
OWLOntologyCreationException
- if there was a problem creating and loading the import and
silent missing imports handling is not turned on.void setSilentMissingImportsHandling(boolean b)
b
- true
if loading should continue when an imported ontology cannot be loaded, other wise
false
. The default value is false
.boolean isSilentMissingImportsHandling()
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)
void removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
void addOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
void removeOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |