|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.manchester.cs.owl.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 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 |
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 |
addOntologyFactory(OWLOntologyFactory factory)
Adds an ontology factory that is capable of creating an ontology given a particular physical URI. |
void |
addOntologyLoaderListener(OWLOntologyLoaderListener listener)
|
void |
addOntologyStorer(OWLOntologyStorer storer)
Add an ontology storer. |
void |
addURIMapper(OWLOntologyURIMapper mapper)
Adds a mapper to this manager. |
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 |
clearURIMappers()
Clears any installed URI mappers |
boolean |
contains(OWLOntology ontology)
|
boolean |
contains(java.net.URI ontologyURI)
Determines if there is an ontology with the specified URI that is managed by this manager. |
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,
java.net.URI ontologyURI)
Creates a new ontology that has the specified ontology URI and is initialised to contain specific axioms. |
OWLOntology |
createOntology(java.net.URI ontologyURI)
Creates a new (empty) ontology that has the specified ontology URI. |
OWLOntology |
createOntology(java.net.URI ontologyURI,
java.util.Set<OWLOntology> ontologies)
Creates a new ontology that has the specified ontology URI and is initialised to contain the axioms that are contained in the specified ontologies. |
OWLOntology |
createOntology(java.net.URI ontologyURI,
java.util.Set<OWLOntology> ontologies,
boolean copyLogicalAxiomsOnly)
Creates a new ontology that has the specified ontology URI and is initialised to contain the axioms that are contained in the specified ontologies. |
OWLOntology |
getImportedOntology(OWLImportsDeclaration declaration)
Given an imports declaration, obtains the ontology that this imports has been resolved to. |
java.util.Set<OWLOntology> |
getImports(OWLOntology ontology)
Gets the set of ontologies that are directly imported by the specified ontology. |
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(java.net.URI ontologyURI)
Gets a previously loaded/created ontology that corresponds to the specified ontology URI. |
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 URI for a given ontology. |
OWLOntologyManagerProperties |
getProperties()
|
java.util.List<OWLOntology> |
getSortedImportsClosure(OWLOntology ontology)
Gets the topologically ordered imports closure. |
boolean |
isSilentMissingImportsHandling()
Determines if silent missing imports handling is enabled. |
OWLOntology |
loadOntology(OWLOntologyInputSource inputSource)
A convenience method that load an ontology from an input source. |
OWLOntology |
loadOntology(java.net.URI ontologyURI)
Loads the ontology specified by the ontologyURI parameter. |
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. |
void |
ontologyCreated(OWLOntology ontology)
The factory calls this method as soon as it has created an ontology. |
OWLOntology |
reloadOntology(java.net.URI ontologyURI)
Reloads an ontology that is already managed by this manager. |
void |
removeMissingImportListener(MissingImportListener listener)
Removes a previously added missing import listener. |
void |
removeOntology(java.net.URI ontologyURI)
Attempts to remove an ontology. |
void |
removeOntologyChangeListener(OWLOntologyChangeListener listener)
Removes a previously added listener. |
void |
removeOntologyFactory(OWLOntologyFactory factory)
Removes a previously added factory. |
void |
removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
|
void |
removeOntologyStorer(OWLOntologyStorer storer)
Removes a previously added storer |
void |
removeURIMapper(OWLOntologyURIMapper mapper)
Removes a mapper from this manager. |
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 physcialURI)
|
void |
saveOntology(OWLOntology ontology,
OWLOntologyOutputTarget outputTarget)
|
void |
saveOntology(OWLOntology ontology,
java.net.URI physicalURI)
Saves the specified ontology, using the specified URI to determine where/how the ontology should be saved. |
void |
setOntologyFormat(OWLOntology ontology,
OWLOntologyFormat format)
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. |
Methods inherited from class java.lang.Object |
---|
equals, 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(java.net.URI ontologyURI)
OWLOntologyManager
contains
in interface OWLOntologyManager
ontologyURI
- The URI of the ontology to test for
true
if there is an ontology with the specified URI that is managed by this manager,
otherwise false
.public OWLOntology getOntology(java.net.URI ontologyURI)
OWLOntologyManager
getOntology
in interface OWLOntologyManager
ontologyURI
- The URI of the ontology to be obtained (this is not the physical URI of the ontology).
public OWLOntology getImportedOntology(OWLImportsDeclaration declaration)
OWLOntologyManager
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 imported.public java.util.Set<OWLOntology> getImports(OWLOntology ontology)
OWLOntologyManager
getImports
in interface OWLOntologyManager
ontology
- The ontology whose direct imports are to be retrieved.
OWLOntology
instances that represent the direct imports of the specified 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.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.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
- if there isn't an ontology in this manager that corresponds to the specified
ontologypublic java.util.List<OWLOntologyChange> applyChanges(java.util.List<? extends OWLOntologyChange> changes) throws OWLOntologyChangeException
OWLOntologyManager
applyChanges
in interface OWLOntologyManager
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.public java.util.List<OWLOntologyChange> addAxiom(OWLOntology ont, OWLAxiom axiom) throws OWLOntologyChangeException
OWLOntologyManager
addAxiom
in interface OWLOntologyManager
ont
- The ontology to add the axiom to.axiom
- The axiom to be added
OWLOntologyChangeException
public java.util.List<OWLOntologyChange> addAxioms(OWLOntology ont, java.util.Set<? extends OWLAxiom> axioms) throws OWLOntologyChangeException
OWLOntologyManager
addAxioms
in interface OWLOntologyManager
ont
- The ontology to which the axioms should be added.axioms
- The axioms to be added.
OWLOntologyChangeException
public java.util.List<OWLOntologyChange> applyChange(OWLOntologyChange change) throws OWLOntologyChangeException
OWLOntologyManager
applyChange
in interface OWLOntologyManager
change
- The change to be applied
OWLOntologyChangeException
- If the change could not be applied. See subclasses of ontology change
exception for more specific details.public void ontologyCreated(OWLOntology ontology)
OWLOntologyFactory.OWLOntologyCreationHandler
ontologyCreated
in interface OWLOntologyFactory.OWLOntologyCreationHandler
ontology
- The newly created ontology.public void setOntologyFormat(OWLOntology ontology, OWLOntologyFormat format)
OWLOntologyManager
setOntologyFormat
in interface OWLOntologyFactory.OWLOntologyCreationHandler
setOntologyFormat
in interface OWLOntologyManager
ontology
- The ontology whose format is to be set.format
- The format for the specified ontology.public OWLOntologyFormat getOntologyFormat(OWLOntology ontology)
OWLOntologyManager
getOntologyFormat
in interface OWLOntologyManager
ontology
- The ontology whose format it to be obtained.
public OWLOntology createOntology(java.net.URI ontologyURI) throws OWLOntologyCreationException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
ontologyURI
- The URI of the ontology to be created. The ontology URI will be mapped to a physical URI 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.public OWLOntology createOntology(java.net.URI ontologyURI, java.util.Set<OWLOntology> ontologies) throws OWLOntologyCreationException, OWLOntologyChangeException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
ontologyURI
- The URI 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.public OWLOntology createOntology(java.net.URI ontologyURI, java.util.Set<OWLOntology> ontologies, boolean copyLogicalAxiomsOnly) throws OWLOntologyCreationException, OWLOntologyChangeException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
ontologyURI
- The URI 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.public OWLOntology createOntology(java.util.Set<OWLAxiom> axioms, java.net.URI ontologyURI) throws OWLOntologyCreationException, OWLOntologyChangeException
OWLOntologyManager
createOntology
in interface OWLOntologyManager
axioms
- The axioms that should be copied into the new ontologyontologyURI
- The URI of 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.public OWLOntology createOntology(java.util.Set<OWLAxiom> axioms) throws OWLOntologyCreationException, OWLOntologyChangeException
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, if the new ontology
already exists in this manager.
OWLOntologyChangeException
- if there was a problem copying the axioms.public OWLOntology loadOntology(java.net.URI ontologyURI) throws OWLOntologyCreationException
OWLOntologyManager
ontologyURI
parameter. Note that this is NOT the
physical URI that points to a concrete representation (e.g. an RDF/XML OWL file) of an ontology. The mapping to
a physical URI will be determined by using one of the loaded OWLOntologyURIMapper
s.
loadOntology
in interface OWLOntologyManager
ontologyURI
- The ontology URI (sometimes called logical URI of the ontology to be loaded)
OWLOntology
representation of the ontology that was loaded. If an ontology with the
specified URI is already loaded then that ontology will be returned.
OWLOntologyCreationException
- If there was a problem in creating and loading the ontology.public OWLOntology loadOntologyFromPhysicalURI(java.net.URI uri) throws OWLOntologyCreationException
OWLOntologyManager
loadOntologyFromPhysicalURI
in interface OWLOntologyManager
uri
- The physical URI which points to a concrete representation of an ontology.
OWLOntologyCreationException
- If the ontology could not be created and loaded.public OWLOntology loadOntology(OWLOntologyInputSource inputSource) throws OWLOntologyCreationException
OWLOntologyManager
loadOntology
in interface OWLOntologyManager
OWLOntologyCreationException
public OWLOntology reloadOntology(java.net.URI ontologyURI) throws OWLOntologyCreationException
OWLOntologyManager
reloadOntology
in interface OWLOntologyManager
ontologyURI
- The URI of the ontology to be reloaded.
OWLOntologyCreationException
- If the ontology could not be reloaded.public void removeOntology(java.net.URI ontologyURI)
OWLOntologyManager
removeOntology
in interface OWLOntologyManager
ontologyURI
- The URI of the ontology to be removed. If this manager does not contain an ontology
identified by the specified URI then nothing happens.public java.net.URI getPhysicalURIForOntology(OWLOntology ontology) throws UnknownOWLOntologyException
OWLOntologyManager
getPhysicalURIForOntology
in interface OWLOntologyManager
ontology
- The ontology whose physical URI is to be obtained.
UnknownOWLOntologyException
- If the specified ontology is not managed by this manager.public void setPhysicalURIForOntology(OWLOntology ontology, java.net.URI physicalURI) throws UnknownOWLOntologyException
OWLOntologyManager
setPhysicalURIForOntology
in interface OWLOntologyManager
ontology
- The ontology that has already been loaded.physicalURI
- The new physical URI of the ontology.
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
public void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat) throws OWLOntologyStorageException, UnknownOWLOntologyException
saveOntology
in interface OWLOntologyManager
OWLOntologyStorageException
UnknownOWLOntologyException
public void saveOntology(OWLOntology ontology, java.net.URI physicalURI) throws OWLOntologyStorageException, UnknownOWLOntologyException
OWLOntologyManager
saveOntology
in interface OWLOntologyManager
ontology
- The ontology to be saved.physicalURI
- The physical URI which will be used to determine how and where the ontology will be saved.
OWLOntologyStorageException
- If the ontology cannot be saved.
UnknownOWLOntologyException
public void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, java.net.URI physcialURI) throws OWLOntologyStorageException, UnknownOWLOntologyException
saveOntology
in interface OWLOntologyManager
OWLOntologyStorageException
UnknownOWLOntologyException
public void saveOntology(OWLOntology ontology, OWLOntologyOutputTarget outputTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
saveOntology
in interface OWLOntologyManager
OWLOntologyStorageException
UnknownOWLOntologyException
public void saveOntology(OWLOntology ontology, OWLOntologyFormat ontologyFormat, OWLOntologyOutputTarget outputTarget) throws OWLOntologyStorageException, UnknownOWLOntologyException
saveOntology
in interface OWLOntologyManager
OWLOntologyStorageException
UnknownOWLOntologyException
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 addURIMapper(OWLOntologyURIMapper mapper)
OWLOntologyManager
addURIMapper
in interface OWLOntologyManager
mapper
- The mapper to be added.public void clearURIMappers()
OWLOntologyManager
clearURIMappers
in interface OWLOntologyManager
public void removeURIMapper(OWLOntologyURIMapper mapper)
OWLOntologyManager
removeURIMapper
in interface OWLOntologyManager
mapper
- The mapper to be removed.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 void addOntologyChangeListener(OWLOntologyChangeListener listener)
OWLOntologyManager
addOntologyChangeListener
method which takes a
broadcast strategy as an argument should be used.
addOntologyChangeListener
in interface OWLOntologyManager
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 removeOntologyChangeListener(OWLOntologyChangeListener listener)
OWLOntologyManager
removeOntologyChangeListener
in interface OWLOntologyManager
listener
- The listener to be removed.public void makeLoadImportRequest(OWLImportsDeclaration declaration) throws OWLOntologyCreationException
OWLOntologyManager
makeLoadImportRequest
in interface OWLOntologyManager
declaration
- The declaration that describes the import to be loaded.
OWLOntologyCreationException
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.public void addOntologyLoaderListener(OWLOntologyLoaderListener listener)
addOntologyLoaderListener
in interface OWLOntologyManager
public void removeOntologyLoaderListener(OWLOntologyLoaderListener listener)
removeOntologyLoaderListener
in interface OWLOntologyManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |