org.apache.stanbol.ontologymanager.servicesapi.scope

Interface ScopeRegistry

All Superinterfaces:

ScopeEventListenable

All Known Subinterfaces:

ONManager, ScopeManager, ScopeRegistry

public interface ScopeRegistry
extends ScopeEventListenable

A registry that keeps track of the active ontology scopes in a running KReS instance.

TODO deprecate scope registration methods and manage registration automcatically.

Author:

alexdma

Method Summary

Methods

Modifier and Type	Method and Description
void	addScopeRegistrationListener(ScopeEventListener listener) Deprecated. use ScopeEventListenable.addScopeEventListener(ScopeEventListener)
void	clearScopeRegistrationListeners() Deprecated. use ScopeEventListenable.clearScopeEventListeners()
boolean	containsScope(String scopeID)
void	deregisterScope(Scope scope) Removes an ontology scope from this registry, thus deactivating the scope and all of its associated spaces.
Set<Scope>	getActiveScopes()
Set<Scope>	getRegisteredScopes() Returns the set of registered ontology scopes.
Scope	getScope(String scopeID) Returns the unique ontology scope identified by the given ID.
Set<ScopeEventListener>	getScopeRegistrationListeners() Deprecated. use ScopeEventListenable.getScopeEventListeners()
boolean	isScopeActive(String scopeID)
void	registerScope(Scope scope) Equivalent to registerScope(scope, false).
void	registerScope(Scope scope, boolean activate) Adds an ontology scope to this registry, thus activating the scope if activate is set and (at a bare minumum) its core space.
void	removeScopeRegistrationListener(ScopeEventListener listener) Deprecated. use ScopeEventListenable.removeScopeEventListener(ScopeEventListener)
void	setScopeActive(String scopeID, boolean active)

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

addScopeEventListener, clearScopeEventListeners, getScopeEventListeners, removeScopeEventListener

Method Detail

addScopeRegistrationListener

void addScopeRegistrationListener(ScopeEventListener listener)

Deprecated. use ScopeEventListenable.addScopeEventListener(ScopeEventListener)

Adds a scope registration listener to this registry. If the listener was already added, this should result in no effect.

Parameters:

listener - the listener to be added

clearScopeRegistrationListeners

void clearScopeRegistrationListeners()

Deprecated. use ScopeEventListenable.clearScopeEventListeners()

Removes all registered scope registration listeners.

containsScope

boolean containsScope(String scopeID)

Parameters:

scopeID -

Returns:

true iff an ontology scope with ID scopeID is registered.

deregisterScope

void deregisterScope(Scope scope)

Removes an ontology scope from this registry, thus deactivating the scope and all of its associated spaces. All attached listeners should hear this deregistration on their scopeDeregistered() method.

Parameters:

scope - the ontology scope to be removed

getActiveScopes

Set<Scope> getActiveScopes()

getRegisteredScopes

Set<Scope> getRegisteredScopes()

Returns the set of registered ontology scopes.

Returns:

the set of ontology scopes

getScope

Scope getScope(String scopeID)

Returns the unique ontology scope identified by the given ID.

Parameters:

scopeID - the scope identifier

Returns:

the ontology scope with that ID, or null if no scope with such ID is registered

getScopeRegistrationListeners

Set<ScopeEventListener> getScopeRegistrationListeners()

Deprecated. use ScopeEventListenable.getScopeEventListeners()

Returns the set of registered scope registration listeners, in no particular order.

Returns:

the set of scope registration listeners

isScopeActive

boolean isScopeActive(String scopeID)

registerScope

void registerScope(Scope scope)
                   throws DuplicateIDException

Equivalent to registerScope(scope, false).

Parameters:

scope - the ontology scope to be added

Throws:

DuplicateIDException

registerScope

void registerScope(Scope scope,
                 boolean activate)
                   throws DuplicateIDException

Adds an ontology scope to this registry, thus activating the scope if activate is set and (at a bare minumum) its core space. All attached listeners should hear this registration on their scopeRegistered() method.

Parameters:

scope - the ontology scope to be added

Throws:

DuplicateIDException

removeScopeRegistrationListener

void removeScopeRegistrationListener(ScopeEventListener listener)

Deprecated. use ScopeEventListenable.removeScopeEventListener(ScopeEventListener)

Removes a scope registration listener from this registry. If the listener was not previously added, this should result in no effect.

Parameters:

listener - the listener to be removed

setScopeActive

void setScopeActive(String scopeID,
                  boolean active)