net.windward.xmlreport

Class ProcessImage

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessGraphics2D

net.windward.xmlreport.ProcessImage

All Implemented Interfaces:

ProcessReportAPI, ProcessReportAPIBase

public class ProcessImage
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 series of bitmaps, one bitmap per page. Output is to a List of bitmaps and you then must read the bitmaps. You cannot provide streams for the output. This also handles the SVG and EPS formats which are vector instead of bitmaps but are the file per page output.

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

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
ProcessImage(java.io.InputStream template, int imageFormat) Deprecated. use ProcessImage(InputStream template, String imageFormat) instead.
ProcessImage(java.io.InputStream template, int imageFormat, int dpi) Deprecated. use ProcessImage(InputStream template, String imageFormat, int dpi) instead.
ProcessImage(java.io.InputStream template, java.lang.String imageFormat) Create a ProcessImage object with the passed in template.
ProcessImage(java.io.InputStream template, java.lang.String imageFormat, int dpi) Create a ProcessImage object with the passed in template.

Method Summary

Modifier and Type	Method and Description
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Unsupported for images as this writes an array of page objects, not a single output stream.
int	getDpi() The Dots Per Inch to render the bitmaps at.
int	getImageFormat() The bitmap format for the pages.
java.util.List<byte[]>	getPages() Get the generated images, each page is a distinct bitmap or XML (SVG).
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.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

Constructor Detail

ProcessImage

public ProcessImage(java.io.InputStream template,
                    java.lang.String imageFormat,
                    int dpi)
             throws LicenseException,
                    SetupException

Create a ProcessImage 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 requested bitmap format. Use this constructor for raster (need DPI) formats.

Parameters:

template - The report template.

imageFormat - The bitmap format for the pages. One of the following values: "bmp", "emf", "emz", gif", "jpg", "png", "tif", "wmf", or "wmz".

dpi - The Dots Per Inch to render the bitmaps at.

Throws:

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

SetupException

ProcessImage

public ProcessImage(java.io.InputStream template,
                    java.lang.String imageFormat)
             throws LicenseException,
                    SetupException

Create a ProcessImage 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 requested bitmap format. Use this constructor for vector (no DPI) formats.

Parameters:

template - The report template.

imageFormat - The bitmap format for the pages. One of the following values: "eps" or "svg".

Throws:

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

SetupException

ProcessImage

public ProcessImage(java.io.InputStream template,
                    int imageFormat,
                    int dpi)
             throws LicenseException,
                    SetupException

Deprecated. use ProcessImage(InputStream template, String imageFormat, int dpi) instead.

Create a ProcessImage 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 requested bitmap format. Use this constructor for raster (need DPI) formats.

Parameters:

template - The report template.

imageFormat - The bitmap format for the pages. One of the HtmlImage.BITMAP_* values.

dpi - The Dots Per Inch to render the bitmaps at.

Throws:

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

SetupException

ProcessImage

public ProcessImage(java.io.InputStream template,
                    int imageFormat)
             throws LicenseException,
                    SetupException

Deprecated. use ProcessImage(InputStream template, String imageFormat) instead.

Create a ProcessImage 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 requested bitmap format. Use this constructor for vector (no DPI) formats.

Parameters:

template - The report template.

imageFormat - The bitmap format for the pages. One of the HtmlImage.RENDER_* values. SVG/EPS only

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

Unsupported for images as this writes an array of page objects, not a single output stream.

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 called too often for the license type.

SetupException

getImageFormat

public int getImageFormat()

The bitmap format for the pages.

getDpi

public int getDpi()

The Dots Per Inch to render the bitmaps at. Ignored for SVG.

getPages

public java.util.List<byte[]> getPages()

Get the generated images, each page is a distinct bitmap or XML (SVG). This are bit images of the file.

getReportType

public int getReportType()

Get the report format of the output stream.

Returns:

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

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Returns:

"image"

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.

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.