org.mmbase.module

Class XSLConvert

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.util.functions.DescribedFunctionProvider

org.mmbase.module.Module

org.mmbase.module.ProcessorModule

org.mmbase.module.XSLConvert

All Implemented Interfaces:

Descriptor

public class XSLConvert
extends ProcessorModule

XSL conversion module Right now, only the replace() method is defined. It is called as: $MOD-XSLCONVERT-xmlPath-xslFile where xmlPath is the path relative to mmbase.config and xslFile is and xsl file located in the subdirectory xslt of mmbase.config.

Version:

$Id$

Author:

Case Roole, cjr@dds.nl

Application:

XSL or Tools

Move:

org.mmbase.util.xml

Nested Class Summary

Nested classes/interfaces inherited from class org.mmbase.module.ProcessorModule

ProcessorModule.GetNodeListFunction, ProcessorModule.ProcessFunction, ProcessorModule.ReplaceFunction

Field Summary

Fields inherited from class org.mmbase.module.ProcessorModule

PARAM_PAGEINFO, PARAMS_PAGEINFO

Fields inherited from class org.mmbase.module.Module

configurationPath, getMaintainerFunction, getVersionFunction, properties, STATE_START_TIME

Fields inherited from class org.mmbase.util.functions.DescribedFunctionProvider

description, guiName, name

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions, getFunctions

Constructor Summary

Constructors

Constructor and Description
XSLConvert(String name)

Method Summary

Modifier and Type	Method and Description
String	getModuleInfo() Provide some info on the module; By default, this returns the module description for the default locale
void	init() Initializes the module.
String	replace(PageInfo sp, String cmds) Handle a $MOD command It is called as: $MOD-XSLCONVERT-xmlPath-xslFile where: - xmlPath is the path relative to mmbase.config and, - xslFile is xsl file located in the subdirectory xslt of mmbase.config.
String	transform(String xmlPath, String xslPath) Transform XML file using an XSL file

Methods inherited from class org.mmbase.module.ProcessorModule

getList, getListBuilder, getNodeList, onload, process, reload, replace, unload

Methods inherited from class org.mmbase.module.Module

addInitParameters, getInitParameter, getInitParameter, getInitParameter, getInitParameters, getInitParameters, getMaintainer, getModule, getModule, getModule, getModule, getModuleLoader, getModuleReader, getModuleReader, getModules, getState, getStates, getVersion, hasModule, hasStarted, loadInitParameters, loadInitParameters, maintainance, setInitParameter, setMaintainer, setState, setVersion, shutdown, shutdownModules, startModule, startModules

Methods inherited from class org.mmbase.util.functions.DescribedFunctionProvider

getDefaultLocale, getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, getName, setDescription, setDescription, setGUIName, setGUIName, setLocalizedDescription, setLocalizedGUIName, setName

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue, newFunctionInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

XSLConvert

public XSLConvert(String name)

Method Detail

init

public void init()

Description copied from class: ProcessorModule

Initializes the module. Init must be overridden to read the environment variables it needs.
This method is called by Module.startModule(), which makes sure it is not called more than once. You should not call init() directly, call startModule() instead.

Overrides:

init in class ProcessorModule

replace

public String replace(PageInfo sp,
                      String cmds)

Handle a $MOD command It is called as: $MOD-XSLCONVERT-xmlPath-xslFile where: - xmlPath is the path relative to mmbase.config and, - xslFile is xsl file located in the subdirectory xslt of mmbase.config.

Overrides:

replace in class ProcessorModule

transform

public String transform(String xmlPath,
                        String xslPath)

Transform XML file using an XSL file

Parameters:

xmlPath - Path to XML file

xslPath - Path to XSL file

Returns:

Converted document

getModuleInfo

public String getModuleInfo()

Description copied from class: Module

Provide some info on the module; By default, this returns the module description for the default locale

Overrides:

getModuleInfo in class Module