org.infohazard.maverick.flow
Interface ShuntFactory

All Known Implementing Classes:

LanguageShuntFactory

public interface ShuntFactory

Pluggable modules which build Shunts must implement this interface and then be defined in the <modules> section of the Maverick config file. One factory is created to build all Shunts.

Version:

$Revision: 1.3 $ $Date: 2002/02/07 22:49:56 $

Author:

Jeff Schnitzer

Method Summary

Shunt	createShunt() Creates an empty Shunt which will be populated.
void	init(org.jdom.Element factoryNode, javax.servlet.ServletConfig servletCfg) The factory is initialized with the XML element from the configuration file.

Method Detail

init

public void init(org.jdom.Element factoryNode,
                 javax.servlet.ServletConfig servletCfg)
          throws ConfigException

The factory is initialized with the XML element from the configuration file. Individual ShuntFactory implementations are free to interpret their XML nodes as they like.

Parameters:

factoryNode - The XML element (and child nodes) configured in the Maverick configuration file.

servletCfg - So that the factory can get information from the container.

Throws:

ConfigException - If the configuration was invalid.

createShunt

public Shunt createShunt()
                  throws ConfigException

Creates an empty Shunt which will be populated.

Returns:

A new, empty shunt.

Throws:

ConfigException - If something is wrong with the configuration.