org.apache.stanbol.ontologymanager.servicesapi.scope

Interface ScopeManager

All Superinterfaces:

ScopeEventListenable, ScopeFactory, ScopeRegistry

All Known Subinterfaces:

ONManager

public interface ScopeManager
extends ScopeFactory, ScopeRegistry

A Scope Manager holds all references and tools for creating, modifying and deleting the logical realms that store Web Ontologies, as well as offer facilities for handling the ontologies contained therein.

Note that since this object is both a ScopeRegistry and an ScopeFactory, the call to ScopeRegistry#registerScope(OntologyScope) or its overloads after ScopeFactory.createOntologyScope(String, OntologyInputSource...) is unnecessary, as the ONManager automatically registers newly created scopes.

Author:

alexdma, anuzzolese

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ONTOLOGY_PATH The key used to configure the path of the ontology network configuration.
static String	CONNECTIVITY_POLICY The key used to configure the connectivity policy.
static String	ID_SCOPE_REGISTRY The key used to configure the simple identifier of the scope registry (which should also be concatenated with the base namespace to obtain the registry's HTTP endpoint URI).

Method Summary

Methods

Modifier and Type	Method and Description
OfflineConfiguration	getOfflineConfiguration() Returns the offline configuration set for this ontology network manager, if any.
String	getOntologyNetworkConfigurationPath() Implementations should be able to create a File object from this path.
String	getOntologyNetworkNamespace() Deprecated. please use OfflineConfiguration.getDefaultOntologyNetworkNamespace() to obtain the namespace
OntologySpaceFactory	getOntologySpaceFactory()
ScopeRegistry	getScopeRegistry() Deprecated. This methods now returns the current object, which is also a ScopeRegistry.
void	setOntologyNetworkNamespace(String namespace) Deprecated. ScopeManager should set its namespace to be the same as OfflineConfiguration.getDefaultOntologyNetworkNamespace() whenever it changes on the object obtained by calling getOfflineConfiguration().

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.scope.ScopeFactory

createOntologyScope

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.scope.ScopeRegistry

addScopeRegistrationListener, clearScopeRegistrationListeners, containsScope, deregisterScope, getActiveScopes, getRegisteredScopes, getScope, getScopeRegistrationListeners, isScopeActive, registerScope, registerScope, removeScopeRegistrationListener, setScopeActive

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.scope.ScopeEventListenable

addScopeEventListener, clearScopeEventListeners, getScopeEventListeners, removeScopeEventListener

Field Detail

CONFIG_ONTOLOGY_PATH

static final String CONFIG_ONTOLOGY_PATH

The key used to configure the path of the ontology network configuration.

See Also:

Constant Field Values

CONNECTIVITY_POLICY

static final String CONNECTIVITY_POLICY

The key used to configure the connectivity policy.

See Also:

Constant Field Values

ID_SCOPE_REGISTRY

static final String ID_SCOPE_REGISTRY

The key used to configure the simple identifier of the scope registry (which should also be concatenated with the base namespace to obtain the registry's HTTP endpoint URI).

See Also:

Constant Field Values

Method Detail

getOfflineConfiguration

OfflineConfiguration getOfflineConfiguration()

Returns the offline configuration set for this ontology network manager, if any.

Returns:

the offline configuration, or null if none was set.

getOntologySpaceFactory

OntologySpaceFactory getOntologySpaceFactory()

getOntologyNetworkConfigurationPath

String getOntologyNetworkConfigurationPath()

Implementations should be able to create a File object from this path.

Returns:

the local path of the ontology storing the ontology network configuration.

getOntologyNetworkNamespace

String getOntologyNetworkNamespace()

Deprecated. please use OfflineConfiguration.getDefaultOntologyNetworkNamespace() to obtain the namespace

Returns the base namespace to be used for the Stanbol ontology network (e.g. for the creation of new scopes). For convenience, it is returned as a string so that it can be concatenated to form IRIs.

Returns:

the base namespace of the Stanbol ontology network.

getScopeRegistry

ScopeRegistry getScopeRegistry()

Deprecated. This methods now returns the current object, which is also a ScopeRegistry.

Returns the unique ontology scope registry for this context.

Returns:

the ontology scope registry.

setOntologyNetworkNamespace

void setOntologyNetworkNamespace(String namespace)

Deprecated. ScopeManager should set its namespace to be the same as OfflineConfiguration.getDefaultOntologyNetworkNamespace() whenever it changes on the object obtained by calling getOfflineConfiguration().

Sets the IRI that will be the base namespace for all ontology scopes and collectors created by this object.

Parameters:

namespace - the base namespace.