org.wandora.modules.topicmap

Class WandoraTopicMapManager

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.topicmap.WandoraTopicMapManager

All Implemented Interfaces:

Module, TopicMapManager

public class WandoraTopicMapManager
extends AbstractModule
implements TopicMapManager

A TopicMapManager implementation that uses a running Wandora application for the topic map. This will only work if the Wandora application is running in the same virtual machine. Wandora is not a module in the framework, instead it is accessed using the static Wandora.getWandora method.

This module does not use any initialisation parameters beyond those of AbstractModule.

Author:

olli

Nested Class Summary

Nested classes/interfaces inherited from interface org.wandora.modules.topicmap.TopicMapManager

TopicMapManager.TopicMapManagerListener

Field Summary

Fields

Modifier and Type	Field and Description
protected ListenerList<TopicMapManager.TopicMapManagerListener>	managerListeners
protected java.util.concurrent.locks.ReadWriteLock	tmLock
protected Wandora	wandora

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
WandoraTopicMapManager()

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.
protected void	fireTopicMapChanged(TopicMap old, TopicMap neu)
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
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	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.
void	unlockRead() Releases a previously acquired read lock.
void	unlockWrite() Releases a previously acquired write lock.

Methods inherited from class org.wandora.modules.AbstractModule

init, isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.wandora.modules.Module

init, isInitialized, isRunning

Field Detail

managerListeners

protected final ListenerList<TopicMapManager.TopicMapManagerListener> managerListeners

tmLock

protected java.util.concurrent.locks.ReadWriteLock tmLock

wandora

protected Wandora wandora

Constructor Detail

WandoraTopicMapManager

public WandoraTopicMapManager()

Method Detail

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class AbstractModule

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class AbstractModule

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class AbstractModule

Parameters:

manager - The module manager handling this module.

lockRead

public boolean lockRead()

Description copied from interface: TopicMapManager

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

Specified by:

lockRead in interface TopicMapManager

Returns:

True if the locking succeeded, false otherwise.

unlockRead

public void unlockRead()

Description copied from interface: TopicMapManager

Releases a previously acquired read lock.

Specified by:

unlockRead in interface TopicMapManager

lockWrite

public boolean lockWrite()

Description copied from interface: TopicMapManager

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

Specified by:

lockWrite in interface TopicMapManager

Returns:

True if the locking succeeded, false otherwise.

unlockWrite

public void unlockWrite()

Description copied from interface: TopicMapManager

Releases a previously acquired write lock.

Specified by:

unlockWrite in interface TopicMapManager

getTopicMap

public TopicMap getTopicMap()

Description copied from interface: TopicMapManager

Returns the topic map managed by this topic map manager.

Specified by:

getTopicMap in interface TopicMapManager

Returns:

The topic map of this manager.

fireTopicMapChanged

protected void fireTopicMapChanged(TopicMap old,
                                   TopicMap neu)

addTopicMapManagerListener

public void addTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener)

Description copied from interface: TopicMapManager

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

Specified by:

addTopicMapManagerListener in interface TopicMapManager

Parameters:

listener - The topic map listener.

removeTopicMapManagerListener

public void removeTopicMapManagerListener(TopicMapManager.TopicMapManagerListener listener)

Description copied from interface: TopicMapManager

Removes a topic map listener.

Specified by:

removeTopicMapManagerListener in interface TopicMapManager

Parameters:

listener - The listener.