uk.ac.manchester.cs.owl.owlapi

Class OWLOntologyManagerImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWLOntologyManagerImpl

All Implemented Interfaces:

Serializable, HasAddAxiom, HasAddAxioms, HasApplyChange, HasApplyChanges, HasContainsOntology, HasDataFactory, HasGetOntologies, HasGetOntologyById, HasOntologyChangeListeners, HasOntologyLoaderConfiguration, HasOntologyLoaderConfigurationProvider, HasRemoveAxiom, HasRemoveAxioms, OWLOntologyFactory.OWLOntologyCreationHandler, OWLOntologyManager, OWLOntologySetProvider

public class OWLOntologyManagerImpl
extends Object
implements OWLOntologyManager, OWLOntologyFactory.OWLOntologyCreationHandler, Serializable

Since:

2.0.0

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OWLOntologyManagerImpl(OWLDataFactory dataFactory, ReadWriteLock readWriteLock)
OWLOntologyManagerImpl(OWLDataFactory dataFactory, ReadWriteLock readWriteLock, PriorityCollectionSorting sorting)

Method Summary

Modifier and Type	Method and Description
ChangeApplied	addAxiom(OWLOntology ont, OWLAxiom axiom) A convenience method that adds a single axiom to an ontology.
ChangeApplied	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) Add an IRI mapper to the 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	addOntologyLoaderListener(OWLOntologyLoaderListener listener) Adds an ontology loaded listener to this manager.
void	addOntologyStorer(OWLStorerFactory storer) Add astorer to the manager
ChangeApplied	applyChange(OWLOntologyChange change) A convenience method that applies just one change to an ontology that is managed by this manager.
ChangeApplied	applyChanges(List<? extends OWLOntologyChange> changes) Applies a list ontology changes to a collection of ontologies.
void	clearIRIMappers() Clear the manager mappers
void	clearOntologyStorers() Clear the manager storers
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
boolean	containsVersion(IRI ontologyVersionIRI) Determines if there is an ontology with the specified version IRI, that is managed by this manager.
OWLOntology	copyOntology(OWLOntology toCopy, OntologyCopy settings) Copy an ontology from another manager to this one.
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.
PriorityCollection<OWLOntologyIRIMapper>	getIRIMappers()
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.
PriorityCollection<OWLOntologyFactory>	getOntologyFactories()
OWLDocumentFormat	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.
OWLOntologyLoaderConfiguration	getOntologyLoaderConfiguration()
PriorityCollection<OWLParserFactory>	getOntologyParsers()
PriorityCollection<OWLStorerFactory>	getOntologyStorers()
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 ontologyIRI) Gets the versions (if any) of the ontology that have the specified IRI
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 conf) A convenience method that load an ontology from an input source with specified configuration.
void	makeLoadImportRequest(OWLImportsDeclaration declaration) Requests that the manager loads an imported ontology that is described by an imports statement.
void	makeLoadImportRequest(OWLImportsDeclaration declaration, OWLOntologyLoaderConfiguration configuration) 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.
ChangeApplied	removeAxiom(OWLOntology ont, OWLAxiom axiom) A convenience method that removes a single axiom from an ontology.
ChangeApplied	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) Remove an IRI mapper from the 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	removeOntologyLoaderListener(OWLOntologyLoaderListener listener) Removes a previously added ontology loaded listener.
void	removeOntologyStorer(OWLStorerFactory storer) Remove a storer from the manager
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, OWLDocumentFormat ontologyFormat) Saves the specified ontology in the specified ontology format to its document URI.
void	saveOntology(OWLOntology ontology, OWLDocumentFormat ontologyFormat, IRI documentIRI) Saves the specified ontology to the specified document IRI in the specified ontology format.
void	saveOntology(OWLOntology ontology, OWLDocumentFormat ontologyFormat, OutputStream outputStream) Saves the specified ontology to the specified output stream in the specified ontology format.
void	saveOntology(OWLOntology ontology, OWLDocumentFormat ontologyFormat, OWLOntologyDocumentTarget documentTarget) Saves the specified ontology to the specified output target in the specified ontology format.
void	saveOntology(OWLOntology ontology, OWLOntologyDocumentTarget documentTarget) Saves the specified ontology to the specified OWLOntologyDocumentTarget.
void	setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy) Sets the default strategy that is used to broadcast ontology changes.
void	setIRIMappers(Set<OWLOntologyIRIMapper> mappers) Set the collection of IRI mappers.
void	setOntologyDocumentIRI(OWLOntology ontology, IRI documentIRI) Overrides the current document IRI for a given ontology.
void	setOntologyFactories(Set<OWLOntologyFactory> factories) Set the collection of ontology factories.
void	setOntologyFormat(OWLOntology ontology, OWLDocumentFormat ontologyFormat) Sets the format for the specified ontology.
void	setOntologyLoaderConfiguration(OWLOntologyLoaderConfiguration newConfig) Sets the configuration.
void	setOntologyLoaderConfigurationProvider(javax.inject.Provider<OWLOntologyLoaderConfiguration> provider) Sets the configuration provider.
void	setOntologyParsers(Set<OWLParserFactory> parsers) Set the collection of parsers.
void	setOntologyStorers(Set<OWLStorerFactory> storers) Set the list of ontology storers.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OWLOntologyManagerImpl

@Inject
public OWLOntologyManagerImpl(@Nonnull
                                      OWLDataFactory dataFactory,
                                      ReadWriteLock readWriteLock)

Parameters:

dataFactory - data factory

OWLOntologyManagerImpl

public OWLOntologyManagerImpl(@Nonnull
                              OWLDataFactory dataFactory,
                              ReadWriteLock readWriteLock,
                              PriorityCollectionSorting sorting)

Method Detail

setOntologyLoaderConfigurationProvider

public void setOntologyLoaderConfigurationProvider(javax.inject.Provider<OWLOntologyLoaderConfiguration> provider)

Description copied from interface: HasOntologyLoaderConfigurationProvider

Sets the configuration provider.

Specified by:

setOntologyLoaderConfigurationProvider in interface HasOntologyLoaderConfigurationProvider

Parameters:

provider - the provider to be used

getOntologyLoaderConfiguration

@Nonnull
public OWLOntologyLoaderConfiguration getOntologyLoaderConfiguration()

Specified by:

getOntologyLoaderConfiguration in interface HasOntologyLoaderConfiguration

Returns:

the configuration for this object. This is a read only accessor, since the configuration is an immutable object. To change the configuration, use the setter in this interface to set a modified configuration.

setOntologyLoaderConfiguration

public void setOntologyLoaderConfiguration(OWLOntologyLoaderConfiguration newConfig)

Description copied from interface: HasOntologyLoaderConfiguration

Sets the configuration.

Specified by:

setOntologyLoaderConfiguration in interface HasOntologyLoaderConfiguration

Parameters:

newConfig - configuration to be used

getOWLDataFactory

public OWLDataFactory getOWLDataFactory()

Description copied from interface: HasDataFactory

Gets a data factory which can be used to create OWL API objects such as classes, properties, individuals, axioms etc.

Specified by:

getOWLDataFactory in interface HasDataFactory

Returns:

A reference to a data factory for creating OWL API objects.

getOntologies

public Set<OWLOntology> getOntologies()

Description copied from interface: HasGetOntologies

Gets the (possibly empty) set of OWLOntology objects contained within this object.

Specified by:

getOntologies in interface HasGetOntologies

Returns:

The set of ontologies. Possibly empty. Not null.

getOntologies

public Set<OWLOntology> getOntologies(OWLAxiom axiom)

Description copied from interface: OWLOntologyManager

Gets the ontologies that are managed by this manager that contain the specified axiom.

Specified by:

getOntologies in interface OWLOntologyManager

Parameters:

axiom - The axioms

Returns:

The set of ontologies such that for each ontology, O the specified axiom is contained in O.

contains

public boolean contains(OWLOntology ontology)

Specified by:

contains in interface OWLOntologyManager

Parameters:

ontology - ontology to check

Returns:

true if the ontology is contained

contains

public boolean contains(IRI ontologyIRI)

Description copied from interface: OWLOntologyManager

Determines if there is an ontology with the specified IRI, and no version IRI, that is managed by this manager

Specified by:

contains in interface OWLOntologyManager

Parameters:

ontologyIRI - The IRI of the ontology to test for (the version IRI is assumed to be null)

Returns:

true if there is an ontology with the specified IRI, and no version IRI, that is managed by this manager, otherwise false.

contains

public boolean contains(OWLOntologyID id)

Description copied from interface: OWLOntologyManager

Determines if there is an ontology with the specified id that is managed by this manager

Specified by:

contains in interface HasContainsOntology

Specified by:

contains in interface OWLOntologyManager

Parameters:

id - The id of the ontology to test for

Returns:

true if there is an ontology with the specified id that is managed by this manager, otherwise false.

containsVersion

public boolean containsVersion(IRI ontologyVersionIRI)

Description copied from interface: OWLOntologyManager

Determines if there is an ontology with the specified version IRI, that is managed by this manager.

Specified by:

containsVersion in interface OWLOntologyManager

Parameters:

ontologyVersionIRI - The version IRI of the ontology to test for (the ontology IRI may be anything)

Returns:

true if there is an ontology with the specified version IRI, that is managed by this manager, otherwise false.

getOntologyIDsByVersion

public Set<OWLOntologyID> getOntologyIDsByVersion(IRI ontologyVersionIRI)

Description copied from interface: OWLOntologyManager

Gets a set of OWLOntologyIDs representing ontologies that are managed by this manager.

Specified by:

getOntologyIDsByVersion in interface OWLOntologyManager

Parameters:

ontologyVersionIRI - The version IRI to match against all of the known ontologies.

Returns:

A set of OWLOntologyIDs where the version matches the given version or the empty set if none match.

getOntology

public OWLOntology getOntology(IRI ontologyIRI)

Description copied from interface: OWLOntologyManager

Gets a previously loaded/created ontology that has the specified ontology IRI and no version IRI.

Specified by:

getOntology in interface OWLOntologyManager

Parameters:

ontologyIRI - The IRI of the ontology to be retrieved.

Returns:

The ontology that has the specified IRI and no version IRI, or null if this manager does not manage an ontology with the specified IRI and no version IRI.

getOntology

public OWLOntology getOntology(OWLOntologyID ontologyID)

Description copied from interface: OWLOntologyManager

Gets a previously loaded/created ontology that has the specified ontology ID

Specified by:

getOntology in interface HasGetOntologyById

Specified by:

getOntology in interface OWLOntologyManager

Parameters:

ontologyID - The ID of the ontology to retrieve

Returns:

The ontology that has the specified ID, or null if this manager does not manage an ontology with the specified ontology ID.

getVersions

public Set<OWLOntology> getVersions(IRI ontologyIRI)

Description copied from interface: OWLOntologyManager

Gets the versions (if any) of the ontology that have the specified IRI

Specified by:

getVersions in interface OWLOntologyManager

Parameters:

ontologyIRI - The ontology IRI

Returns:

The set of ontologies that have the specified ontology IRI.

getImportedOntology

@Nullable
public OWLOntology getImportedOntology(OWLImportsDeclaration declaration)

Description copied from interface: OWLOntologyManager

Given an imports declaration, obtains the ontology that this import has been resolved to.

Specified by:

getImportedOntology in interface OWLOntologyManager

Parameters:

declaration - The declaration that points to the imported ontology.

Returns:

The ontology that the imports declaration resolves to, or null if the imports declaration could not be resolved to an ontology, because the ontology was not loaded or has been removed from this manager

getDirectImports

public Set<OWLOntology> getDirectImports(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

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

Specified by:

getDirectImports in interface OWLOntologyManager

Parameters:

ontology - The ontology whose direct imports are to be retrieved.

Returns:

The set of loaded ontologies that the specified ontology is related to via the directlyImports relation. If the ontology is not managed by this manager then the empty set will be returned.

getImports

public Set<OWLOntology> getImports(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Gets the set of ontologies that are in the transitive closure of the directly imports relation.

Specified by:

getImports in interface OWLOntologyManager

Parameters:

ontology - The ontology whose imports are to be retrieved.

Returns:

A set of OWLOntologyies 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.

getImportsClosure

public Set<OWLOntology> getImportsClosure(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Gets the imports closure for the specified ontology.

Specified by:

getImportsClosure in interface OWLOntologyManager

Parameters:

ontology - The ontology whose imports closure is to be retrieved.

Returns:

A 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.

getSortedImportsClosure

public List<OWLOntology> getSortedImportsClosure(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Gets the topologically ordered imports closure.

Specified by:

getSortedImportsClosure in interface OWLOntologyManager

Parameters:

ontology - The ontology whose imports closure is to be determined.

Returns:

A list that represents a topological ordering of the imports closure. The first element in the list will be the specified ontology. If the ontology is not managed by this manager then an empty list will be returned.

applyChanges

public ChangeApplied applyChanges(List<? extends OWLOntologyChange> changes)

Description copied from interface: HasApplyChanges

Applies a list ontology changes to a collection of ontologies. Note that the ontologies need to be managed by this manager, since import closures, ontology ids and configurations might be affected by the changes, and they are held by the manager.

Specified by:

applyChanges in interface HasApplyChanges

Parameters:

changes - The changes to be applied.

Returns:

ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY otherwise.

addAxiom

public ChangeApplied addAxiom(@Nonnull
                              OWLOntology ont,
                              @Nonnull
                              OWLAxiom axiom)

Description copied from interface: HasAddAxiom

A convenience method that adds a single axiom to an ontology. The appropriate AddAxiom change object is automatically generated.

Specified by:

addAxiom in interface HasAddAxiom

Parameters:

ont - The ontology to add the axiom to.

axiom - The axiom to be added

Returns:

ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY otherwise.

addAxioms

public ChangeApplied addAxioms(@Nonnull
                               OWLOntology ont,
                               @Nonnull
                               Set<? extends OWLAxiom> axioms)

Description copied from interface: HasAddAxioms

A convenience method that adds a set of axioms to an ontology. The appropriate AddAxiom change objects are automatically generated.

Specified by:

addAxioms in interface HasAddAxioms

Parameters:

ont - The ontology to which the axioms should be added. Not null .

axioms - The axioms to be added. Not null.

Returns:

ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY otherwise.

removeAxiom

public ChangeApplied removeAxiom(@Nonnull
                                 OWLOntology ont,
                                 @Nonnull
                                 OWLAxiom axiom)

Description copied from interface: HasRemoveAxiom

A convenience method that removes a single axiom from an ontology. The appropriate RemoveAxiom change object is automatically generated.

Specified by:

removeAxiom in interface HasRemoveAxiom

Parameters:

ont - The ontology to remove the axiom from.

axiom - The axiom to be removed

Returns:

ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY otherwise.

removeAxioms

public ChangeApplied removeAxioms(@Nonnull
                                  OWLOntology ont,
                                  @Nonnull
                                  Set<? extends OWLAxiom> axioms)

Description copied from interface: HasRemoveAxioms

A convenience method that removes a set of axioms from an ontology. The appropriate RemoveAxiom change objects are automatically generated.

Specified by:

removeAxioms in interface HasRemoveAxioms

Parameters:

ont - The ontology from which the axioms should be removed.

axioms - The axioms to be removed. Not null

Returns:

ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY otherwise.

applyChange

public ChangeApplied applyChange(@Nonnull
                                 OWLOntologyChange change)

Description copied from interface: HasApplyChange

A convenience method that applies just one change to an ontology that is managed by this manager.

Specified by:

applyChange in interface HasApplyChange

Parameters:

change - The change to be applied

Returns:

ChangeApplied.SUCCESSFULLY if the change is applied with success, ChangeApplied.UNSUCCESSFULLY otherwise.

ontologyCreated

public void ontologyCreated(OWLOntology ontology)

Description copied from interface: OWLOntologyFactory.OWLOntologyCreationHandler

The factory calls this method as soon as it has created an ontology. If the factory is loading an ontology then the ontology will not have been populated with axioms at this stage.

Specified by:

ontologyCreated in interface OWLOntologyFactory.OWLOntologyCreationHandler

Parameters:

ontology - The newly created ontology.

setOntologyFormat

public void setOntologyFormat(OWLOntology ontology,
                              OWLDocumentFormat ontologyFormat)

Description copied from interface: OWLOntologyManager

Sets the format for the specified ontology.

Specified by:

setOntologyFormat in interface OWLOntologyFactory.OWLOntologyCreationHandler

Specified by:

setOntologyFormat in interface OWLOntologyManager

Parameters:

ontology - The ontology whose format is to be set.

ontologyFormat - The format for the specified ontology.

getOntologyFormat

public OWLDocumentFormat getOntologyFormat(@Nonnull
                                           OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Gets the ontology format for the specified ontology.

Specified by:

getOntologyFormat in interface OWLOntologyManager

Parameters:

ontology - The ontology whose format it to be obtained.

Returns:

The format of the ontology.

createOntology

public OWLOntology createOntology()
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new (empty) ontology that does not have an ontology IRI (and therefore does not have a version IRI). A document IRI will automatically be generated.

Specified by:

createOntology in interface OWLOntologyManager

Returns:

The newly created ontology

Throws:

OWLOntologyCreationException - if there was a problem creating the ontology

createOntology

public OWLOntology createOntology(@Nonnull
                                  IRI ontologyIRI)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new (empty) ontology that has the specified ontology IRI (and no version IRI).
The ontology document IRI of the created ontology will be set to the value returned by any installed OWLOntologyIRIMappers. 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.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

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.

Returns:

The newly created ontology, or if an ontology with the specified IRI already exists then this existing ontology will be returned.

Throws:

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.

createOntology

public OWLOntology createOntology(@Nonnull
                                  OWLOntologyID ontologyID)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new (empty) ontology that has the specified ontology ID.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

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 OWLOntologyIRIMappers. 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.

Returns:

The newly created ontology, or if an ontology with the specified IRI already exists then this existing ontology will be returned.

Throws:

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.

createOntology

public OWLOntology createOntology(IRI ontologyIRI,
                                  Set<OWLOntology> ontologies)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new ontology that has the specified ontology IRI and is initialised to contain the axioms that are contained in the specified ontologies. Note that the specified ontologies need not be managed by this manager.
The ontology document IRI of the created ontology will be set to the value returned by any installed OWLOntologyIRIMappers. 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.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

ontologyIRI - The IRI of the new ontology.

ontologies - The ontologies whose axioms should be copied into the new ontology

Returns:

An ontology that has the specified IRI and contains all of the axioms that are contained in the specified ontologies

Throws:

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.

createOntology

public OWLOntology createOntology(IRI ontologyIRI,
                                  Set<OWLOntology> ontologies,
                                  boolean copyLogicalAxiomsOnly)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new ontology that has the specified ontology IRI and is initialised to contain the axioms that are contained in the specified ontologies. Note that the specified ontologies need not be managed by this manager.
The ontology document IRI of the created ontology will be set to the value returned by any installed OWLOntologyIRIMappers. 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.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

ontologyIRI - The IRI of the new ontology.

ontologies - The ontologies whose axioms should be copied into the new ontology

copyLogicalAxiomsOnly - 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.

Returns:

An ontology that has the specified IRI and contains all of the axioms that are contained in the specified ontologies possibly minus all non-logical axioms

Throws:

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.

createOntology

public OWLOntology createOntology(Set<OWLAxiom> axioms,
                                  IRI ontologyIRI)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new ontology that has the specified ontology IRI and is initialised to contain specific axioms.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

axioms - The axioms that should be copied into the new ontology

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 OWLOntologyIRIMappers. 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.

Returns:

An ontology that has the specified IRI and contains all of the specified axioms

Throws:

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.

createOntology

public OWLOntology createOntology(Set<OWLAxiom> axioms)
                           throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Creates a new ontology that is initialised to contain specific axioms. The ontology will not have an IRI. The document IRI of the created ontology will be auto-generated.

Specified by:

createOntology in interface OWLOntologyManager

Parameters:

axioms - The axioms that should be copied into the new ontology

Returns:

An ontology without an IRI that contains all of the specified axioms

Throws:

OWLOntologyCreationException - if there was a problem creating the new ontology.

copyOntology

public OWLOntology copyOntology(OWLOntology toCopy,
                                OntologyCopy settings)
                         throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Copy an ontology from another manager to this one. The returned OWLOntology will return this manager when getOWLOntologyManager() is invoked. The copy mode is defined by the OntologyCopy parameter: SHALLOW for simply creating a new ontology containing the same axioms and same id, DEEP for copying actoss format and document IRI, MOVE to remove the ontology from its previous manager.

Specified by:

copyOntology in interface OWLOntologyManager

Parameters:

toCopy - ontology to copy

settings - settings for the copy

Returns:

copied ontology. This is the same object as toCopy only for MOVE copies

Throws:

OWLOntologyCreationException - if this manager cannot add the new ontology

loadOntology

public OWLOntology loadOntology(IRI ontologyIRI)
                         throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Loads an ontology that is assumed to have the specified 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 OWLOntologyIRIMappers have been registered using the OWLOntologyManager.getIRIMappers() PriorityCollection PriorityCollection.add(Serializable...) method, or no mapping can be found, the ontology document IRI is taken to be the specified ontology IRI.

Specified by:

loadOntology in interface OWLOntologyManager

Parameters:

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).

Returns:

The OWLOntology representation of the ontology that was loaded.

Throws:

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.

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.

loadOntologyFromOntologyDocument

public OWLOntology loadOntologyFromOntologyDocument(IRI documentIRI)
                                             throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Loads an ontology from an ontology document specified by an IRI. In contrast the the OWLOntologyManager.loadOntology(IRI) method, no mapping is performed on the specified IRI.

Specified by:

loadOntologyFromOntologyDocument in interface OWLOntologyManager

Parameters:

documentIRI - The ontology document IRI where the ontology will be loaded from.

Returns:

The ontology that was loaded.

Throws:

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.

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.

loadOntologyFromOntologyDocument

public OWLOntology loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource)
                                             throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

A convenience method that load an ontology from an input source.

Specified by:

loadOntologyFromOntologyDocument in interface OWLOntologyManager

Parameters:

documentSource - The input source that describes where the ontology should be loaded from.

Returns:

The ontology that was loaded.

Throws:

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.

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.

loadOntologyFromOntologyDocument

public OWLOntology loadOntologyFromOntologyDocument(OWLOntologyDocumentSource documentSource,
                                                    OWLOntologyLoaderConfiguration conf)
                                             throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

A convenience method that load an ontology from an input source with specified configuration.

Specified by:

loadOntologyFromOntologyDocument in interface OWLOntologyManager

Parameters:

documentSource - The input source that describes where the ontology should be loaded from.

conf - the configuration to use

Returns:

The ontology that was loaded.

Throws:

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.

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.

loadOntologyFromOntologyDocument

public OWLOntology loadOntologyFromOntologyDocument(File file)
                                             throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Loads an ontology from an ontology document contained in a local file. The loaded ontology will be assigned a document IRI that corresponds to the file IRI.

Specified by:

loadOntologyFromOntologyDocument in interface OWLOntologyManager

Parameters:

file - The file that contains a representation of an ontology

Returns:

The ontology that was parsed from the file.

Throws:

OWLOntologyCreationException - If there was a problem in creating and loading the ontology.

UnparsableOntologyException - if the ontology could not be parsed.

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.

loadOntologyFromOntologyDocument

public OWLOntology loadOntologyFromOntologyDocument(InputStream inputStream)
                                             throws OWLOntologyCreationException

Description copied from interface: OWLOntologyManager

Loads an ontology from an ontology document obtained from an input stream. The loaded ontology will be assigned an auto-generated document IRI with "inputstream" as its scheme.

Specified by:

loadOntologyFromOntologyDocument in interface OWLOntologyManager

Parameters:

inputStream - The input stream that can be used to obtain a representation of an ontology

Returns:

The ontology that was parsed from the input stream.

Throws:

OWLOntologyCreationException - If there was a problem in creating and loading the ontology.

UnparsableOntologyException - if the ontology could not be parsed.

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.

removeOntology

public void removeOntology(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Attempts to remove an ontology. The ontology which is identified by the specified IRI is removed regardless of whether it is referenced by other ontologies via imports statements.

Specified by:

removeOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be removed. If this manager does not manage the ontology then nothing happens.

removeOntology

public void removeOntology(OWLOntologyID ontologyID)

Description copied from interface: OWLOntologyManager

Attempts to remove an ontology. The ontology which is identified by the specified IRI is removed regardless of whether it is referenced by other ontologies via imports statements.

Specified by:

removeOntology in interface OWLOntologyManager

Parameters:

ontologyID - The ontology to be removed. If this manager does not manage the ontology then nothing happens.

getOntologyDocumentIRI

public IRI getOntologyDocumentIRI(OWLOntology ontology)

Description copied from interface: OWLOntologyManager

Gets the document IRI for a given ontology. This will either be the document IRI from where the ontology was obtained from during loading, or the document IRI which was specified (via a mapper) when the (empty) ontology was created. Note that this may not correspond to the first document IRI found in the list of mappings from ontology IRI to document IRI. The reason for this is that it might not have been possible to load the ontology from the first document IRI found in the mapping table.

Specified by:

getOntologyDocumentIRI in interface OWLOntologyManager

Parameters:

ontology - The ontology whose document IRI is to be obtained.

Returns:

The document IRI of the ontology.

setOntologyDocumentIRI

public void setOntologyDocumentIRI(OWLOntology ontology,
                                   IRI documentIRI)

Description copied from interface: OWLOntologyManager

Overrides the current document IRI for a given ontology. This method does not alter the IRI mappers which are installed, but alters the actual document IRI of an ontology that has already been loaded.

Specified by:

setOntologyDocumentIRI in interface OWLOntologyManager

Parameters:

ontology - The ontology that has already been loaded.

documentIRI - The new ontology document IRI

saveOntology

public void saveOntology(OWLOntology ontology)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology. The ontology will be saved to the location that it was loaded from, or if it was created programmatically, it will be saved to the location specified by an ontology IRI mapper at creation time. The ontology will be saved in the same format which it was loaded from, or the default ontology format if the ontology was created programmatically.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

Throws:

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.

saveOntology

public void saveOntology(@Nonnull
                         OWLOntology ontology,
                         OWLDocumentFormat ontologyFormat)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology in the specified ontology format to its document URI.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

ontologyFormat - The format in which the ontology should be saved.

Throws:

OWLOntologyStorageException - If the ontology cannot be saved.

saveOntology

public void saveOntology(OWLOntology ontology,
                         IRI documentIRI)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology, using the specified document IRI to determine where/how the ontology should be saved.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

documentIRI - The document IRI where the ontology should be saved to

Throws:

OWLOntologyStorageException - If the ontology cannot be saved

saveOntology

public void saveOntology(OWLOntology ontology,
                         OWLDocumentFormat ontologyFormat,
                         IRI documentIRI)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology to the specified document IRI in the specified ontology format.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved

ontologyFormat - The format in which to save the ontology

documentIRI - The document IRI where the ontology should be saved to

Throws:

OWLOntologyStorageException - If the ontology could not be saved.

saveOntology

public void saveOntology(OWLOntology ontology,
                         OutputStream outputStream)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology, to the specified output stream

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

outputStream - The output stream where the ontology will be saved to

Throws:

OWLOntologyStorageException - If there was a problem saving this ontology to the specified output stream

saveOntology

public void saveOntology(OWLOntology ontology,
                         OWLDocumentFormat ontologyFormat,
                         OutputStream outputStream)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology to the specified output stream in the specified ontology format.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved

ontologyFormat - The format in which to save the ontology

outputStream - The output stream where the ontology will be saved to.

Throws:

OWLOntologyStorageException - If the ontology could not be saved.

saveOntology

public void saveOntology(OWLOntology ontology,
                         OWLOntologyDocumentTarget documentTarget)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology to the specified OWLOntologyDocumentTarget.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

documentTarget - The output target where the ontology will be saved to.

Throws:

OWLOntologyStorageException - If the ontology could not be saved.

saveOntology

public void saveOntology(OWLOntology ontology,
                         OWLDocumentFormat ontologyFormat,
                         OWLOntologyDocumentTarget documentTarget)
                  throws OWLOntologyStorageException

Description copied from interface: OWLOntologyManager

Saves the specified ontology to the specified output target in the specified ontology format.

Specified by:

saveOntology in interface OWLOntologyManager

Parameters:

ontology - The ontology to be saved.

ontologyFormat - The output format in which to save the ontology

documentTarget - The output target where the ontology will be saved to

Throws:

OWLOntologyStorageException - If the ontology could not be saved.

getOntologyStorers

public PriorityCollection<OWLStorerFactory> getOntologyStorers()

Specified by:

getOntologyStorers in interface OWLOntologyManager

Returns:

the collection of storers. This allows for iteration and modification of the list.

setOntologyStorers

@Inject
public void setOntologyStorers(Set<OWLStorerFactory> storers)

Description copied from interface: OWLOntologyManager

Set the list of ontology storers. If their type is annotated with a HasPriority type, this will be used to decide the order they are used. Otherwise, the order in which the collection is iterated will determine the order in which the storers are used.

Specified by:

setOntologyStorers in interface OWLOntologyManager

Parameters:

storers - The storers to be used

getIRIMappers

public PriorityCollection<OWLOntologyIRIMapper> getIRIMappers()

Specified by:

getIRIMappers in interface OWLOntologyManager

Returns:

the collection of IRI mappers. This allows for iteration and modification of the list.

setIRIMappers

@Inject
public void setIRIMappers(Set<OWLOntologyIRIMapper> mappers)

Description copied from interface: OWLOntologyManager

Set the collection of IRI mappers. It is used by Guice injection, but can be used manually as well to replace the existing mappers with new ones. The mappers are used to obtain ontology document IRIs for ontology IRIs. If their type is annotated with a HasPriority type, this will be used to decide the order they are used. Otherwise, the order in which the collection is iterated will determine the order in which the mappers are used.

Specified by:

setIRIMappers in interface OWLOntologyManager

Parameters:

mappers - the mappers to be injected

addIRIMapper

public void addIRIMapper(OWLOntologyIRIMapper mapper)

Description copied from interface: OWLOntologyManager

Add an IRI mapper to the manager

Specified by:

addIRIMapper in interface OWLOntologyManager

Parameters:

mapper - the mapper to add

removeIRIMapper

public void removeIRIMapper(OWLOntologyIRIMapper mapper)

Description copied from interface: OWLOntologyManager

Remove an IRI mapper from the manager

Specified by:

removeIRIMapper in interface OWLOntologyManager

Parameters:

mapper - the mapper to remove

clearIRIMappers

public void clearIRIMappers()

Description copied from interface: OWLOntologyManager

Clear the manager mappers

Specified by:

clearIRIMappers in interface OWLOntologyManager

addOntologyStorer

public void addOntologyStorer(OWLStorerFactory storer)

Description copied from interface: OWLOntologyManager

Add astorer to the manager

Specified by:

addOntologyStorer in interface OWLOntologyManager

Parameters:

storer - the storer to add

removeOntologyStorer

public void removeOntologyStorer(OWLStorerFactory storer)

Description copied from interface: OWLOntologyManager

Remove a storer from the manager

Specified by:

removeOntologyStorer in interface OWLOntologyManager

Parameters:

storer - the storer to remove

clearOntologyStorers

public void clearOntologyStorers()

Description copied from interface: OWLOntologyManager

Clear the manager storers

Specified by:

clearOntologyStorers in interface OWLOntologyManager

getOntologyParsers

public PriorityCollection<OWLParserFactory> getOntologyParsers()

Specified by:

getOntologyParsers in interface OWLOntologyManager

Returns:

the collection of parsers. This allows for iteration and modification of the list.

setOntologyParsers

@Inject
public void setOntologyParsers(Set<OWLParserFactory> parsers)

Description copied from interface: OWLOntologyManager

Set the collection of parsers. It is used by Guice injection, but can be used manually as well to replace the existing parsers with new ones. If their type is annotated with a HasPriority type, this will be used to decide the order they are used. Otherwise, the order in which the collection is iterated will determine the order in which the parsers are used.

Specified by:

setOntologyParsers in interface OWLOntologyManager

Parameters:

parsers - the factories to be injected

getOntologyFactories

public PriorityCollection<OWLOntologyFactory> getOntologyFactories()

Specified by:

getOntologyFactories in interface OWLOntologyManager

Returns:

the collection of ontology factories. This allows for iteration and modification of the list.

setOntologyFactories

@Inject
public void setOntologyFactories(Set<OWLOntologyFactory> factories)

Description copied from interface: OWLOntologyManager

Set the collection of ontology factories. It is used by Guice injection, but can be used manually as well to replace the existing factories with new ones. If their type is annotated with a HasPriority type, this will be used to decide the order they are used. Otherwise, the order in which the collection is iterated will determine the order in which the parsers are used.

Specified by:

setOntologyFactories in interface OWLOntologyManager

Parameters:

factories - the factories to be injected

addOntologyChangeListener

public void addOntologyChangeListener(OWLOntologyChangeListener listener)

Description copied from interface: HasOntologyChangeListeners

Adds an ontology change listener, which listens to all changes for all ontologies. To customise the changes/ontologies that are listened to, the addOntologyChangeListener method which takes a broadcast strategy as an argument should be used.

Specified by:

addOntologyChangeListener in interface HasOntologyChangeListeners

Parameters:

listener - The listener to be added.

setDefaultChangeBroadcastStrategy

public void setDefaultChangeBroadcastStrategy(OWLOntologyChangeBroadcastStrategy strategy)

Description copied from interface: OWLOntologyManager

Sets the default strategy that is used to broadcast ontology changes.

Specified by:

setDefaultChangeBroadcastStrategy in interface OWLOntologyManager

Parameters:

strategy - The strategy to be used for broadcasting changes. This strategy will override any previously set broadcast strategy.

See Also:

DefaultChangeBroadcastStrategy, EDTChangeBroadcastStrategy

addOntologyChangeListener

public void addOntologyChangeListener(OWLOntologyChangeListener listener,
                                      OWLOntologyChangeBroadcastStrategy strategy)

Description copied from interface: OWLOntologyManager

Adds an ontology change listener, which listens to ontology changes. An ontology change broadcast strategy must be specified, which determines the changes that are broadcast to the listener.

Specified by:

addOntologyChangeListener in interface OWLOntologyManager

Parameters:

listener - The listener to be added.

strategy - The strategy that should be used for broadcasting changes to the listener.

addImpendingOntologyChangeListener

public void addImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)

Specified by:

addImpendingOntologyChangeListener in interface OWLOntologyManager

Parameters:

listener - the listener to add

removeImpendingOntologyChangeListener

public void removeImpendingOntologyChangeListener(ImpendingOWLOntologyChangeListener listener)

Specified by:

removeImpendingOntologyChangeListener in interface OWLOntologyManager

Parameters:

listener - the listener to remove

removeOntologyChangeListener

public void removeOntologyChangeListener(OWLOntologyChangeListener listener)

Description copied from interface: HasOntologyChangeListeners

Removes a previously added listener.

Specified by:

removeOntologyChangeListener in interface HasOntologyChangeListeners

Parameters:

listener - The listener to be removed.

addOntologyChangesVetoedListener

public void addOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)

Specified by:

addOntologyChangesVetoedListener in interface OWLOntologyManager

Parameters:

listener - the listener to add

removeOntologyChangesVetoedListener

public void removeOntologyChangesVetoedListener(OWLOntologyChangesVetoedListener listener)

Specified by:

removeOntologyChangesVetoedListener in interface OWLOntologyManager

Parameters:

listener - the listener to remove

makeLoadImportRequest

public void makeLoadImportRequest(OWLImportsDeclaration declaration)

Description copied from interface: OWLOntologyManager

Requests that the manager loads an imported ontology that is described by an imports statement. This method is generally used by parsers and other kinds of loaders. For simply loading an ontology, use the loadOntologyXXX methods. The method respects the list of ignored imports in the specified configuration. In other words, if this methods is called for an ignored import as specified by the configuration object then the import won't be loaded. The ontology loader configuration used is the default one for this manager.

Specified by:

makeLoadImportRequest in interface OWLOntologyManager

Parameters:

declaration - The declaration that describes the import to be loaded.

makeLoadImportRequest

public void makeLoadImportRequest(OWLImportsDeclaration declaration,
                                  OWLOntologyLoaderConfiguration configuration)

Description copied from interface: OWLOntologyManager

Requests that the manager loads an imported ontology that is described by an imports statement. This method is generally used by parsers and other kinds of loaders. For simply loading an ontology, use the loadOntologyXXX methods. The method respects the list of ignored imports in the specified configuration. In other words, if this methods is called for an ignored import as specified by the configuration object then the import won't be loaded.

Specified by:

makeLoadImportRequest in interface OWLOntologyManager

Parameters:

declaration - The declaration that describes the import to be loaded.

configuration - The configuration object that passes arguments to the mechanism used for loading.

addMissingImportListener

public void addMissingImportListener(MissingImportListener listener)

Description copied from interface: OWLOntologyManager

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.

Specified by:

addMissingImportListener in interface OWLOntologyManager

Parameters:

listener - The listener to be added.

removeMissingImportListener

public void removeMissingImportListener(@Nonnull
                                        MissingImportListener listener)

Description copied from interface: OWLOntologyManager

Removes a previously added missing import listener.

Specified by:

removeMissingImportListener in interface OWLOntologyManager

Parameters:

listener - The listener to be removed.

addOntologyLoaderListener

public void addOntologyLoaderListener(OWLOntologyLoaderListener listener)

Description copied from interface: OWLOntologyManager

Adds an ontology loaded listener to this manager.

Specified by:

addOntologyLoaderListener in interface OWLOntologyManager

Parameters:

listener - The listener to be added.

removeOntologyLoaderListener

public void removeOntologyLoaderListener(OWLOntologyLoaderListener listener)

Description copied from interface: OWLOntologyManager

Removes a previously added ontology loaded listener.

Specified by:

removeOntologyLoaderListener in interface OWLOntologyManager

Parameters:

listener - The listener to be removed.

addOntologyChangeProgessListener

public void addOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)

Description copied from interface: OWLOntologyManager

Adds an ontology change progress listener.

Specified by:

addOntologyChangeProgessListener in interface OWLOntologyManager

Parameters:

listener - The listener to be added.

removeOntologyChangeProgessListener

public void removeOntologyChangeProgessListener(OWLOntologyChangeProgressListener listener)

Description copied from interface: OWLOntologyManager

Removes a previously added ontology change listener.

Specified by:

removeOntologyChangeProgessListener in interface OWLOntologyManager

Parameters:

listener - The listener to be removed.