org.apache.stanbol.ontologymanager.servicesapi.scope

Interface Scope

All Superinterfaces:

Lockable, NamedArtifact, OntologyCollectorListenable, OWLExportable

All Known Subinterfaces:

OntologyScope

public interface Scope
extends NamedArtifact, Lockable, OntologyCollectorListenable, OWLExportable

Represents an ontology network that is used for modelling a given knowledge component or domain, e.g. workflows, organisations, devices, content or business domain.

Each ontology scope comprises in turn a number of ontology spaces of three kinds.

• Exactly one core space, which defines the immutable components of the scope.
• At most one custom space, which contains user-defined components.
• Zero or more session spaces, which contains (potentially volatile) components specific for user sessions.

An ontology scope can thus be seen as a façade for ontology spaces.

Author:

alexdma

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.stanbol.ontologymanager.servicesapi.ontology.OWLExportable

OWLExportable.ConnectivityPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static String	shortName

Method Summary

Methods

Modifier and Type	Method and Description
OntologySpace	getCoreSpace() Returns the core ontology space for this ontology scope.
OntologySpace	getCustomSpace() Returns the custom ontology space for this ontology scope.
void	setCustomSpace(OntologySpace customSpace) Sets an ontology space as the custom space for this scope.
void	setUp() Performs the operations required for activating the ontology scope.
void	tearDown() Performs the operations required for deactivating the ontology scope.

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

getDefaultNamespace, getID, getNamespace, setDefaultNamespace, setNamespace

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

isLocked

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

addOntologyCollectorListener, clearOntologyCollectorListeners, getOntologyCollectorListeners, removeOntologyCollectorListener

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.ontology.OWLExportable

export, export, getConnectivityPolicy, setConnectivityPolicy

Field Detail

shortName

static final String shortName

See Also:

Constant Field Values

Method Detail

getCoreSpace

OntologySpace getCoreSpace()

Returns the core ontology space for this ontology scope. The core space should never be null for any scope.

Returns:

the core ontology space

getCustomSpace

OntologySpace getCustomSpace()

Returns the custom ontology space for this ontology scope.

Returns:

the custom ontology space, or null if no custom space is registered for this scope.

setCustomSpace

void setCustomSpace(OntologySpace customSpace)
                    throws UnmodifiableOntologyCollectorException

Sets an ontology space as the custom space for this scope.

Parameters:

customSpace - the custom ontology space.

Throws:

UnmodifiableOntologyCollectorException - if either the scope or the supplied space are locked.

setUp

void setUp()

Performs the operations required for activating the ontology scope. It should be possible to perform them after the constructor has been invoked.

When the core ontology space is created for this scope, this should be set in the scope constructor. It can be changed in the setUp() method though.

tearDown

void tearDown()

Performs the operations required for deactivating the ontology scope. In general, this is not equivalent to finalizing the object for garbage collection. It should be possible to activate the same ontology scope again if need be.