com.knowgate.xhtml

Class StylesheetCache

java.lang.Object

com.knowgate.xhtml.StylesheetCache

public class StylesheetCache
extends Object

XSL File Cache This class keeps a master copy in memory of each XSL Stylesheet file.
When a Transformer object is requested a copy of the master Stylesheet is done. This is faster than re-loading the XSL file from disk.
StylesheetCache is a WeakHashMap so cached stylesheets can be automatically garbage collected is memory runs low.

Version:

7.0

Author:

Sergio Montoro Ten

Method Summary

Modifier and Type	Method and Description
static void	clearCache() Clear XLS Stylesheets cache
static Transformer	newTransformer(String sFilePath) Get Transformer object for XSL file.
static void	setParameters(Transformer oXSL, Properties oProps) Set parameters for a StyleSheet taken from a properties collection.
static String	transform(InputStream oStyleSheetStream, InputStream oXMLInputStream, String sEncoding, Properties oProps) Perform XSLT transformation
static String	transform(InputStream oStyleSheetStream, String sXMLInput, Properties oProps) Perform XSLT transformation
static void	transform(String sStyleSheetPath, InputStream oXMLInputStream, OutputStream oOutputStream, Properties oProps) Perform XSLT transformation
static String	transform(String sStyleSheetPath, String sXMLInput, Properties oProps) Perform XSLT transformation
String	validate(InputStream oXsd, InputStream oXml) Validate an XML document using an XSD schema

Methods inherited from class java.lang.Object

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

Method Detail

newTransformer

public static Transformer newTransformer(String sFilePath)
                                  throws FileNotFoundException,
                                         IOException,
                                         TransformerException,
                                         TransformerConfigurationException

Get Transformer object for XSL file. StylesheetCache automatically checks file last modification date and compares it with loading date for cached objects. If file is more recent than its cached object then the disk copy is reloaded.

Parameters:

sFilePath - File Path

Throws:

IOException

TransformerException

TransformerConfigurationException

FileNotFoundException

setParameters

public static void setParameters(Transformer oXSL,
                                 Properties oProps)
                          throws NullPointerException

Set parameters for a StyleSheet taken from a properties collection. This method is primarily designed for setting environment parameters.

Parameters:

oXSL - Transformer object.

oProps - Properties to be set as parameters. The substring "param_" will be added as a preffix to each property name passed as parameter. So if you pass a property named "workarea" it must be retrieved from XSL as <xsl:param name="param_workarea"/>

Throws:

NullPointerException - if oXSL is null or oProps is null

transform

public static void transform(String sStyleSheetPath,
                             InputStream oXMLInputStream,
                             OutputStream oOutputStream,
                             Properties oProps)
                      throws IOException,
                             FileNotFoundException,
                             NullPointerException,
                             TransformerException,
                             TransformerConfigurationException

Perform XSLT transformation

Parameters:

sStyleSheetPath - File Path to XSL style sheet file

oXMLInputStream - Input Stream for XML source data

oOutputStream - Stream where output is to be written

oProps - Parameters for Transformer. The substring "param_" will be added as a prefix to each property name passed as parameter. So if you pass a property named "workarea" it must be retrieved from XSL as <xsl:param name="param_workarea"/>

Throws:

NullPointerException - if oProps is null

FileNotFoundException - if sStyleSheetPath does not exist

IOException

TransformerException

TransformerConfigurationException

transform

public static String transform(String sStyleSheetPath,
                               String sXMLInput,
                               Properties oProps)
                        throws IOException,
                               FileNotFoundException,
                               UnsupportedEncodingException,
                               NullPointerException,
                               TransformerException,
                               TransformerConfigurationException

Perform XSLT transformation

Parameters:

sStyleSheetPath - File Path to XSL style sheet file

sXMLInput - Input String with XML source data

oProps - Parameters for Transformer. The substring "param_" will be added as a preffix to each property name passed as parameter. So if you pass a property named "workarea" it must be retrieved from XSL as <xsl:param name="param_workarea"/>

Returns:

String Transformed document

Throws:

NullPointerException - if sXMLInput or oProps are null

FileNotFoundException - if sStyleSheetPath does not exist

IOException

UnsupportedEncodingException

TransformerException

TransformerConfigurationException

Since:

3.0

transform

public static String transform(InputStream oStyleSheetStream,
                               InputStream oXMLInputStream,
                               String sEncoding,
                               Properties oProps)
                        throws IOException,
                               FileNotFoundException,
                               UnsupportedEncodingException,
                               NullPointerException,
                               TransformerException,
                               TransformerConfigurationException

Perform XSLT transformation

Parameters:

oStyleSheetStream - Stream to XSL style sheet

oXMLInputStream - Input Stream with XML source data

sEncoding - Input Stream data encoding

oProps - Parameters for Transformer. The substring "param_" will be added as a preffix to each property name passed as parameter. So if you pass a property named "workarea" it must be retrieved from XSL as <xsl:param name="param_workarea"/>

Returns:

String Transformed document

Throws:

NullPointerException - if sXMLInput or oProps are null

FileNotFoundException - if sStyleSheetPath does not exist

IOException

UnsupportedEncodingException

TransformerException

TransformerConfigurationException

Since:

6.0

transform

public static String transform(InputStream oStyleSheetStream,
                               String sXMLInput,
                               Properties oProps)
                        throws IOException,
                               FileNotFoundException,
                               UnsupportedEncodingException,
                               NullPointerException,
                               TransformerException,
                               TransformerConfigurationException

Perform XSLT transformation

Parameters:

oStyleSheetStream - Stream to XSL style sheet

sXMLInput - Input String with XML source data

oProps - Parameters for Transformer. The substring "param_" will be added as a preffix to each property name passed as parameter. So if you pass a property named "workarea" it must be retrieved from XSL as <xsl:param name="param_workarea"/>

Returns:

String Transformed document

Throws:

NullPointerException - if sXMLInput or oProps are null

FileNotFoundException - if sStyleSheetPath does not exist

IOException

UnsupportedEncodingException

TransformerException

TransformerConfigurationException

Since:

5.0

validate

public String validate(InputStream oXsd,
                       InputStream oXml)

Validate an XML document using an XSD schema

Parameters:

oXsd - InputStream to XSD schema

oXml - InputStream to XML document

Returns:

String An empty string if validation was successful or text describing the error found

Since:

7.0

clearCache

public static void clearCache()

Clear XLS Stylesheets cache

Since:

7.0