org.apache.stanbol.ontologymanager.servicesapi.ontology

Interface OntologyProvider<S>

Type Parameters:

S - the storage system actually used by this provider.

All Known Subinterfaces:

OntologyProvider<S>

public interface OntologyProvider<S>

A system responsible for maintaining stored ontologies.

TODO see if full CRUD operation support is necessary.

Author:

alexdma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OntologyProvider.Status The status of a stored ontology entry in the OntologyProvider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRAPH_PREFIX The key used to configure the prefix to be used for addressing ontologies stored by this provider.
static String	IMPORT_POLICY The key used to configure the import management policy.
static String	META_GRAPH_ID The key used to configure the identifier of the meta-level graph
static String	RESOLVE_IMPORTS The key used to configure the default import resolution policy for this provider.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAlias(org.semanticweb.owlapi.model.OWLOntologyID primaryKey, org.semanticweb.owlapi.model.OWLOntologyID alias)
org.semanticweb.owlapi.model.OWLOntologyID	createBlankOntologyEntry(org.semanticweb.owlapi.model.OWLOntologyID publicKey)
ImportManagementPolicy	getImportManagementPolicy() Gets the policy adopted by this provider whenever an import statement is found in an ontology that has already been loaded (e.g. when exporting it).
String	getKey(org.semanticweb.owlapi.model.IRI ontologyIri) Deprecated. public keys are now of type OWLOntologyID and should match ontologyIri, or derivative versioned IDs, whenever possible.
String	getKey(org.semanticweb.owlapi.model.OWLOntologyID ontologyId) Deprecated. public keys are now of type OWLOntologyID and should match ontologyId. To obtain alternate public keys (aliases) or versioned public keys, see listAliases(OWLOntologyID) and listVersions(IRI) respectively.
<O extends org.apache.clerezza.rdf.core.TripleCollection> O	getMetaGraph(Class<O> returnType) Returns the graph that stores all the information on stored ontologies.
org.semanticweb.owlapi.model.OWLOntologyID	getOntologyId(String storageKey) Deprecated.
OntologyNetworkConfiguration	getOntologyNetworkConfiguration() Deprecated.
Multiplexer	getOntologyNetworkDescriptor() XXX This method is temporary until Multiplexer becomes an OSGi component.
String	getPublicKey(org.semanticweb.owlapi.model.OWLOntologyID ontologyId) Deprecated. public keys are now of type OWLOntologyID and should match ontologyId. To obtain alternate public keys (aliases) or versioned public keys, see listAliases(OWLOntologyID) and listVersions(IRI) respectively.
Set<org.semanticweb.owlapi.model.OWLOntologyID>	getPublicKeys() Deprecated. Please use listPrimaryKeys() instead.
OntologyProvider.Status	getStatus(org.semanticweb.owlapi.model.OWLOntologyID publicKey)
S	getStore() Returns the storage system used by this ontology provider (e.g. a TcProvider or an OWLOntologyManager).
<O> O	getStoredOntology(org.semanticweb.owlapi.model.IRI reference, Class<O> returnType) Deprecated.
<O> O	getStoredOntology(org.semanticweb.owlapi.model.IRI reference, Class<O> returnType, boolean merge) Deprecated.
<O> O	getStoredOntology(org.semanticweb.owlapi.model.OWLOntologyID reference, Class<O> returnType)
<O> O	getStoredOntology(org.semanticweb.owlapi.model.OWLOntologyID reference, Class<O> returnType, boolean merge)
<O> O	getStoredOntology(String key, Class<O> returnType) Deprecated.
<O> O	getStoredOntology(String key, Class<O> returnType, boolean forceMerge) Deprecated.
Class<?>[]	getSupportedReturnTypes() Returns an array containing the most specific types for ontology objects that this provider can manage and return on a call to getStoredOntology(String, Class).
boolean	hasOntology(org.semanticweb.owlapi.model.IRI ontologyIri) Deprecated.
boolean	hasOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey) Deprecated. the notion of "having an ontology" has become ambiguous. Please use getStatus(OWLOntologyID) and verify its value.
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listAliases(org.semanticweb.owlapi.model.OWLOntologyID publicKey) Returns all the alternate public keys of the ontology identified by the supplied public key.
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listAllRegisteredEntries()
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listOrphans()
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listPrimaryKeys() Returns the public keys of all the ontologies stored by this provider.
Set<org.semanticweb.owlapi.model.OWLOntologyID>	listVersions(org.semanticweb.owlapi.model.IRI ontologyIri) Returns all the public keys of the ontologies whose ontology IRI matches the one supplied,a nd which differ by version IRI.
org.semanticweb.owlapi.model.OWLOntologyID	loadInStore(InputStream data, String formatIdentifier, boolean force, Origin<?>... references) Retrieves an ontology by reading its content from a data stream and stores it using the storage system attached to this provider.
org.semanticweb.owlapi.model.OWLOntologyID	loadInStore(org.semanticweb.owlapi.model.IRI location, String formatIdentifier, boolean force, Origin<?>... references) Retrieves an ontology physically located at location (unless mapped otherwise by the offline configuration) and stores it using the storage system attached to this provider.
org.semanticweb.owlapi.model.OWLOntologyID	loadInStore(Object ontology, boolean force, Origin<?>... references) Stores an ontology that has already been loaded into an object.
boolean	removeOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey) Removes the ontology identified by the supplied public key.
void	setImportManagementPolicy(ImportManagementPolicy policy) Sets the policy adopted by this provider whenever an import statement is found in an ontology that has already been loaded (e.g. when exporting it).
void	setLocatorMapping(org.semanticweb.owlapi.model.IRI locator, org.semanticweb.owlapi.model.OWLOntologyID publicKey) Deprecated. this is now done by setting aliases. See addAlias(OWLOntologyID, OWLOntologyID).
void	setLocatorMapping(org.semanticweb.owlapi.model.IRI locator, String key) Deprecated. this is now done by setting aliases. See addAlias(OWLOntologyID, OWLOntologyID).

Field Detail

GRAPH_PREFIX

static final String GRAPH_PREFIX

The key used to configure the prefix to be used for addressing ontologies stored by this provider.

See Also:

Constant Field Values

IMPORT_POLICY

static final String IMPORT_POLICY

The key used to configure the import management policy.

See Also:

Constant Field Values

META_GRAPH_ID

static final String META_GRAPH_ID

The key used to configure the identifier of the meta-level graph

See Also:

Constant Field Values

RESOLVE_IMPORTS

static final String RESOLVE_IMPORTS

The key used to configure the default import resolution policy for this provider.

See Also:

Constant Field Values

Method Detail

addAlias

boolean addAlias(org.semanticweb.owlapi.model.OWLOntologyID primaryKey,
               org.semanticweb.owlapi.model.OWLOntologyID alias)

createBlankOntologyEntry

org.semanticweb.owlapi.model.OWLOntologyID createBlankOntologyEntry(org.semanticweb.owlapi.model.OWLOntologyID publicKey)

getImportManagementPolicy

ImportManagementPolicy getImportManagementPolicy()

Gets the policy adopted by this provider whenever an import statement is found in an ontology that has already been loaded (e.g. when exporting it). It does not influence how the system should resolve imports of newly found ontologies.

Returns:

the import management policy.

getKey

String getKey(org.semanticweb.owlapi.model.IRI ontologyIri)

Deprecated. public keys are now of type OWLOntologyID and should match ontologyIri, or derivative versioned IDs, whenever possible.

Gets a string that can be used to directly access the ontology whose logical identifier is ontologyIRI.

Parameters:

ontologyIri - the logical identifier of the ontology.

Returns:

the public key (note that it might be different from the graph name).

See Also:

listVersions(IRI), listAliases(OWLOntologyID)

getKey

String getKey(org.semanticweb.owlapi.model.OWLOntologyID ontologyId)

Deprecated. public keys are now of type OWLOntologyID and should match ontologyId. To obtain alternate public keys (aliases) or versioned public keys, see listAliases(OWLOntologyID) and listVersions(IRI) respectively.

Gets a string that can be used to directly access the ontology whose logical identifier is ontologyId.

Parameters:

ontologyId - the logical identifier of the ontology.

Returns:

the public key (note that it might be different from the graph name).

See Also:

listVersions(IRI), listAliases(OWLOntologyID)

getMetaGraph

<O extends org.apache.clerezza.rdf.core.TripleCollection> O getMetaGraph(Class<O> returnType)

Returns the graph that stores all the information on stored ontologies. Whether the returned triple collection is a Graph or a MGraph depends on the provider's policy on allowing external modifications to the meta-level graph or not.

Parameters:

returnType -

Returns:

getOntologyId

@Deprecated
org.semanticweb.owlapi.model.OWLOntologyID getOntologyId(String storageKey)

Deprecated.

getOntologyNetworkConfiguration

@Deprecated
OntologyNetworkConfiguration getOntologyNetworkConfiguration()

Deprecated.

getOntologyNetworkDescriptor

Multiplexer getOntologyNetworkDescriptor()

XXX This method is temporary until Multiplexer becomes an OSGi component.

Returns:

getPublicKey

String getPublicKey(org.semanticweb.owlapi.model.OWLOntologyID ontologyId)

Deprecated. public keys are now of type OWLOntologyID and should match ontologyId. To obtain alternate public keys (aliases) or versioned public keys, see listAliases(OWLOntologyID) and listVersions(IRI) respectively.

Gets the key of the ontology with the supplied ontology ID. Note that both ontoloeyIRI and versionIRI (if present) must match, otherwise it will return null.

Parameters:

ontologyId -

Returns:

See Also:

listVersions(IRI), listAliases(OWLOntologyID)

getPublicKeys

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

Deprecated. Please use listPrimaryKeys() instead.

Gets the set of all the strings that can be used to access the ontologies stored by this provider.

Returns:

the ontology key set.

getStatus

OntologyProvider.Status getStatus(org.semanticweb.owlapi.model.OWLOntologyID publicKey)

getStore

S getStore()

Returns the storage system used by this ontology provider (e.g. a TcProvider or an OWLOntologyManager).

Returns:

the ontology store.

getStoredOntology

<O> O getStoredOntology(org.semanticweb.owlapi.model.IRI reference,
                      Class<O> returnType)

Deprecated.

Same as getStoredOntology(String, Class), but instead of the internal key it uses an IRI that publicly identifies or references an ontology. This can be, ordered by preference most relevant first:

1. The version IRI
2. The ontology IRI
3. The physical IRI, if different from the above

Parameters:

reference - the IRI that references the ontology.

returnType - the desired type that the method should return, if supported, otherwise an UnsupportedOperationException is thrown. Can be null, in which case a default return type is chosen.

Returns:

the stored ontology in the desired format, or null if no such ontology is managed by the provider.

getStoredOntology

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

Deprecated.

Same as getStoredOntology(String, Class, boolean), but instead of the internal key it uses an IRI that publicly identifies or references an ontology. This can be, ordered by preference most relevant first:

Parameters:

reference - the IRI that references the ontology.

returnType - The expected type for the returned ontology object. If null, the provider will arbitrarily select a supported return type. If the supplied type is not supported (i.e. not assignable to any type contained in the result of getSupportedReturnTypes()) an UnsupportedOperationException should be thrown.

forceMerge - if true, the ontology will be merged with all its imports, thus overriding the import management policy set for this provider.

Returns:

the stored ontology in the desired format, or null if no such ontology is managed by the provider.

getStoredOntology

<O> O getStoredOntology(org.semanticweb.owlapi.model.OWLOntologyID reference,
                      Class<O> returnType)

getStoredOntology

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

getStoredOntology

<O> O getStoredOntology(String key,
                      Class<O> returnType)

Deprecated.

Returns a stored ontology that is internally identified by the provided key.

Parameters:

key - the key used to identify the ontology in this provider. They can or cannot coincide with the logical and/or physical IRI of the ontology.

returnType - The expected type for the returned ontology object. If null, the provider will arbitrarily select a supported return type. If the supplied type is not supported (i.e. not assignable to any type contained in the result of getSupportedReturnTypes()) an UnsupportedOperationException should be thrown.

Returns:

the stored ontology in the desired format, or null if no such ontology is managed by the provider.

getStoredOntology

<O> O getStoredOntology(String key,
                      Class<O> returnType,
                      boolean forceMerge)

Deprecated.

Returns a stored ontology that is internally identified by the provided key.

Parameters:

key - the key used to identify the ontology in this provider. They can or cannot coincide with the logical and/or physical IRI of the ontology.

returnType - The expected type for the returned ontology object. If null, the provider will arbitrarily select a supported return type. If the supplied type is not supported (i.e. not assignable to any type contained in the result of getSupportedReturnTypes()) an UnsupportedOperationException should be thrown.

forceMerge - if true, the ontology will be merged with all its imports, thus overriding the import management policy set for this provider.

Returns:

the stored ontology in the desired format, or null if no such ontology is managed by the provider.

getSupportedReturnTypes

Class<?>[] getSupportedReturnTypes()

Returns an array containing the most specific types for ontology objects that this provider can manage and return on a call to getStoredOntology(String, Class).

Returns:

the supported ontology return types.

hasOntology

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

Deprecated.

A convenience method for checking the availability of an ontology given its (physical or logical) IRI. It is typically more efficient than calling getStoredOntology(IRI, Class) and null-checking the result.

Parameters:

ontologyIri -

Returns:

hasOntology

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

Deprecated. the notion of "having an ontology" has become ambiguous. Please use getStatus(OWLOntologyID) and verify its value.

Checks if an ontology with the specified OWL ontology ID is in the ontology provider's store.

Implementations are typically faster than calling getStoredOntology(IRI, Class) and checking if the returned value is not null.

Parameters:

publicKey - the ontology id. If there is both an ontology IRI and a version IRI, both must match the ontology provider's records in order to return true. Otherwise, it will return true iff any match with the ontology IIR is found, no matter its version IRI.

Returns:

true iff an ontology with the supplied id is in the provider's store.

listAliases

Set<org.semanticweb.owlapi.model.OWLOntologyID> listAliases(org.semanticweb.owlapi.model.OWLOntologyID publicKey)

Returns all the alternate public keys of the ontology identified by the supplied public key. These could include, for example, the physical URLs they were, or can be, retrieved from. The supplied public key is not included in the returned set, and it needs not be the primary key. It can be an alias itself, in whih case the primary key will be included in the results.

Parameters:

publicKey - the public key of the ontology. It could be an alias itself.

Returns:

the matching versions of stored ontologies.

listAllRegisteredEntries

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

listOrphans

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

listPrimaryKeys

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

Returns the public keys of all the ontologies stored by this provider. Only primary keys are returned: aliases are not included.

Returns:

all the ontology public keys.

listVersions

Set<org.semanticweb.owlapi.model.OWLOntologyID> listVersions(org.semanticweb.owlapi.model.IRI ontologyIri)

Returns all the public keys of the ontologies whose ontology IRI matches the one supplied,a nd which differ by version IRI. Only primary keys are returned: aliases are not included.

Parameters:

ontologyIri - the ontology IRI to match

Returns:

the matching versions of stored ontologies.

loadInStore

org.semanticweb.owlapi.model.OWLOntologyID loadInStore(InputStream data,
                                                     String formatIdentifier,
                                                     boolean force,
                                                     Origin<?>... references)
                                                       throws IOException,
                                                              org.apache.clerezza.rdf.core.serializedform.UnsupportedFormatException

Retrieves an ontology by reading its content from a data stream and stores it using the storage system attached to this provider. A key that can be used to identify the ontology in this provider is returned if successful.

Parameters:

data - the ontology content.

formatIdentifier - the MIME type of the expected serialization format of this ontology. If null, all supported formats will be tried until all parsers fail or one succeeds. Whether the supplied format will be the only one to be attempted, or simply the preferred one, is left to arbitration and is implementation-dependent.

force - if true, all mappings provided by the offline configuration will be ignored (both for the root ontology and its recursive imports) and the provider will forcibly try to resolve the location IRI. If some remote import is found, the import policy is aggressive and Stanbol is set on offline mode, this method will fail.

Returns:

a key that can be used to retrieve the stored ontology afterwards, or null if loading/storage failed. If it was possible to set it as such, it will be the same as preferredKey.

Throws:

IOException - if all attempts to load the ontology failed.

org.apache.clerezza.rdf.core.serializedform.UnsupportedFormatException - if no parsers are able to parse the supplied format (or the actual file format).

loadInStore

org.semanticweb.owlapi.model.OWLOntologyID loadInStore(org.semanticweb.owlapi.model.IRI location,
                                                     String formatIdentifier,
                                                     boolean force,
                                                     Origin<?>... references)
                                                       throws IOException

Retrieves an ontology physically located at location (unless mapped otherwise by the offline configuration) and stores it using the storage system attached to this provider. A key that can be used to identify the ontology in this provider is returned if successful.

Parameters:

location - the physical IRI where the ontology is located.

formatIdentifier - the MIME type of the expected serialization format of this ontology. If null, all supported formats will be tried until all parsers fail or one succeeds. Whether the supplied format will be the only one to be attempted, or simply the preferred one, is left to arbitration and is implementation-dependent.

force - if true, all mappings provided by the offline configuration will be ignored (both for the root ontology and its recursive imports) and the provider will forcibly try to resolve the location IRI. If the IRI is not local and Stanbol is set on offline mode, this method will fail.

Returns:

a key that can be used to retrieve the stored ontology afterwards, or null if loading/storage failed.

Throws:

IOException - if all attempts to load the ontology failed.

org.apache.clerezza.rdf.core.serializedform.UnsupportedFormatException - if no parsers are able to parse the supplied format (or the actual file format).

loadInStore

org.semanticweb.owlapi.model.OWLOntologyID loadInStore(Object ontology,
                                                     boolean force,
                                                     Origin<?>... references)

Stores an ontology that has already been loaded into an object. If the object is of a non-native yet supported type, the ontology provider will try to perform a conversion prior to storing it.

Parameters:

ontology - the ontology to be stored.

force - if true, all mappings provided by the offline configuration will be ignored (both for the root ontology and its recursive imports) and the provider will forcibly try to resolve the location IRI. If some remote import is found, the import policy is aggressive and Stanbol is set on offline mode, this method will fail.

Returns:

removeOntology

boolean removeOntology(org.semanticweb.owlapi.model.OWLOntologyID publicKey)
                       throws OntologyHandleException

Removes the ontology identified by the supplied public key.

Parameters:

publicKey - the public key for accessing the ontology.

Returns:

true iff an ontology with that public key existed and was removed.

Throws:

OntologyHandleException

setImportManagementPolicy

void setImportManagementPolicy(ImportManagementPolicy policy)

Sets the policy adopted by this provider whenever an import statement is found in an ontology that has already been loaded (e.g. when exporting it). It does not influence how the system should resolve imports of newly found ontologies.

Parameters:

policy - the import management policy.

setLocatorMapping

void setLocatorMapping(org.semanticweb.owlapi.model.IRI locator,
                     org.semanticweb.owlapi.model.OWLOntologyID publicKey)

Deprecated. this is now done by setting aliases. See addAlias(OWLOntologyID, OWLOntologyID).

Tells this ontology provider that a stored ontology whose public key is publicKey can be (or was) retrieved by dereferencing locator. If publicKeydoes not exist in the provider, or if locator is already bound to an incompatible key, an IllegalArgumentException will be thrown.

Parameters:

locator - a physical location for this ontology.

publicKey - the public key of the stored ontology.

setLocatorMapping

void setLocatorMapping(org.semanticweb.owlapi.model.IRI locator,
                     String key)

Deprecated. this is now done by setting aliases. See addAlias(OWLOntologyID, OWLOntologyID).

Parameters:

locator -

key -