net.windward.xmlreport

Class ProcessOpenXml

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessOpenXml

All Implemented Interfaces:

ProcessOpenXmlAPI, ProcessReportAPI, ProcessReportAPIBase

Direct Known Subclasses:

ProcessDocx, ProcessPptx, ProcessXlsx

public abstract class ProcessOpenXml
extends ProcessReport
implements ProcessOpenXmlAPI

Base ProcessReport class for all reports that write an OpenXML document (DOCX, PPTX, XLSX).

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
ProcessOpenXml(java.io.InputStream template) Create a ProcessDocx object with the passed in template.
ProcessOpenXml(java.io.InputStream xmlData, java.io.InputStream template, java.io.OutputStream report) Create a ProcessDocx object with the passed in template & data streams, writing it to the passed in report stream.
ProcessOpenXml(java.io.InputStream template, java.io.OutputStream report) Create a ProcessDocx object with the passed in template, writing it to the passed in report stream.

Method Summary

Modifier and Type	Method and Description
int	getCopyMetadata() Get if the Windward metadata will be copied to the generated report.
boolean	isChartsAsCharts() Deprecated. Charts should always be written as charts
boolean	isCopyDrawings() True if drawings are to be copied to output.
boolean	isCopyShapes() True if shapes are to be copied to output.
boolean	isRecalculateOnOpen() true if the document is to perform recalculation when first opened.
void	setChartsAsCharts(boolean writeAsChart) Deprecated. Charts should always be written as charts
void	setCopyDrawings(boolean copyDrawings) True if drawings are to be copied to output.
void	setCopyMetadata(int copy) Set if the Windward metadata will be copied to the generated report.
void	setCopyShapes(boolean copyShapes) True if shapes are to be copied to output.
void	setRecalculateOnOpen(boolean recalc) true if the document is to perform recalculation when first opened.

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, 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, isPageBasedReport, 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, 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, duplicate, findPodsUsed, getBaseDirectory, getCharset, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getModeProcessEmbedded, getNumPages, getOutputBuilder, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getReportType, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, hasProcessedTags, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, 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

ProcessOpenXml

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

Create a ProcessDocx 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 docx 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

ProcessOpenXml

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

Create a ProcessDocx 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 docx 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

ProcessOpenXml

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

Create a ProcessDocx object with the passed in template & data streams, writing it to the passed in report stream. The report will be in the docx 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:

DataSourceException - 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.

DataConnectionException

SetupException

Method Detail

getCopyMetadata

public int getCopyMetadata()

Get if the Windward metadata will be copied to the generated report. This can only occur if the template and generated report are both OpenXML files. The default is COPY_IF_NO_DATASOURCE.

Specified by:

getCopyMetadata in interface ProcessReportAPIBase

Overrides:

getCopyMetadata in class ProcessReport

Returns:

one of the COPY_* static ints.

setCopyMetadata

public void setCopyMetadata(int copy)

Set if the Windward metadata will be copied to the generated report. This can only occur if the template and generated report are both OpenXML files. The default is COPY_IF_NO_DATASOURCE. Note: This is not yet implemented.

Specified by:

setCopyMetadata in interface ProcessReportAPIBase

Overrides:

setCopyMetadata in class ProcessReport

Parameters:

copy - one of the COPY_* static ints.

isCopyDrawings

public boolean isCopyDrawings()

True if drawings are to be copied to output. Drawings are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Specified by:

isCopyDrawings in interface ProcessOpenXmlAPI

Returns:

true if drawings are to be copied to output.

setCopyDrawings

public void setCopyDrawings(boolean copyDrawings)

True if drawings are to be copied to output. Drawings are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Specified by:

setCopyDrawings in interface ProcessOpenXmlAPI

Parameters:

copyDrawings - true if drawings are to be copied to output.

isCopyShapes

public boolean isCopyShapes()

True if shapes are to be copied to output. Shapes are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Specified by:

isCopyShapes in interface ProcessOpenXmlAPI

Returns:

true if shapes are to be copied to output.

setCopyShapes

public void setCopyShapes(boolean copyShapes)

True if shapes are to be copied to output. Shapes are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Specified by:

setCopyShapes in interface ProcessOpenXmlAPI

Parameters:

copyShapes - true if shapes are to be copied to output.

isChartsAsCharts

public boolean isChartsAsCharts()

Deprecated. Charts should always be written as charts

true if chart tags that are in the template as a chart, will be rendered as charts in the generated report. If false, then charts will be generated as bitmaps. This setting is only for chart tags that are stored in the template as a chart. It is only relevant for output to OpenXML formats. Note: Chart tags as charts is not implemented for PPTX.

Specified by:

isChartsAsCharts in interface ProcessOpenXmlAPI

Returns:

true if chart tags will be rendered as charts, false otherwise.

setChartsAsCharts

public void setChartsAsCharts(boolean writeAsChart)

Deprecated. Charts should always be written as charts

true if chart tags that are in the template as a chart, will be rendered as charts in the generated report. If false, then charts will be generated as bitmaps. This setting is only for chart tags that are stored in the template as a chart. It is only relevant for output to OpenXML formats. Note: Chart tags as charts is not implemented for PPTX.

Specified by:

setChartsAsCharts in interface ProcessOpenXmlAPI

Parameters:

writeAsChart - true if chart tags will be rendered as charts, false otherwise.

isRecalculateOnOpen

public boolean isRecalculateOnOpen()

true if the document is to perform recalculation when first opened. Default is true for XLSX, false for other formats.

Specified by:

isRecalculateOnOpen in interface ProcessOpenXmlAPI

Returns:

true if the document is to perform recalculation when first opened.

setRecalculateOnOpen

public void setRecalculateOnOpen(boolean recalc)

true if the document is to perform recalculation when first opened. Default is true for XLSX, false for other formats.

Specified by:

setRecalculateOnOpen in interface ProcessOpenXmlAPI

Parameters:

recalc - true if the document is to perform recalculation when first opened.