org.wandora.modules.topicmap

Interface TopicMapManager

All Superinterfaces:

Module

All Known Implementing Classes:

SimpleTopicMapManager, WandoraTopicMapManager

public interface TopicMapManager
extends Module

The interface for a module that provides a topic map, and related services, for other modules. Just providing access to the topic map is the main function of this. In addition to that, there are some locking mechanisms, but depending on the implementation, they may or may not actually do anything. Implementation details may also vary but the idea is that any number of read locks can be acquired at the same time but write locks are exclusive, no readers or other writers are allowed at the same time.

You can also add listeners that will be notified if the whole topic map is changed. Note that this is different to just changes in the topic map, the topic map itself has listener mechanisms for that. The listener you register with the manager is notified when the entire topic map is replaced with another topic map.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TopicMapManager.TopicMapManagerListener An interface for objects that want to be notified when the managed topic map is replaced with another topic map.

Method Summary

Modifier and Type	Method and Description
void	addTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener) Adds a topic map listener that will be notified when the managed topic map is replaced with another topic map.
TopicMap	getTopicMap() Returns the topic map managed by this topic map manager.
boolean	lockRead() Locks the topic map for reading.
boolean	lockWrite() Locks the topic map for writing.
void	removeTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener) Removes a topic map listener.
void	unlockRead() Releases a previously acquired read lock.
void	unlockWrite() Releases a previously acquired write lock.

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

lockRead

boolean lockRead()

Locks the topic map for reading. You must eventually release the lock with unlockRead if this method succeeds and returns true.

Returns:

True if the locking succeeded, false otherwise.

unlockRead

void unlockRead()

Releases a previously acquired read lock.

lockWrite

boolean lockWrite()

Locks the topic map for writing. You must eventually release the lock with unlockWrite if this method succeeds and returns true.

Returns:

True if the locking succeeded, false otherwise.

unlockWrite

void unlockWrite()

Releases a previously acquired write lock.

getTopicMap

TopicMap getTopicMap()

Returns the topic map managed by this topic map manager.

Returns:

The topic map of this manager.

addTopicMapManagerListener

void addTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener)

Adds a topic map listener that will be notified when the managed topic map is replaced with another topic map.

Parameters:

listener - The topic map listener.

removeTopicMapManagerListener

void removeTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener)

Removes a topic map listener.

Parameters:

listener - The listener.