net.windward.xmlreport

Class ProcessPostScript

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessGraphics2D

net.windward.xmlreport.ProcessPostScript

All Implemented Interfaces:

ProcessReportAPI, ProcessReportAPIBase

public class ProcessPostScript
extends ProcessGraphics2D

This class is the main program that takes a template stream and a datasource and merges them to create a report rendered as a postscript file.

Version:

15.2

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

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.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_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, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, 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
ProcessPostScript(java.io.InputStream template) THIS IS A BETA FEATURE Create a ProcessPostScript object with the passed in template.
ProcessPostScript(java.io.InputStream template, java.io.OutputStream report) THIS IS A BETA FEATURE Create a ProcessPostScript 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	getReportType() Get the report format of the output stream.
java.lang.String	getReportTypeString() Get the report format of the output as a string.
boolean	isPageBasedReport() true if the generated report is page based.
void	setEmbededDataMode(int mode) Set the embed data setting.

Methods inherited from class net.windward.xmlreport.ProcessGraphics2D

getRenderExtent, getRenderPages, setRenderExtent, setRenderPages

Methods inherited from class net.windward.xmlreport.ProcessReport

abort, addImportInfo, adjustFontName, adjustFontSize, batchNext, batchSetup, buildSchema, checkTimeout, 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, getNumPages, getOutputBuilderData, getParameters, getReport, getSubject, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateTypeString, getTemplateVersion, getTimeout, getTitle, getVersion, getVersionMajor, getVersionMinor, getVersionRelease, getWriteTags, hasDatasourcesApplied, init, isCopyEmbeddedObjects, isDebugMode, isIgnoreTags, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeDocx, isReportTypeExcel, isReportTypeOpenXml, isReportTypePpt, isReportTypeWord, isSameOpenXml, isTemplateTypeDOCX, isTemplateTypeOpenXml, isTemplateTypePPTX, isTemplateTypeXLSX, isTrackImports, isUseExternalOutputBuilder, loadTemplate, mergePodItemStyles, performLayout, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugHandler, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setIgnoreTags, setKeywords, setLayoutDocument, setLocale, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, shutdown, statLine, updatePods

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessPostScript

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

THIS IS A BETA FEATURE Create a ProcessPostScript 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 csv 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

ProcessPostScript

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

THIS IS A BETA FEATURE Create a ProcessPostScript 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 csv 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

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 ProcessTxt object.

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

getReportType

public int getReportType()

Get the report format of the output stream.

Returns:

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

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Returns:

"ps"

isPageBasedReport

public boolean isPageBasedReport()

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

Specified by:

isPageBasedReport in interface ProcessReportAPIBase

Overrides:

isPageBasedReport in class ProcessReport

Returns:

true if the generated report is page based.

setEmbededDataMode

public void setEmbededDataMode(int mode)

Set the embed data setting. Uses flags of EMBED_* constant ints. 0 for no embed.

Parameters:

mode - the embed data setting. You can only pass a 0.