org.apache.stanbol.ontologymanager.servicesapi.collector

Interface OntologyCollector

All Superinterfaces:

NamedArtifact, OntologyCollectorListenable, OntologyInputSourceHandler

All Known Subinterfaces:

CoreOntologySpace, CustomOntologySpace, OntologyCollector, OntologySpace, OntologySpace, Session, Session

public interface OntologyCollector
extends OntologyCollectorListenable, NamedArtifact, OntologyInputSourceHandler

It is not literally an ontology collection, in that it only collects references to ontologies, not the ontologies themselves. Unless implementations specify a different behaviour, removing ontologies from the collector does not delete them from their persistence system.

Author:

alexdma

Method Summary

Methods

Modifier and Type	Method and Description
org.semanticweb.owlapi.model.OWLOntologyID	addOntology(OntologyInputSource<?> ontology) Adds the given ontology to the ontology collector.
<O> Set<O>	getManagedOntologies(Class<O> returnType, boolean withClosure) Deprecated. Please simulate this method manually by iterating getOntology(OWLOntologyID, Class) calls over listManagedOntologies()
<O> O	getOntology(org.semanticweb.owlapi.model.IRI ontologyIri, Class<O> returnType) Deprecated. Please use getOntology(OWLOntologyID, Class) instead.
<O> O	getOntology(org.semanticweb.owlapi.model.IRI ontologyIri, Class<O> returnType, boolean merge) Deprecated. Please use getOntology(OWLOntologyID, Class, boolean) instead.
<O> O	getOntology(org.semanticweb.owlapi.model.IRI ontologyIri, Class<O> returnType, boolean merge, org.semanticweb.owlapi.model.IRI universalPrefix) Deprecated. Please use getOntology(OWLOntologyID, Class, boolean, IRI) instead.
<O> O	getOntology(org.semanticweb.owlapi.model.IRI ontologyIri, Class<O> returnType, org.semanticweb.owlapi.model.IRI universalPrefix) Deprecated. Please use getOntology(OWLOntologyID, Class, IRI) instead.
<O> O	getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey, Class<O> returnType) Returns the managed ontology with the specified public key as a Java object of the specified type, if supported.
<O> O	getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey, Class<O> returnType, boolean merge) Returns the managed ontology with the specified public key as a Java object of the specified type, if supported.
<O> O	getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey, Class<O> returnType, boolean merge, org.semanticweb.owlapi.model.IRI universalPrefix) Returns the managed ontology with the specified public key as a Java object of the specified type, if supported.
<O> O	getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey, Class<O> returnType, org.semanticweb.owlapi.model.IRI universalPrefix) Returns the managed ontology with the specified public key as a Java object of the specified type, if supported.
boolean	hasOntology(org.semanticweb.owlapi.model.IRI ontologyId) Deprecated. the usage of IRI to identify ontologies is reductive. Please create a new OWLOntologyID.OWLOntologyID(IRI) from this IRI and use hasOntology(OWLOntologyID) with this new public key as a parameter.
boolean	hasOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey) Determines if the ontology identified by the supplied public key is being managed by this collector.
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listManagedOntologies() Gets the public key set of all the ontologies managed by this ontology collector.
void	removeOntology(org.semanticweb.owlapi.model.IRI ontologyId) Deprecated. the usage of IRI to identify ontologies is reductive. Please create a new OWLOntologyID.OWLOntologyID(IRI) from this IRI and use removeOntology(OWLOntologyID) with this new public key as a parameter.
void	removeOntology(org.semanticweb.owlapi.model.OWLOntologyID ontologyId) Removes the given ontology from the ontology collector, if it was being managed.
void	setUp() Bootstraps the ontology space.
void	tearDown() Performs all required operations for disposing of an ontology space and releasing its resources (e.g.

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.collector.OntologyCollectorListenable

addOntologyCollectorListener, clearOntologyCollectorListeners, getOntologyCollectorListeners, removeOntologyCollectorListener

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.NamedArtifact

getDefaultNamespace, getID, getNamespace, setDefaultNamespace, setNamespace

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.io.OntologyInputSourceHandler

getSupportedOntologyTypes

Method Detail

addOntology

org.semanticweb.owlapi.model.OWLOntologyID addOntology(OntologyInputSource<?> ontology)

Adds the given ontology to the ontology collector. If the supplied ontology is not already present in storage and does not have an OWL version IRI of its own, this ontology collector will 'claim ownership' of the ontology by setting its own logical ID as the version IRI of the new ontology.

Parameters:

ontology - the ontology to be added

Returns:

the key that can be used for accessing the stored ontology directly

getManagedOntologies

<O> Set<O> getManagedOntologies(Class<O> returnType,
                              boolean withClosure)

Deprecated. Please simulate this method manually by iterating getOntology(OWLOntologyID, Class) calls over listManagedOntologies()

Returns the ontologies managed by this ontology space. This is a shortcut method for iterating getOntology(OWLOntologyID, Class) calls over listManagedOntologies().

Parameters:

withClosure - if true, also the ontologies imported by those directly managed by this space will be included.

Returns:

the set of ontologies in the ontology space

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.IRI ontologyIri,
                Class<O> returnType)

Deprecated. Please use getOntology(OWLOntologyID, Class) instead.

Parameters:

ontologyIri -

returnType -

Returns:

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.IRI ontologyIri,
                Class<O> returnType,
                boolean merge)

Deprecated. Please use getOntology(OWLOntologyID, Class, boolean) instead.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

ontologyIri -

returnType -

merge -

Returns:

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.IRI ontologyIri,
                Class<O> returnType,
                boolean merge,
                org.semanticweb.owlapi.model.IRI universalPrefix)

Deprecated. Please use getOntology(OWLOntologyID, Class, boolean, IRI) instead.

Parameters:

ontologyIri -

returnType -

merge -

universalPrefix -

Returns:

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.IRI ontologyIri,
                Class<O> returnType,
                org.semanticweb.owlapi.model.IRI universalPrefix)

Deprecated. Please use getOntology(OWLOntologyID, Class, IRI) instead.

Parameters:

ontologyIri -

returnType -

universalPrefix -

Returns:

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey,
                Class<O> returnType)

Returns the managed ontology with the specified public key as a Java object of the specified type, if supported. If such an ontology exists but is not managed by this collector, it will not be returned.

How the method should react if publicKey is invalid or no such ontology exists, or whether the desired return type is not supported, is implementation-dependent. However, developers should at least expect that the methods either returns null or throws a MissingOntologyException if no such ontology is managed by this collector. Likewise, if returnType is not supported, an UnsupportedOperationException could be expected to be thrown.

Parameters:

publicKey - the public identifier of the requested ontology.

returnType - the desired type of the ontology object.

Returns:

the ontology object.

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey,
                Class<O> returnType,
                boolean merge)

Returns the managed ontology with the specified public key as a Java object of the specified type, if supported. If such an ontology exists but is not managed by this collector, it will not be returned.

How the method should react if publicKey is invalid or no such ontology exists, or whether the desired return type is not supported, is implementation-dependent. However, developers should at least expect that the methods either returns null or throws a MissingOntologyException if no such ontology is managed by this collector. Likewise, if returnType is not supported, an UnsupportedOperationException could be expected to be thrown.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

publicKey - the public identifier of the requested ontology.

returnType - the desired type of the ontology object.

merge - if true, the requested ontology will be merged with its imports up to whatever supported level.

Returns:

the ontology object.

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey,
                Class<O> returnType,
                boolean merge,
                org.semanticweb.owlapi.model.IRI universalPrefix)

Returns the managed ontology with the specified public key as a Java object of the specified type, if supported. If such an ontology exists but is not managed by this collector, it will not be returned.

How the method should react if publicKey is invalid or no such ontology exists, or whether the desired return type is not supported, is implementation-dependent. However, developers should at least expect that the methods either returns null or throws a MissingOntologyException if no such ontology is managed by this collector. Likewise, if returnType is not supported, an UnsupportedOperationException could be expected to be thrown.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

publicKey - the public identifier of the requested ontology.

returnType - the desired type of the ontology object.

merge - if true, the requested ontology will be merged with its imports up to whatever supported level.

universalPrefix - the IRI to be used as a prefix and/or namespace for all derived IRIs, e.g. OWL import statements and version IRIs.

Returns:

the ontology object.

getOntology

<O> O getOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey,
                Class<O> returnType,
                org.semanticweb.owlapi.model.IRI universalPrefix)

Returns the managed ontology with the specified public key as a Java object of the specified type, if supported. If such an ontology exists but is not managed by this collector, it will not be returned.

How the method should react if publicKey is invalid or no such ontology exists, or whether the desired return type is not supported, is implementation-dependent. However, developers should at least expect that the methods either returns null or throws a MissingOntologyException if no such ontology is managed by this collector. Likewise, if returnType is not supported, an UnsupportedOperationException could be expected to be thrown.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

publicKey - the public identifier of the requested ontology.

returnType - the desired type of the ontology object.

universalPrefix - the IRI to be used as a prefix and/or namespace for all derived IRIs, e.g. OWL import statements and version IRIs.

Returns:

the ontology object.

hasOntology

boolean hasOntology(org.semanticweb.owlapi.model.IRI ontologyId)

Deprecated. the usage of IRI to identify ontologies is reductive. Please create a new OWLOntologyID.OWLOntologyID(IRI) from this IRI and use hasOntology(OWLOntologyID) with this new public key as a parameter.

Determines if the ontology identified by the supplied public key is being managed by this collector.

Note that the public key will match the ontology's logical ID only if it has one. Otherwise it can be an OWLOntologyID that wraps either the physical URL or the identifier chosen by Stanbol as its ontologyIRI.

Parameters:

publicKey - the logical identifier of the ontology to query for.

Returns:

true iff an ontology with this public key has been loaded in this collector.

hasOntology

boolean hasOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey)

Determines if the ontology identified by the supplied public key is being managed by this collector.

Note that the public key will match the ontology's logical ID only if it has one. Otherwise it can be an OWLOntologyID that wraps either the physical URL or the identifier chosen by Stanbol as its ontologyIRI.

Parameters:

publicKey - the logical identifier of the ontology to query for.

Returns:

true iff an ontology with this public key has been loaded in this collector.

listManagedOntologies

Set<org.semanticweb.owlapi.model.OWLOntologyID> listManagedOntologies()

Gets the public key set of all the ontologies managed by this ontology collector.

Returns:

the key set of managed ontologies.

removeOntology

void removeOntology(org.semanticweb.owlapi.model.IRI ontologyId)

Deprecated. the usage of IRI to identify ontologies is reductive. Please create a new OWLOntologyID.OWLOntologyID(IRI) from this IRI and use removeOntology(OWLOntologyID) with this new public key as a parameter.

Removes the given ontology from the ontology collector, if it was being managed. Otherwise, it should throw a MissingOntologyException.
Note that this will NOT necessarily delete the ontology from the store! This method simply states that the ontology is no longer managed by this collectors and its axioms will no longer appear when the collector is serialized as an ontology. To make sure the ontology itself is deleted, please use the OntologyProvider.

Parameters:

ontologyIri - the identifier of this ontology.

removeOntology

void removeOntology(org.semanticweb.owlapi.model.OWLOntologyID ontologyId)

Removes the given ontology from the ontology collector, if it was being managed. Otherwise, it should throw a MissingOntologyException.
Note that this will NOT necessarily delete the ontology from the store! This method simply states that the ontology is no longer managed by this collectors and its axioms will no longer appear when the collector is serialized as an ontology. To make sure the ontology itself is deleted, please use the OntologyProvider.

Parameters:

ontologyIri - the identifier of this ontology.

setUp

void setUp()

Bootstraps the ontology space. In some cases (such as with core and custom spaces) this also implies write-locking its ontologies. XXX make it a protected, non-interface method ?

tearDown

void tearDown()

Performs all required operations for disposing of an ontology space and releasing its resources (e.g. removing the writelock). XXX make it a protected, non-interface method ?