org.directwebremoting.servlet
Class BaseModule

java.lang.Object
  extended by org.directwebremoting.servlet.BaseModule
Direct Known Subclasses:
AmdModule, DojoModule

public class BaseModule
extends java.lang.Object

A base class for script modules.

Author:
Mike Wilson [mikewse at hotmail dot com]

Constructor Summary
BaseModule(java.lang.String contextPath, java.lang.String servletPath, java.lang.String separator)
          Constructor.
 
Method Summary
 void addContent(java.lang.String content)
          Adds the actual module content (script body).
 java.lang.String expandModulePath(java.lang.String baseModulePath)
          Expands ${contextPath} and ${servletPath} variables in the baseModulePath.
 java.lang.String expandModulePath(java.lang.String baseModulePath, java.lang.String moduleName)
          Mounts a moduleName onto a baseModulePath and at the same time expanding ${contextPath} and ${servletPath} variables in the baseModulePath.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseModule

public BaseModule(java.lang.String contextPath,
                  java.lang.String servletPath,
                  java.lang.String separator)
Constructor. Path parameters are supplied for expanding path variables in module paths.

Parameters:
contextPath -
servletPath -
separator -
Method Detail

addContent

public void addContent(java.lang.String content)
Adds the actual module content (script body).

Parameters:
content -

expandModulePath

public java.lang.String expandModulePath(java.lang.String baseModulePath)
Expands ${contextPath} and ${servletPath} variables in the baseModulePath.

Parameters:
baseModulePath -
Returns:
module path

expandModulePath

public java.lang.String expandModulePath(java.lang.String baseModulePath,
                                         java.lang.String moduleName)
Mounts a moduleName onto a baseModulePath and at the same time expanding ${contextPath} and ${servletPath} variables in the baseModulePath. The module path segments in the resulting module name will be separated with the configured separator (typically / or .).

Parameters:
baseModulePath -
moduleName -
Returns:
module name rooted on baseModulePath

Copyright ยจ 2008