com.dpslink.base.util

Class XmlToPdf

java.lang.Object

com.dpslink.base.util.XmlToPdf

All Implemented Interfaces:

java.io.Serializable

public class XmlToPdf
extends java.lang.Object
implements java.io.Serializable

Translates an XML document into a PDF document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XmlToPdf.PdfHeaderFooter Inner class that adds a header and a footer to PDF document pages.
static class	XmlToPdf.RomanNumber Inner class that provides conversion of decimal integers to roman numerals.
protected class	XmlToPdf.XmlCell Inner class that defines a table cell node in the XML document and handles translation of the XML table cell to a PDF table cell.
protected class	XmlToPdf.XmlPage Inner class that defines a page node in the XML document and handles translation of the XML page to a PDF page.
protected class	XmlToPdf.XmlTable Inner class that defines a table node in the XML document and handles translation of the XML table to a PDF table.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ALIGN_CENTER The value for center aligning content.
protected static int	ALIGN_LEFT The value for left aligning content.
protected static int	ALIGN_RIGHT The value for right aligning content.
protected static java.lang.String	FMT_FOOT The formatter for page footer information.
protected static com.itextpdf.text.Font	FONT_BOLD The font for bold text.
protected static com.itextpdf.text.Font	FONT_CVR_BOLD The font for cover page bold text.
protected static com.itextpdf.text.Font	FONT_CVR_NORM The font for cover page normal text.
protected static com.itextpdf.text.Font	FONT_DATA The font for data text.
protected static com.itextpdf.text.Font	FONT_FOOT The font for footer text.
protected static com.itextpdf.text.Font	FONT_HEAD The font for header text.
protected static com.itextpdf.text.Font	FONT_HIDE The font for hidden text.
protected static com.itextpdf.text.Font	FONT_NORM The font for normal text.
protected static com.itextpdf.text.Font	FONT_TOC_CHAPTER The font for table of contents bold text.
protected static com.itextpdf.text.Font	FONT_TOC_SECTION The font for table of contents normal text.
protected java.util.ArrayList<com.itextpdf.text.Chapter>	ivChapters A collection of all chapters for the PDF document.
protected java.util.LinkedHashMap<com.itextpdf.text.Chunk,java.lang.Integer>	ivLinks A collection of links to the chapters and sections in the PDF document.
protected com.itextpdf.text.Document	ivPdfDoc The PDF document object.
protected org.w3c.dom.Document	ivXmlDoc The XML document object.
private static long	serialVersionUID The class' serialization version id.
protected static com.itextpdf.text.BaseColor	TBLBORDER The border color for gridlist tables.
protected static com.itextpdf.text.BaseColor	TBLHEADBG The background color for gridlist table headings.

Constructor Summary

Constructors

Constructor and Description
XmlToPdf() Constructs a new XML-to-PDF translator.

Method Summary

Modifier and Type	Method and Description
protected void	createTOC() Creates a table of contents based on chapter and section links created while the PDF document was being created.
java.io.ByteArrayOutputStream	getPdfStream(java.lang.String xml) Performs XML-to-PDF translation and returns the results.
java.io.ByteArrayOutputStream	getPdfStream(java.lang.String template, org.apache.velocity.VelocityContext data) Performs HTML-to-PDF translation and returns the results.
protected java.io.ByteArrayOutputStream	moveTOC(java.io.ByteArrayOutputStream pdf, int[] pagenums) Moves a table of contents from the end of the PDF document to the beginning of the document, starting at the first page following the cover page, if one exists.
protected void	recurseXml(org.w3c.dom.NodeList children) Recurses the XML document and creates the PDF document's content.
protected java.io.ByteArrayOutputStream	translate(java.lang.String xml) Performs XML-to-PDF translation and returns the results.
void	writeToResponse(java.io.ByteArrayOutputStream pdf, javax.servlet.http.HttpServletResponse response) Writes a PDF document to a servlet's outgoing response.

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

FONT_CVR_BOLD

protected static final com.itextpdf.text.Font FONT_CVR_BOLD

The font for cover page bold text.

FONT_CVR_NORM

protected static final com.itextpdf.text.Font FONT_CVR_NORM

The font for cover page normal text.

FONT_TOC_CHAPTER

protected static final com.itextpdf.text.Font FONT_TOC_CHAPTER

The font for table of contents bold text.

FONT_TOC_SECTION

protected static final com.itextpdf.text.Font FONT_TOC_SECTION

The font for table of contents normal text.

FONT_BOLD

protected static final com.itextpdf.text.Font FONT_BOLD

The font for bold text.

FONT_NORM

protected static final com.itextpdf.text.Font FONT_NORM

The font for normal text.

FONT_HEAD

protected static final com.itextpdf.text.Font FONT_HEAD

The font for header text.

FONT_DATA

protected static final com.itextpdf.text.Font FONT_DATA

The font for data text.

FONT_FOOT

protected static final com.itextpdf.text.Font FONT_FOOT

The font for footer text.

FONT_HIDE

protected static final com.itextpdf.text.Font FONT_HIDE

The font for hidden text.

TBLBORDER

protected static final com.itextpdf.text.BaseColor TBLBORDER

The border color for gridlist tables.

TBLHEADBG

protected static final com.itextpdf.text.BaseColor TBLHEADBG

The background color for gridlist table headings.

ALIGN_LEFT

protected static final int ALIGN_LEFT

The value for left aligning content.

See Also:

Constant Field Values

ALIGN_CENTER

protected static final int ALIGN_CENTER

The value for center aligning content.

See Also:

Constant Field Values

ALIGN_RIGHT

protected static final int ALIGN_RIGHT

The value for right aligning content.

See Also:

Constant Field Values

FMT_FOOT

protected static final java.lang.String FMT_FOOT

The formatter for page footer information.

See Also:

Constant Field Values

ivPdfDoc

protected com.itextpdf.text.Document ivPdfDoc

The PDF document object.

ivXmlDoc

protected org.w3c.dom.Document ivXmlDoc

The XML document object.

ivChapters

protected java.util.ArrayList<com.itextpdf.text.Chapter> ivChapters

A collection of all chapters for the PDF document.

ivLinks

protected java.util.LinkedHashMap<com.itextpdf.text.Chunk,java.lang.Integer> ivLinks

A collection of links to the chapters and sections in the PDF document.

Constructor Detail

XmlToPdf

public XmlToPdf()

Constructs a new XML-to-PDF translator.

Method Detail

getPdfStream

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

Performs XML-to-PDF translation 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 translation.

getPdfStream

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

Performs HTML-to-PDF translation 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 translation.

translate

protected java.io.ByteArrayOutputStream translate(java.lang.String xml)
                                           throws java.lang.Exception

Performs XML-to-PDF translation and returns the results.

Parameters:

xml - (ByteArrayOutputStream) The XML to process.

Returns:

ByteArrayOutputStream - The processed results.

Throws:

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

createTOC

protected void createTOC()
                  throws java.lang.Exception

Creates a table of contents based on chapter and section links created while the PDF document was being created.

Throws:

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

moveTOC

protected java.io.ByteArrayOutputStream moveTOC(java.io.ByteArrayOutputStream pdf,
                                                int[] pagenums)
                                         throws java.lang.Exception

Moves a table of contents from the end of the PDF document to the beginning of the document, starting at the first page following the cover page, if one exists. Also moves the PDF document's table of contents bookmark to the appropriate place within the document's bookmarks.

Parameters:

pdf - (ByteArrayOutputStream) The PDF document to process.

pagenums - (int[]) The documents various page numbers as returned by PdfHeaderFooter.getPageNumbers.

Returns:

ByteArrayOutputStream - A modified PDF document.

Throws:

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

recurseXml

protected void recurseXml(org.w3c.dom.NodeList children)
                   throws java.lang.Exception

Recurses the XML document and creates the PDF document's content.

Parameters:

children - (NodeList) The first-level child nodes of the XML document's root.

Throws:

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

writeToResponse

public void writeToResponse(java.io.ByteArrayOutputStream pdf,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception

Writes a PDF document to a servlet's outgoing response.

Parameters:

pdf - (ByteArrayOutputStream) The PDF document to write.

response - (HttpServletResponse) The servlet response to write to.

Throws:

java.lang.Exception - - if an error occurs during the writing.