org.apache.fulcrum.xslt
Interface XSLTService

All Known Implementing Classes:
DefaultXSLTService

public interface XSLTService

The Turbine XSLT Service is used to transform xml with a xsl stylesheet. The service makes use of the Xalan xslt engine available from apache.

Author:
Leon Messerschmidt, Thomas Vandahl

Field Summary
static String ROLE
           
 
Method Summary
 String transform(String xslName, Map params)
          Uses an xsl file without any xml input.
 String transform(String xslName, Node in)
          Uses an xsl file to transform xml input from a DOM note and returns a string containing the transformed output.
 String transform(String xslName, Node in, Map params)
          Uses an xsl file to transform xml input from a DOM note and returns a string containing the transformed output.
 void transform(String xslName, Node in, Writer out)
          Uses an xsl file to transform xml input from a DOM note and writes the output to a writer.
 void transform(String xslName, Node in, Writer out, Map params)
          Uses an xsl file to transform xml input from a DOM note and writes the output to a writer.
 String transform(String xslName, Reader in)
          Uses an xsl file to transform xml input from a reader and returns a string containing the transformed output.
 String transform(String xslName, Reader in, Map params)
          Uses an xsl file to transform xml input from a reader and returns a string containing the transformed output.
 void transform(String xslName, Reader in, Writer out)
          Uses an xsl file to transform xml input from a reader and writes the output to a writer.
 void transform(String xslName, Reader in, Writer out, Map params)
          Uses an xsl file to transform xml input from a reader and writes the output to a writer.
 void transform(String xslName, Writer out, Map params)
          Uses an xsl file without any xml input.
 

Field Detail

ROLE

static final String ROLE
Method Detail

transform

void transform(String xslName,
               Reader in,
               Writer out)
               throws Exception
Uses an xsl file to transform xml input from a reader and writes the output to a writer.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The reader that passes the xml to be transformed
out - The writer for the transformed output
Throws:
Exception - the transformation failed

transform

String transform(String xslName,
                 Reader in)
                 throws Exception
Uses an xsl file to transform xml input from a reader and returns a string containing the transformed output.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The reader that passes the xml to be transformed
Returns:
the transformed output
Throws:
Exception - the transformation failed

transform

void transform(String xslName,
               Node in,
               Writer out)
               throws Exception
Uses an xsl file to transform xml input from a DOM note and writes the output to a writer.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The DOM Node to be transformed
out - The writer for the transformed output
Throws:
Exception - the transformation failed

transform

String transform(String xslName,
                 Node in)
                 throws Exception
Uses an xsl file to transform xml input from a DOM note and returns a string containing the transformed output.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The DOM Node to be transformed
Returns:
the transformed output
Throws:
Exception - the transformation failed

transform

void transform(String xslName,
               Reader in,
               Writer out,
               Map params)
               throws Exception
Uses an xsl file to transform xml input from a reader and writes the output to a writer.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The reader that passes the xml to be transformed
out - The writer for the transformed output
params - A set of parameters that will be forwarded to the XSLT
Throws:
Exception - the transformation failed

transform

String transform(String xslName,
                 Reader in,
                 Map params)
                 throws Exception
Uses an xsl file to transform xml input from a reader and returns a string containing the transformed output.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The reader that passes the xml to be transformed
params - A set of parameters that will be forwarded to the XSLT
Returns:
the transformed output
Throws:
Exception - the transformation failed

transform

void transform(String xslName,
               Node in,
               Writer out,
               Map params)
               throws Exception
Uses an xsl file to transform xml input from a DOM note and writes the output to a writer.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The DOM Node to be transformed
out - The writer for the transformed output
params - A set of parameters that will be forwarded to the XSLT
Throws:
Exception - the transformation failed

transform

String transform(String xslName,
                 Node in,
                 Map params)
                 throws Exception
Uses an xsl file to transform xml input from a DOM note and returns a string containing the transformed output.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
in - The DOM Node to be transformed
params - A set of parameters that will be forwarded to the XSLT
Returns:
the transformed output
Throws:
Exception - the transformation failed

transform

String transform(String xslName,
                 Map params)
                 throws Exception
Uses an xsl file without any xml input.

Parameters:
xslName - The name of the file that contains the xsl stylesheet.
params - A set of parameters that will be forwarded to the XSLT
Returns:
the transformed output
Throws:
Exception - the transformation failed

transform

void transform(String xslName,
               Writer out,
               Map params)
               throws Exception
Uses an xsl file without any xml input.

Parameters:
xslName - The name of the file that contains the xsl stylesheet
out - The writer for the transformed output.
params - A set of parameters that will be forwarded to the XSLT
Throws:
Exception - the transformation failed


Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.