net.windward.xmlreport

Class ProcessPdf

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessPdf

All Implemented Interfaces:

ProcessPdfAPI, ProcessReportAPI, ProcessReportAPIBase

public class ProcessPdf
extends ProcessReport
implements ProcessPdfAPI

This class is the main program that takes a template stream and a datasource and merges them to create a pdf report stream. The way to use this is to construct a ProcessPdf object, set any options (presently none), then call process.
The calling method must close all streams after calling process. process will flush the output (report) stream before returning. If you wish to sign a pdf file using a Verisign certificate, please go to http://itextpdf.sourceforge.net/howtosign.html

Version:

2.0 2 January 2004

Nested Class Summary

Nested classes/interfaces inherited from class net.windward.xmlreport.ProcessReport

ProcessReport.CleanDatasource, ProcessReport.DrillDownTemplate, ProcessReport.PhoneHomeStats

Field Summary

Fields inherited from class net.windward.xmlreport.ProcessReport

NUM_HOURS_BETWEEN_LICENSE_CHECK_INS, NUM_HOURS_BETWEEN_LICENSE_CHECK_INS_PREV_FAILED, TEMPLATE_TYPE_DOCM, TEMPLATE_TYPE_DOCX, TEMPLATE_TYPE_HTML, TEMPLATE_TYPE_PPTM, TEMPLATE_TYPE_PPTX, TEMPLATE_TYPE_UNKNOWN, TEMPLATE_TYPE_XLSM, TEMPLATE_TYPE_XLSX

Fields inherited from interface net.windward.xmlreport.ProcessPdfAPI

ALLOW_ALL, ALLOW_ASSEMBLY, ALLOW_COPY, ALLOW_DEGRADED_PRINTING, ALLOW_FILL_IN, ALLOW_MOD_ANNOTATIONS, ALLOW_MOD_CONTENTS, ALLOW_NONE, ALLOW_PRINTING, ALLOW_SCREEN_READERS, COMP_FAST, COMP_MAX, COMP_NONE, FONT_EMBEDED, FONT_INTERNAL, FONT_NO_EMBED, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_5, VERSION_1_6, VERSION_1_7

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_ONLY, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, MODE_PROCESS_EMBEDDED_ALWAYS, MODE_PROCESS_EMBEDDED_COPY, MODE_PROCESS_EMBEDDED_DROP, MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED, MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_EVERYTHING, RENDER_EXTENT_CROP_HEADER_AND_FOOTER, RENDER_EXTENT_CROP_MARGINS, RENDER_EXTENT_CROP_TO_CONTENT, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Constructor Summary

Constructors

Constructor and Description
ProcessPdf(java.io.InputStream template) Create a ProcessPdf object with the passed in template.
ProcessPdf(java.io.InputStream xmlData, java.io.InputStream template, java.io.OutputStream report) Create a ProcessPdf object with the passed in template & data streams, writing it to the passed in report stream.
ProcessPdf(java.io.InputStream template, java.io.OutputStream report) Create a ProcessPdf object with the passed in template, writing it to the passed in report stream.

Method Summary

Modifier and Type	Method and Description
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Creates and returns a copy of this object.
int	getCompressionLevel() Get the compression level.
net.windward.document.Document	getDocument() Gets the current document
int	getFontLevel() Get the font level.
int	getKeyLength() Get the password licenseKey length.
java.lang.String	getOwnerPassword() Get the owner password for the report.
java.lang.String	getPdfVersion() Gets the PDF version number used to create the file.
int	getReportType() Get the report format of the output stream.
java.lang.String	getReportTypeString() Get the report format of the output as a string.
int	getSecurity() Get the security for the created pdf report.
java.lang.String	getUserPassword() Get the user password for the report.
boolean	isPageBasedReport() true if the generated report is page based.
boolean	isPdfA() true if build a PDF/A-1b file.
static void	loadFonts(int fontLevel)
void	setCompressionLevel(int level) Set the compression level.
void	setFontLevel(int level) Set the font level.
void	setKeyLength(int len) Set the password licenseKey length.
void	setOwnerPassword(java.lang.String password) Set the owner password for the report.
void	setPdfA(boolean pdfaMode) true if build a PDF/A-1b file.
void	setPdfVersion(java.lang.String version) Gets the PDF version number used to create the file.
void	setSecurity(int mode) Set the security for the created pdf report.
void	setUserPassword(java.lang.String password) Set the user password for the report.

Methods inherited from class net.windward.xmlreport.ProcessReport

abort, addImportInfo, adjustFontName, adjustFontSize, applyLicenseKey, batchNext, batchSetup, buildSchema, checkTimeout, clean, clean, clean, cleanSelects, cleanSelects, close, findPodsUsed, getBaseDirectory, getCharset, getChartProvider, getChartRenderType, getCompany, getCopyMetadata, getDataMode, getDataStream, getDataWriter, getDebugHandler, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getMaxReportPages, getModeProcessEmbedded, getNumPages, getOutputBuilder, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getSubject, getTagTree, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateTypeString, getTemplateVersion, getTimeout, getTitle, getVersion, getVersionMajor, getVersionMinor, getVersionRelease, getWriteTags, hasDatasourcesApplied, hasProcessedTags, init, isDebugMode, isIgnoreTags, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeDocx, isReportTypeExcel, isReportTypeOpenXml, isReportTypePpt, isReportTypeWord, isSameOpenXml, isTemplateTypeDOCX, isTemplateTypeEqualsReportType, isTemplateTypeOpenXml, isTemplateTypePPTX, isTemplateTypeXLSX, isTrackImports, isUseExternalOutputBuilder, loadTemplate, mergePodItemStyles, performLayout, process, processComplete, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugHandler, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setIgnoreTags, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, shutdown, statBanner, statLine

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getModeProcessEmbedded, getNumPages, getOutputBuilder, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, hasProcessedTags, isDebugMode, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags

Constructor Detail

ProcessPdf

public ProcessPdf(java.io.InputStream template)
           throws LicenseException,
                  SetupException

Create a ProcessPdf object with the passed in template. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the pdf format.

Parameters:

template - The report template.

Throws:

LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.

SetupException

ProcessPdf

public ProcessPdf(java.io.InputStream template,
                  java.io.OutputStream report)
           throws LicenseException,
                  SetupException

Create a ProcessPdf object with the passed in template, writing it to the passed in report stream. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the pdf format.

Parameters:

template - The report template.

report - The stream to write the report to.

Throws:

LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.

SetupException

ProcessPdf

public ProcessPdf(java.io.InputStream xmlData,
                  java.io.InputStream template,
                  java.io.OutputStream report)
           throws DataConnectionException,
                  LicenseException,
                  SetupException

Create a ProcessPdf object with the passed in template & data streams, writing it to the passed in report stream. The report will be in the pdf format.

Parameters:

xmlData - The xml data that will be placed into the report where there are xml elements.

template - The report template.

report - The stream to write the report to.

Throws:

DataConnectionException - thrown if there is a problem with the datasource.

LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.

SetupException

Method Detail

duplicate

public ProcessReportAPIBase duplicate(java.io.OutputStream out)
                               throws AlreadyProcessedException,
                                      LicenseException,
                                      SetupException

Creates and returns a copy of this object. You may call this before or after calling processData(). You may then call processData() on the created object. You must call this after calling processSetup() and before calling processComplete(). While this mostly does a deep copy, it does not do a deep copy of image data. This will always return a ProcessPdf object.

Specified by:

duplicate in interface ProcessReportAPIBase

Parameters:

out - The stream to write the report to. If null will create a ByteArrayOutputStream.

Returns:

A duplicated report object.

Throws:

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

LicenseException - thrown if the license licenseKey check fails. The message will list the license check that failed.

SetupException

loadFonts

public static void loadFonts(int fontLevel)

getReportType

public int getReportType()

Get the report format of the output stream.

Specified by:

getReportType in interface ProcessPdfAPI

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

The type (format) of the output report. Will be TYP_PDF.

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Specified by:

getReportTypeString in interface ProcessReportAPIBase

Returns:

"pdf"

isPageBasedReport

public boolean isPageBasedReport()

true if the generated report is page based. PDF & printer output.

Specified by:

isPageBasedReport in interface ProcessReportAPIBase

Overrides:

isPageBasedReport in class ProcessReport

Returns:

true if the generated report is page based.

setFontLevel

public void setFontLevel(int level)

Set the font level. Basically a higher font level means a more accurate final pdf file - but also a large one. The choices are:

• 0 - Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts.
• 1 - (default) Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file.
• 2 - Will use the font specified in the template and will embed the font in the final pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger.

Specified by:

setFontLevel in interface ProcessPdfAPI

Parameters:

level - The font level. Can be 0 - 2.

getFontLevel

public int getFontLevel()

Get the font level. Basically a higher font level means a more accurate final pdf file - but also a large one. The choices are:

• 0 - Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts.
• 1 - Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file.
• 2 - Will use the font specified in the template and will embed the font in the final pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger.

Specified by:

getFontLevel in interface ProcessPdfAPI

Returns:

The font level. Will be 0 - 2.

setCompressionLevel

public void setCompressionLevel(int level)

Set the compression level. Basically a higher compression level means a smaller final pdf file - but also a longer processing time. The choices are:

• 0 - No compression. Fine for small files and where bandwidth is not an issue and processing time is.
• 1 - (default) Fast compression. Will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size.
• 2 - Maximum compression. Will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file. Best for situations where bandwidth is a major issue.

Specified by:

setCompressionLevel in interface ProcessPdfAPI

Parameters:

level - The compression level. Can be 0 - 2.

getCompressionLevel

public int getCompressionLevel()

Get the compression level. Basically a higher compression level means a smaller final pdf file - but also a longer processing time. The choices are:

• 0 - No compression. Fine for small files and where bandwidth is not an issue and processing time is.
• 1 - (default) Fast compression. Will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size.
• 2 - Maximum compression. Will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file. Best for situations where bandwidth is a major issue.

Specified by:

getCompressionLevel in interface ProcessPdfAPI

Returns:

The compression level. Will be 0 - 2.

setOwnerPassword

public void setOwnerPassword(java.lang.String password)

Set the owner password for the report. Set to "" for no password. If this is not set and UserPassword or Security are set - then a random OwnerPassword sill be created.

Specified by:

setOwnerPassword in interface ProcessPdfAPI

Parameters:

password - The new owner password.

getOwnerPassword

public java.lang.String getOwnerPassword()

Get the owner password for the report. Is "" for no password.

Specified by:

getOwnerPassword in interface ProcessPdfAPI

Returns:

The owner password. "" if no password.

setUserPassword

public void setUserPassword(java.lang.String password)

Set the user password for the report. Set to "" for no password. There is purposely no getUserPassword call.

Specified by:

setUserPassword in interface ProcessPdfAPI

Parameters:

password - The new user password.

getUserPassword

public java.lang.String getUserPassword()

Get the user password for the report. Is "" for no password.

Specified by:

getUserPassword in interface ProcessPdfAPI

Returns:

The user password. "" if no password.

setSecurity

public void setSecurity(int mode)

Set the security for the created pdf report.

Specified by:

setSecurity in interface ProcessPdfAPI

Parameters:

mode - Set to a bitmask of the ALLOW_* final ints.

getSecurity

public int getSecurity()

Get the security for the created pdf report.

Specified by:

getSecurity in interface ProcessPdfAPI

Returns:

A bitmask of the ALLOW_* final ints.

setKeyLength

public void setKeyLength(int len)

Set the password licenseKey length.

Specified by:

setKeyLength in interface ProcessPdfAPI

Parameters:

len - Must be set to 40 or 128.

getKeyLength

public int getKeyLength()

Get the password licenseKey length.

Specified by:

getKeyLength in interface ProcessPdfAPI

Returns:

Will be 40 or 128.

isPdfA

public boolean isPdfA()

true if build a PDF/A-1b file. This will force all fonts to be embedded.

Specified by:

isPdfA in interface ProcessPdfAPI

Returns:

true if build a PDF/A-1b file.

setPdfA

public void setPdfA(boolean pdfaMode)

true if build a PDF/A-1b file. This will force all fonts to be embedded.

Specified by:

setPdfA in interface ProcessPdfAPI

Parameters:

pdfaMode - true if build a PDF/A-1b file.

getPdfVersion

public java.lang.String getPdfVersion()

Gets the PDF version number used to create the file. This will be one of the VERSION_* static Strings. It will be in the form "1.4".

Specified by:

getPdfVersion in interface ProcessPdfAPI

Returns:

the PDF version number used to create the file.

setPdfVersion

public void setPdfVersion(java.lang.String version)

Gets the PDF version number used to create the file. This will be one of the VERSION_* static Strings. It will be in the form "1.4".

Specified by:

setPdfVersion in interface ProcessPdfAPI

Parameters:

version - the PDF version number used to create the file.

getDocument

public net.windward.document.Document getDocument()

Gets the current document

Returns:

current document