com.filenet.rm.api.util

Class RMXSLUtil

  • java.lang.Object
    • com.filenet.rm.api.util.RMXSLUtil


  • public class RMXSLUtil
    extends java.lang.Object
    The RMXSLUtil class is the base class that performs operations related to the XSL transformation.
    • Constructor Summary

      Constructors 
      Constructor and Description
      RMXSLUtil() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object getXML()
      Returns the source XML file in the format that was orignially set in the setXML() method.
      java.lang.Object getXSLParameter(java.lang.String asKey)
      Returns previously set XSL Parameter.
      void setXML(org.w3c.dom.Document aoDocument)
      This method sets the value of member variable sourceXML equal to the Document object passed as input parameter
      void setXSL(java.lang.String asXSLFile)
      Sets the value of the pathToXSL member variable to the value passed in the input parameter.
      void setXSLContent(java.lang.String asXSLContent)
      Sets the value of the pathToXSL member variable to the value of the TempFile.
      void setXSLParameter(java.lang.String asKey, java.lang.Object aoValue)
      Creates an entry for key and value pair specified as input parameters in member variable parameters of type Map.
      org.w3c.dom.Document transformToDom()
      Writes the results of transformation (as specified in the XSL file) to XML DOM
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RMXSLUtil

        public RMXSLUtil()
    • Method Detail

      • getXML

        public final java.lang.Object getXML()
        Returns the source XML file in the format that was orignially set in the setXML() method.
        Returns:
        An object with the source XML.
      • setXSL

        public final void setXSL(java.lang.String asXSLFile)
        Sets the value of the pathToXSL member variable to the value passed in the input parameter.
        Parameters:
        asXSLFile - A string variable that specifies the path of an XSL file.
      • setXSLContent

        public final void setXSLContent(java.lang.String asXSLContent)
                                 throws RMException
        Sets the value of the pathToXSL member variable to the value of the TempFile. TempFile contains the content as specified by the asXSLContent parameter.
        Parameters:
        asXSLContent - A string variable that specifies the content of an XSL file.
        Throws:
        RMException
      • setXML

        public final void setXML(org.w3c.dom.Document aoDocument)
        This method sets the value of member variable sourceXML equal to the Document object passed as input parameter
        Parameters:
        aoDocument - Source XML in DOM Document
      • transformToDom

        public org.w3c.dom.Document transformToDom()
                                            throws RMException
        Writes the results of transformation (as specified in the XSL file) to XML DOM
        Returns:
        The result is the XML DOM Document object generated after the transformation
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • setXSLParameter

        public final void setXSLParameter(java.lang.String asKey,
                           java.lang.Object aoValue)
                                   throws RMException
        Creates an entry for key and value pair specified as input parameters in member variable parameters of type Map. The elements of the Map will be visible as a parameter during the XSL transformation.
        Parameters:
        asKey - Specifies the key value for the Map entry
        aoValue - Specifies the object value for the above key
        Throws:
        RMException - In case of any error an RMException will be thrown.
      • getXSLParameter

        public final java.lang.Object getXSLParameter(java.lang.String asKey)
        Returns previously set XSL Parameter.
        Parameters:
        asKey - parameter name
        Returns:
        Object with the parameter value

© Copyright IBM Corp. 2003, 2013. All Rights Reserved.