org.wandora.modules

Class DefaultReplacementsModule

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.DefaultReplacementsModule

All Implemented Interfaces:

Module, ReplacementsModule

public class DefaultReplacementsModule
extends AbstractModule
implements ReplacementsModule

A basic implementation of the replacements system. You can add replacements in the module parameters using parameter names replacement.key. The every occurrence of key is replaced in the text with the value of the parameter. In addition to these some default dynamic replacements are available. $DATETIME is replaced with a date and time stamp. $USER is replaced with the name of the logged in user, if one is available in the context.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultReplacementsModule.RegexReplacement
static interface	DefaultReplacementsModule.Replacement
static class	DefaultReplacementsModule.StringReplacement

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,DefaultReplacementsModule.Replacement>	replacements

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
DefaultReplacementsModule()

Method Summary

Modifier and Type	Method and Description
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
java.lang.String	replaceValue(java.lang.String value, java.util.HashMap<java.lang.String,java.lang.Object> context) Replace the values in the given string using the given context.

Methods inherited from class org.wandora.modules.AbstractModule

getDependencies, isInitialized, isRunning, requireLogging, start, stop, 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

getDependencies, isInitialized, isRunning, start, stop

Field Detail

replacements

protected java.util.HashMap<java.lang.String,DefaultReplacementsModule.Replacement> replacements

Constructor Detail

DefaultReplacementsModule

public DefaultReplacementsModule()

Method Detail

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class AbstractModule

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

replaceValue

public java.lang.String replaceValue(java.lang.String value,
                                     java.util.HashMap<java.lang.String,java.lang.Object> context)

Description copied from interface: ReplacementsModule

Replace the values in the given string using the given context. The exact way the context is used depends on the implementation. It is not necessarily used so that every occurrence of the key in the context is replaced with the value.

Specified by:

replaceValue in interface ReplacementsModule

Parameters:

value - The string in which replacements are to be done.

context - A context used in the replacements.

Returns: