lazyj.page

Class Module

java.lang.Object

lazyj.page.Module

public abstract class Module
extends java.lang.Object

Any dynamic module that can be called by the BasePage to show some dynamic content must extend this class. The dynamic modules are called when the tag name looks like a java class (package.class_name for example).

Since:

2006-10-15

Author:

root

Constructor Summary

Constructors

Constructor and Description
Module()

Method Summary

Methods

Modifier and Type	Method and Description
ExtendedServlet	getCallingServlet() This method will return the calling servlet, if it was set.
abstract Page	getContent(java.util.Map<java.lang.String,java.lang.String> m) This is the work that the module does.
Page	getContent(java.lang.String s) This is called by BasePage to obtain the page to put in the place of the tag.
protected static int	geti(java.util.Map<java.lang.String,java.lang.String> m, java.lang.String s, int i) Method to easily extract an integer parameter from the module arguments.
abstract java.lang.String	getModuleName() The module must also implement this method, to return a nice name to debug.
protected static java.lang.String	gets(java.util.Map<java.lang.String,java.lang.String> m, java.lang.String s, java.lang.String sDefault) Method to easily extract a string parameter from the module arguments.
TemplatePage	getWrapper() This default method returns a wrapper for the HTML that is generated by all the modules.
static java.util.Map<java.lang.String,java.lang.String>	parse(java.lang.String s) This method parses the argument string to obtain the key-value pairs for the arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

public Module()

Method Detail

getContent

public Page getContent(java.lang.String s)

This is called by BasePage to obtain the page to put in the place of the tag. The argument will be parsed to extract key=value pairs and to put them into a Map of options to be given to the module implementation.

Parameters:

s - arguments, the rest of the tag after the class name

Returns:

a BasePage with the contents to put in the final page

getContent

public abstract Page getContent(java.util.Map<java.lang.String,java.lang.String> m)

This is the work that the module does.

Parameters:

m - arguments to call the module with

Returns:

the resulting page

getModuleName

public abstract java.lang.String getModuleName()

The module must also implement this method, to return a nice name to debug.

Returns:

a String with the module name

getWrapper

public TemplatePage getWrapper()

This default method returns a wrapper for the HTML that is generated by all the modules. The easiest way to implement a module is to call this method and then to add contents to this base page.

Returns:

a default wrapper for all the modules

geti

protected static final int geti(java.util.Map<java.lang.String,java.lang.String> m,
       java.lang.String s,
       int i)

Method to easily extract an integer parameter from the module arguments.

Parameters:

m - map of the arguments

s - key name

i - default value to return in case of an error

Returns:

the parsed integer value, or the default value in case of an error

gets

protected static final java.lang.String gets(java.util.Map<java.lang.String,java.lang.String> m,
                    java.lang.String s,
                    java.lang.String sDefault)

Method to easily extract a string parameter from the module arguments.

Parameters:

m - map of the arguments

s - key name

sDefault - the default value to return in case the key is not found in the arguments of the module at call time

Returns:

the value for this key, if it exists, otherwise the default value

parse

public static final java.util.Map<java.lang.String,java.lang.String> parse(java.lang.String s)

This method parses the argument string to obtain the key-value pairs for the arguments. For example, a module could be called with a tag like <<:portal.weather day=today city=Bucharest:>>. In this case, the class to be instantiated is portal.weather and the argument string is day=today city=Bucharest. This string will be parsed to obtain the map {day={today}, city={Bucharest}}

Parameters:

s - original argument to the module

Returns:

parsed key-value mapping

getCallingServlet

public final ExtendedServlet getCallingServlet()

This method will return the calling servlet, if it was set. If you need this pointer from a module you must call BasePage.setCallingServlet(ExtendedServlet) otherwise this pointer will be null.

Returns:

the calling servlet