org.wandora.modules

Class ModuleGroup

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.ModuleGroup

All Implemented Interfaces:

Module, XMLOptionsHandler

public class ModuleGroup
extends ScriptModule
implements XMLOptionsHandler

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<Module>	childModules

Fields inherited from class org.wandora.modules.ScriptModule

engine, initScript, persistentObjects, scriptManager, startScript, stopScript

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
ModuleGroup()

Method Summary

Modifier and Type	Method and Description
void	addChildModule(Module m)
java.util.Collection<Module>	getChildModules()
java.util.Collection<Module>	getChildModulesRecursive()
protected void	parseChildModules(ModuleManager manager, org.w3c.dom.Element e, java.lang.String source)
java.util.HashMap<java.lang.String,java.lang.Object>	parseXMLOptionsElement(ModuleManager manager, org.w3c.dom.Element e, java.lang.String source) Parses the given module element and returns a map containing the module parameters.
void	startGroup(boolean withDependencies)
void	stopGroup(boolean cascading)

Methods inherited from class org.wandora.modules.ScriptModule

getScriptEngine, init, start, stop

Methods inherited from class org.wandora.modules.AbstractModule

getDependencies, isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

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

Field Detail

childModules

protected final java.util.ArrayList<Module> childModules

Constructor Detail

ModuleGroup

public ModuleGroup()

Method Detail

startGroup

public void startGroup(boolean withDependencies)
                throws ModuleException

Throws:

ModuleException

stopGroup

public void stopGroup(boolean cascading)
               throws ModuleException

Throws:

ModuleException

addChildModule

public void addChildModule(Module m)

getChildModules

public java.util.Collection<Module> getChildModules()

getChildModulesRecursive

public java.util.Collection<Module> getChildModulesRecursive()

parseChildModules

protected void parseChildModules(ModuleManager manager,
                                 org.w3c.dom.Element e,
                                 java.lang.String source)
                          throws java.lang.ReflectiveOperationException,
                                 javax.script.ScriptException

Throws:

java.lang.ReflectiveOperationException

javax.script.ScriptException

parseXMLOptionsElement

public java.util.HashMap<java.lang.String,java.lang.Object> parseXMLOptionsElement(ModuleManager manager,
                                                                                   org.w3c.dom.Element e,
                                                                                   java.lang.String source)
                                                                            throws java.lang.ReflectiveOperationException,
                                                                                   javax.script.ScriptException

Description copied from interface: XMLOptionsHandler

Parses the given module element and returns a map containing the module parameters. The module parameters will later be passed to your module again in init method. You may of course retain parsed information outside this map as well and refer to it later in the initialisation.

Specified by:

parseXMLOptionsElement in interface XMLOptionsHandler

Parameters:

manager - The module manager handling this module.

e - The module element which is to be parsed.

source - The source identifier for the module, could be the file name where the module comes from or something else.

Returns:

The parsed module parameters which will be passed to the init method of your module later.

Throws:

java.lang.ReflectiveOperationException

javax.script.ScriptException