com.filenet.wcm.toolkit.server.ui
Class WcmXSLModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmXSLModule
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface

public class WcmXSLModule
extends WcmUiModule

Base class for UI Modules that do XSLT transformations.


Field Summary
protected  WcmXSLUtil transformUtil
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmXSLModule()
           
 
Method Summary
static org.w3c.dom.NodeList convertToNodeList(java.lang.String[] valuesArray)
          Converts String array into a NodeList with text nodes.
 java.lang.Object getXML()
          Returns the source XML in the format it was orignially set in setXML() method.
 java.lang.Object getXSLParameter(java.lang.String key)
          Returns previously set XSL Parameter.
 void render(java.io.Writer w)
          Writes out the results of the transformation.
 void renderXSL(java.io.Writer w)
          Writes out the results of the transformation.
 void setXML(org.w3c.dom.Document domDocument)
          Sets the source XML as Document.
 void setXML(java.io.InputStream inputStream)
          Sets the source XML as InputStream
 void setXML(java.io.Reader reader)
          Sets the source XML as Reader
 void setXML(java.lang.String xmlString)
          Sets the source XML as String.
 void setXSL(java.lang.String sXSLFile)
          Sets the XSL File to use for the transformation.
 void setXSLParameter(java.lang.String key, boolean flag)
          Sets XSL Parameter as boolean.
 void setXSLParameter(java.lang.String key, double number)
          Sets XSL Parameter as double.
 void setXSLParameter(java.lang.String key, org.w3c.dom.Node node)
          Sets XSL Parameter as Node.
 void setXSLParameter(java.lang.String key, org.w3c.dom.NodeList nodes)
          Sets XSL Parameter as NodeList.
 void setXSLParameter(java.lang.String key, java.lang.Object obj)
          Sets XSL Parameter as Object.
 void setXSLParameter(java.lang.String key, java.lang.String str)
          Sets XSL Parameter as String.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

transformUtil

protected WcmXSLUtil transformUtil
Constructor Detail

WcmXSLModule

public WcmXSLModule()
Method Detail

getXML

public java.lang.Object getXML()
Returns the source XML in the format it was orignially set in setXML() method.

Returns:
Object with the source XML

setXSL

public void setXSL(java.lang.String sXSLFile)
            throws java.lang.Exception
Sets the XSL File to use for the transformation. It must be located under APP_ROOT/WEB-INF/xsl/ folder. Use File.separator constant for the slashes in file names.

Parameters:
sXSLFile - XSL File name
Throws:
java.lang.Exception - If any errors occur.

setXML

public void setXML(java.lang.String xmlString)
Sets the source XML as String.

Parameters:
xmlString - Source XML in a String

setXML

public void setXML(org.w3c.dom.Document domDocument)
Sets the source XML as Document.

Parameters:
domDocument - Source XML in DOM Document

setXML

public void setXML(java.io.InputStream inputStream)
Sets the source XML as InputStream

Parameters:
inputStream - InputStream object with the source XML

setXML

public void setXML(java.io.Reader reader)
Sets the source XML as Reader

Parameters:
reader - Reader object with the source XML

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Writes out the results of the transformation.

Specified by:
render in interface WcmUiModuleInterface
Overrides:
render in class WcmUiModule
Parameters:
w - Writer object where the results will be written
Throws:
java.lang.Exception - If there are any errors in the transformation

renderXSL

public void renderXSL(java.io.Writer w)
               throws java.lang.Exception
Writes out the results of the transformation.

Parameters:
w - Writer object where the results will be written
Throws:
java.lang.Exception - If there are any errors in the transformation

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            java.lang.String str)
Sets XSL Parameter as String.

Parameters:
key - Key
str - String value

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            boolean flag)
Sets XSL Parameter as boolean.

Parameters:
key - Key
flag - boolean value

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            double number)
Sets XSL Parameter as double.

Parameters:
key - Key
number - Double value

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            org.w3c.dom.NodeList nodes)
Sets XSL Parameter as NodeList.

Parameters:
key - Key
nodes - NodeList value

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            org.w3c.dom.Node node)
Sets XSL Parameter as Node.

Parameters:
key - Key
node - Node value

setXSLParameter

public void setXSLParameter(java.lang.String key,
                            java.lang.Object obj)
Sets XSL Parameter as Object.

Parameters:
key - Key
obj - Object value

getXSLParameter

public java.lang.Object getXSLParameter(java.lang.String key)
Returns previously set XSL Parameter.

Parameters:
key - parameter name
Returns:
XObject with the parameter value

convertToNodeList

public static org.w3c.dom.NodeList convertToNodeList(java.lang.String[] valuesArray)
Converts String array into a NodeList with text nodes.

Parameters:
valuesArray - A string array to be converted
Returns:
NodeList of text nodes containing the values of the String array


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.