com.dpslink.base.util

Class HtmlTransformer

java.lang.Object

com.dpslink.base.util.HtmlTransformer

All Implemented Interfaces:

java.io.Serializable, org.w3c.tidy.TidyMessageListener

public class HtmlTransformer
extends java.lang.Object
implements java.io.Serializable, org.w3c.tidy.TidyMessageListener

Transforms HTML to XHTML or to XML.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.tidy.Tidy	ivTidy The Tidy parser that will perform transformations.
private static java.lang.String	MSG The formatter for messages logged to the log writer.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
HtmlTransformer() Constructs a new HTML transformer.

Method Summary

Modifier and Type	Method and Description
void	messageReceived(org.w3c.tidy.TidyMessage message) Called by Tidy when a warning or error occurs during transformation.
java.io.ByteArrayOutputStream	toXhtml(java.lang.String html) Transforms HTML to XHTML and returns the results.
java.io.ByteArrayOutputStream	toXhtml(java.lang.String template, org.apache.velocity.VelocityContext data) Transforms HTML to XHTML and returns the results.
java.io.ByteArrayOutputStream	toXml(java.lang.String html) Transforms HTML to XML and returns the results.
java.io.ByteArrayOutputStream	toXml(java.lang.String template, org.apache.velocity.VelocityContext data) Transforms HTML to XML and returns the results.
java.io.ByteArrayOutputStream	toXml2(java.lang.String xml) Transforms XML to XML and returns the results.
java.io.ByteArrayOutputStream	toXml2(java.lang.String template, org.apache.velocity.VelocityContext data) Transforms XML to XML and returns the results.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

MSG

private static final java.lang.String MSG

The formatter for messages logged to the log writer.

See Also:

Constant Field Values

ivTidy

protected org.w3c.tidy.Tidy ivTidy

The Tidy parser that will perform transformations.

Constructor Detail

HtmlTransformer

public HtmlTransformer()

Constructs a new HTML transformer.

Method Detail

toXhtml

public java.io.ByteArrayOutputStream toXhtml(java.lang.String html)
                                      throws java.lang.Exception

Transforms HTML to XHTML and returns the results.

Parameters:

html - (String) The HTML to process.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

toXhtml

public java.io.ByteArrayOutputStream toXhtml(java.lang.String template,
                                             org.apache.velocity.VelocityContext data)
                                      throws java.lang.Exception

Transforms HTML to XHTML and returns the results.

Parameters:

template - (String) The name of the HTML template file to process.

data - (VelocityContext) The data to use for substitutions or null if no data is to be substituted.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

toXml

public java.io.ByteArrayOutputStream toXml(java.lang.String html)
                                    throws java.lang.Exception

Transforms HTML to XML and returns the results.

Parameters:

html - (String) The HTML to process.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

toXml

public java.io.ByteArrayOutputStream toXml(java.lang.String template,
                                           org.apache.velocity.VelocityContext data)
                                    throws java.lang.Exception

Transforms HTML to XML and returns the results.

Parameters:

template - (String) The name of the HTML template file to process.

data - (VelocityContext) The data to use for substitutions or null if no data is to be substituted.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

toXml2

public java.io.ByteArrayOutputStream toXml2(java.lang.String xml)
                                     throws java.lang.Exception

Transforms XML to XML and returns the results.

Parameters:

xml - (String) The XML to process.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

toXml2

public java.io.ByteArrayOutputStream toXml2(java.lang.String template,
                                            org.apache.velocity.VelocityContext data)
                                     throws java.lang.Exception

Transforms XML to XML and returns the results.

Parameters:

template - (String) The name of the XML template file to process.

data - (VelocityContext) The data to use for substitutions or null if no data is to be substituted.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during transformation.

messageReceived

public void messageReceived(org.w3c.tidy.TidyMessage message)

Called by Tidy when a warning or error occurs during transformation.

Specified by:

messageReceived in interface org.w3c.tidy.TidyMessageListener

Parameters:

message - (TidyMessage) A Tidy message.