net.windward.xmlreport

Class ProcessPrinter

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessPrinter

All Implemented Interfaces:

ProcessPrinterAPI, ProcessReportAPI, ProcessReportAPIBase

public class ProcessPrinter
extends ProcessReport
implements ProcessPrinterAPI

Process object for a printer report. Contains properties for controlling the process and configuring various settings.

See Also:

ProcessReport

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.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
ProcessPrinter(DataSourceProvider data, java.io.InputStream template, java.lang.String printer, int copies) Create a ProcessPrinter.
ProcessPrinter(java.io.InputStream templateStream) Create a ProcessPrinter.
ProcessPrinter(java.io.InputStream templateStream, java.lang.String printer) Create a printer report.
ProcessPrinter(ProcessPrinter src) Creates and returns a copy of this ProcessPrinter object.

Method Summary

Modifier and Type	Method and Description
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Creates and returns a copy of this ProcessReport object.
int	getCopies() Gets the total number of copies to be printed.
PrinterConfiguration.Duplex	getDuplex() Get the printer's duplex setting.
java.lang.String	getFirstPagePrinter() Gets the name of the first page's printer.
int	getFirstPageTray() Gets the tray for the first page.
java.lang.String	getJobName() Get the name of the print job.
java.lang.String	getPrinter() Gets the printer name.
PrinterConfiguration	getPrinterConfiguration() Get the printer configuration for the report.
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	getTray() Gets the tray to be printed to.
boolean	isPageBasedReport() true if the generated report is page based.
void	setCopies(int copies) Sets the total number of copies to be printed.
void	setDuplex(PrinterConfiguration.Duplex value) Set the printer's duplex setting.
void	setEmbededDataMode(int mode) Set the embed data setting.
void	setFirstPagePrinter(java.lang.String printer) Sets the first page printer.
void	setFirstPageTray(int tray) Sets the tray for the first page.
void	setJobName(java.lang.String name) Set the name of the print job.
void	setPrinter(java.lang.String printer) Sets the printer to the specified printer name.
void	setTray(int tray) Sets the tray to be printed to.

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, 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, updatePods

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, 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, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Constructor Detail

ProcessPrinter

public ProcessPrinter(java.io.InputStream templateStream,
                      java.lang.String printer)
               throws LicenseException,
                      SetupException

Create a printer report. This takes the place of the standard ProcessReport(InputStream templateStream, OutputStream report) constructor.

Objects created with this constructor must call:

1. processSetup()
2. processData() {0...N times}
3. processComplete()

Objects created with this constructor cannot call process().

Do not pass in buffered streams if you have the option. ProcessReport wraps all streams in buffers, generally BufferedReader and BufferedWriter.

Parameters:

templateStream - The template.

printer - The name of the printer. Must not be null or empty.

Throws:

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

SetupException

See Also:

ProcessReport

ProcessPrinter

public ProcessPrinter(java.io.InputStream templateStream)
               throws LicenseException,
                      SetupException

Create a ProcessPrinter. The printer name must be separately initialized.

Objects created with this constructor must call:

1. processSetup()
2. processData()
3. processComplete()

Objects created with this constructor cannot call process().

Do not pass in buffered streams if you have the option. ProcessReport wraps all streams in buffers, generally BufferedReader and BufferedWriter.

Parameters:

templateStream - The template.

Throws:

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

SetupException

See Also:

ProcessReport

ProcessPrinter

public ProcessPrinter(DataSourceProvider data,
                      java.io.InputStream template,
                      java.lang.String printer,
                      int copies)
               throws LicenseException,
                      SetupException

Create a ProcessPrinter. Takes the place of the standard ProcessReport(data,template,report) constructor, which is intended to be used with the ProcessReport.process() method.

Parameters:

data - The data source provider.

template - The template.

printer - The printer name. Must not be null or empty.

copies - Number of copies to print. Must be greater than zero. If a number less than one is specified, one copy will be printed.

Throws:

LicenseException

SetupException

See Also:

ProcessReport

ProcessPrinter

public ProcessPrinter(ProcessPrinter src)
               throws LicenseException,
                      AlreadyProcessedException,
                      SetupException

Creates and returns a copy of this ProcessPrinter 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. It doesn't make a deep copy of the printer settings.

Parameters:

src - The ProcessPrinter object to copy.

Throws:

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

AlreadyProcessedException

SetupException

Method Detail

duplicate

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

Creates and returns a copy of this ProcessReport 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.

Specified by:

duplicate in interface ProcessReportAPIBase

Parameters:

out - Ignored for printer reports.

Returns:

A duplicated report object.

Throws:

AlreadyProcessedException

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.

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

The type (format) of the output report. Will be one of the TYP_* values.

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Specified by:

getReportTypeString in interface ProcessReportAPIBase

Returns:

"printer"

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.

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.

setPrinter

public void setPrinter(java.lang.String printer)

Sets the printer to the specified printer name. The printer name is usually in the form \\server\printer.
If a different printer is associated with the first page, this is the main printer for all pages after the first.

Specified by:

setPrinter in interface ProcessPrinterAPI

Parameters:

printer - the name of the printer

getPrinter

public java.lang.String getPrinter()

Gets the printer name. If a different printer is associated with the first page, this is the main printer for all pages after the first.

Specified by:

getPrinter in interface ProcessPrinterAPI

Returns:

printer name

setCopies

public void setCopies(int copies)

Description copied from interface: ProcessPrinterAPI

Sets the total number of copies to be printed.

Specified by:

setCopies in interface ProcessPrinterAPI

Parameters:

copies - the number of copies to print

getCopies

public int getCopies()

Description copied from interface: ProcessPrinterAPI

Gets the total number of copies to be printed.

Specified by:

getCopies in interface ProcessPrinterAPI

Returns:

the number of copies to be printed

setTray

public void setTray(int tray)

Sets the tray to be printed to. If a different tray is associated with the first page, this is the main tray for all pages after the first.

Specified by:

setTray in interface ProcessPrinterAPI

Parameters:

tray - main tray

getTray

public int getTray()

Gets the tray to be printed to. If a different tray is associated with the first page, this is the main tray for all pages after the first.

Specified by:

getTray in interface ProcessPrinterAPI

Returns:

main tray

setFirstPagePrinter

public void setFirstPagePrinter(java.lang.String printer)

Sets the first page printer. Only used when a different printer is required for the first page.

Specified by:

setFirstPagePrinter in interface ProcessPrinterAPI

Parameters:

printer - printer name

getFirstPagePrinter

public java.lang.String getFirstPagePrinter()

Gets the name of the first page's printer. Only used when a different tray is required for the first page.

Specified by:

getFirstPagePrinter in interface ProcessPrinterAPI

Returns:

first-page printer name

setFirstPageTray

public void setFirstPageTray(int tray)

Sets the tray for the first page. Only used when a different tray is required for the first page.

Specified by:

setFirstPageTray in interface ProcessPrinterAPI

Parameters:

tray - first-page tray

getFirstPageTray

public int getFirstPageTray()

Gets the tray for the first page. Only used when a different tray is required for the first page.

Specified by:

getFirstPageTray in interface ProcessPrinterAPI

Returns:

first-page tray

getPrinterConfiguration

public PrinterConfiguration getPrinterConfiguration()

Description copied from interface: ProcessPrinterAPI

Get the printer configuration for the report.

Specified by:

getPrinterConfiguration in interface ProcessPrinterAPI

Returns:

Printer configuration used for printing the report.

setJobName

public void setJobName(java.lang.String name)

Description copied from interface: ProcessPrinterAPI

Set the name of the print job. This is an arbitrary name which is passed on to the print job spooler.

Specified by:

setJobName in interface ProcessPrinterAPI

Parameters:

name - The print job name.

getJobName

public java.lang.String getJobName()

Description copied from interface: ProcessPrinterAPI

Get the name of the print job.

Specified by:

getJobName in interface ProcessPrinterAPI

Returns:

The print job name.

setDuplex

public void setDuplex(PrinterConfiguration.Duplex value)
               throws OutputLimitationException

Description copied from interface: ProcessPrinterAPI

Set the printer's duplex setting.

Specified by:

setDuplex in interface ProcessPrinterAPI

Parameters:

value - The desired duplex setting.

Throws:

OutputLimitationException

getDuplex

public PrinterConfiguration.Duplex getDuplex()

Description copied from interface: ProcessPrinterAPI

Get the printer's duplex setting. This returns the currently set value.

Specified by:

getDuplex in interface ProcessPrinterAPI

Returns:

The duplex setting.