net.windward.xmlreport

Class ProcessGraphics2D

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessGraphics2D

All Implemented Interfaces:

ProcessReportAPI, ProcessReportAPIBase

Direct Known Subclasses:

ProcessImage, ProcessPostScript

public abstract class ProcessGraphics2D
extends ProcessReport

Base ProcessReport class for all reports that use the Graphics2D builder.

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
ProcessGraphics2D()
ProcessGraphics2D(DataSourceProvider data, java.io.InputStream template, java.io.OutputStream report) Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream.
ProcessGraphics2D(Document document)
ProcessGraphics2D(java.io.InputStream templateStream) Create a ProcessReport object with the passed in template.
ProcessGraphics2D(java.io.InputStream xmlData, java.io.InputStream templateStream, java.io.OutputStream report) Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream.
ProcessGraphics2D(java.io.InputStream templateStream, java.io.OutputStream report) Create a ProcessReport object with the passed in template, writing it to the passed in report stream.
ProcessGraphics2D(ProcessReport src) Do not use!!! Not part of the public API.
ProcessGraphics2D(ProcessReport src, java.io.OutputStream out) Creates and returns a copy of this object.

Method Summary

Modifier and Type	Method and Description
int	getRenderExtent() How the generated report will be cropped.
java.lang.String	getRenderPages() The pages that will be generated.
void	setRenderExtent(int extent) How the generated report will be cropped.
void	setRenderPages(java.lang.String pages) The pages that will be generated.

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

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

duplicate, getReportType, getReportTypeString

Constructor Detail

ProcessGraphics2D

public ProcessGraphics2D()

ProcessGraphics2D

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

Create a ProcessReport object with the passed in template. Objects created with this constructor must call:
processSetup()
processData()
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 report template.

Throws:

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

SetupException

ProcessGraphics2D

public ProcessGraphics2D(java.io.InputStream templateStream,
                         java.io.OutputStream report)
                  throws LicenseException,
                         SetupException

Create a ProcessReport object with the passed in template, writing it to the passed in report stream. The report will be in the format requested. Objects created with this constructor must call:
processSetup()
processData() {0...N times}
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 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

ProcessGraphics2D

public ProcessGraphics2D(java.io.InputStream xmlData,
                         java.io.InputStream templateStream,
                         java.io.OutputStream report)
                  throws DataConnectionException,
                         LicenseException,
                         SetupException

Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream. The report will be in the format requested. Objects created with this constructor must call process() and cannot call processSetup, ProcessData, or processComplete.

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

Parameters:

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

templateStream - 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

ProcessGraphics2D

public ProcessGraphics2D(DataSourceProvider data,
                         java.io.InputStream template,
                         java.io.OutputStream report)
                  throws LicenseException,
                         SetupException

Create a ProcessReport object with the passed in template & data streams, writing it to the passed in report stream. The report will be in the format requested. Objects created with this constructor must call process() and cannot call processSetup, ProcessData, or processComplete.

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

Parameters:

data - The data that will be placed into the report where there are tags.

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

ProcessGraphics2D

public ProcessGraphics2D(ProcessReport src,
                         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.

Parameters:

src - The ProcessReport object to copy.

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

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

ProcessGraphics2D

public ProcessGraphics2D(ProcessReport src)
                  throws AlreadyProcessedException,
                         LicenseException,
                         SetupException

Do not use!!! Not part of the public API.

Parameters:

src - The ProcessReport object to copy.

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

ProcessGraphics2D

public ProcessGraphics2D(Document document)
                  throws SetupException

Throws:

SetupException

Method Detail

getRenderExtent

public int getRenderExtent()

Description copied from interface: ProcessReportAPIBase

How the generated report will be cropped. This is not supported by all report types.

Specified by:

getRenderExtent in interface ProcessReportAPIBase

Overrides:

getRenderExtent in class ProcessReport

Returns:

a ProcessReportAPI.RENDER_EXTENT_* value.

setRenderExtent

public void setRenderExtent(int extent)

Description copied from interface: ProcessReportAPIBase

How the generated report will be cropped. This is not supported by all report types. This is presently only supported by ProcessImage and ProcessTxt. Future support will be printer, PostScript, & page-based HTML.

Specified by:

setRenderExtent in interface ProcessReportAPIBase

Overrides:

setRenderExtent in class ProcessReport

Parameters:

extent - a ProcessReportAPI.RENDER_EXTENT_* value.

getRenderPages

public java.lang.String getRenderPages()

Description copied from interface: ProcessReportAPIBase

The pages that will be generated. String is in the form "0, 4, 6-11, 15" The numbers most be increasing with no overlap. This is not supported by all report types. Set to null for all pages. Pages are 0-based.

Specified by:

getRenderPages in interface ProcessReportAPIBase

Overrides:

getRenderPages in class ProcessReport

Returns:

The pages that will be generated in the form "0, 4, 6-11, 15". null for all pages. Pages are 0-based.

setRenderPages

public void setRenderPages(java.lang.String pages)

Description copied from interface: ProcessReportAPIBase

The pages that will be generated. String is in the form "0, 4, 6-11, 15" The numbers must be increasing with no overlap. This is not supported by all report types. Set to null for all pages. Pages are 0-based. This is presently only supported by ProcessImage. Future support will be printer, PostScript, text, & page-based HTML.

Specified by:

setRenderPages in interface ProcessReportAPIBase

Overrides:

setRenderPages in class ProcessReport

Parameters:

pages - The pages that will be generated in the form "0, 4, 6-11, 15". Set to null for all pages. Pages are 0-based.