eu.larkc.core.pluginManager
Interface PluginManager

All Known Implementing Classes:

GatPluginManager, JeePluginManager, LocalPluginManager

public interface PluginManager

A Plugin Manager is a container within which a particular instantiation of a Plugin lives during the execution of the pipeline. The Plugin manager makes the life of the plugin developer easier by providing all those features related to communication with the rest of the pipeline.

Author:

Mick Kerrigan, Barry Bishop

Nested Class Summary

static class

PluginManager.Message This enumeraton contains the set of messages that can be send to a given PluginManger from another PluginManger.

Method Summary

void	accept(PluginManager.Message message) The accept method allows a particular party to send a control message to the Plugin Manger.
void	addInputQueue(Queue<SetOfStatements> inputQueue) This method adds an input queue to the list of input queues.
void	addOutputQueue(Queue<SetOfStatements> outputQueue) This method adds an output queue to the list of output queues.
void	addPrevious(PluginManager thePluginManager) The setPrevious method is used to inform the PluginManager of the previous PluginManager in the pipeline, i.e.
java.util.List<Queue<SetOfStatements>>	getInputQueues() This method returns the input queues of the manager.
java.util.List<Queue<SetOfStatements>>	getOutputQueues() This method returns the output queues of the manager.
void	setInputQueues(java.util.List<Queue<SetOfStatements>> theInputQueues) This method sets the input queues of the manager.
void	setOutputQueues(java.util.List<Queue<SetOfStatements>> theOutputQueues) This method sets the output queues of the manager.
void	start() The start method should be called to instruct the Plugin Manager that it should begin the process of finding data for the plugin it manages and producing data for the next plugin in the pipeline.

Method Detail

accept

void accept(PluginManager.Message message)

The accept method allows a particular party to send a control message to the Plugin Manger.

Parameters:

message - the message being sent from another PluginManager

See Also:

PluginManager.Message

addPrevious

void addPrevious(PluginManager thePluginManager)

The setPrevious method is used to inform the PluginManager of the previous PluginManager in the pipeline, i.e. the PluginManger from whcih it should request data

Parameters:

thePluginManager - the PluginManager responsible for managing the previous plugin in the pipeline

getInputQueues

java.util.List<Queue<SetOfStatements>> getInputQueues()

This method returns the input queues of the manager.

Returns:

the input queues

setInputQueues

void setInputQueues(java.util.List<Queue<SetOfStatements>> theInputQueues)

This method sets the input queues of the manager.

Parameters:

theInputQueues - the input queues

addInputQueue

void addInputQueue(Queue<SetOfStatements> inputQueue)

This method adds an input queue to the list of input queues.

Parameters:

inputQueue - the new input queue

getOutputQueues

java.util.List<Queue<SetOfStatements>> getOutputQueues()

This method returns the output queues of the manager.

Returns:

the output queues

setOutputQueues

void setOutputQueues(java.util.List<Queue<SetOfStatements>> theOutputQueues)

This method sets the output queues of the manager.

Parameters:

theOutputQueues - the output queues

addOutputQueue

void addOutputQueue(Queue<SetOfStatements> outputQueue)

This method adds an output queue to the list of output queues.

Parameters:

outputQueue - the new output queue

start

void start()

The start method should be called to instruct the Plugin Manager that it should begin the process of finding data for the plugin it manages and producing data for the next plugin in the pipeline.