ProcessReport (Windward Reports 16.1 API)

java.lang.Object
- net.windward.xmlreport.ProcessReport

All Implemented Interfaces:

ProcessReportAPI, ProcessReportAPIBase

Direct Known Subclasses:

ProcessCsv, ProcessGraphics2D, ProcessHtml, ProcessOpenXml, ProcessPdf, ProcessPrinter, ProcessRtf, ProcessTxt
```
public abstract class ProcessReport
extends java.lang.Object
implements ProcessReportAPI
```
This class is the base class that takes a template stream and a DataSource and merges them to create a report stream. The way to use this is to construct an object that extends this class, set any options, then call the process methods.

There are two approaches to processing a rpeport. The first is to call: processSetup();
processData(data, name); // can be called 0 - N times
processComplete();
The second approach is to call: process();
By definition the second method can only be called if the object constructor includes the xml file and there is only 1 xml file to be processed.

The calling method must close all streams after calling process(). process() will flush the output (report) stream before returning.

Version:

2.0 2 January 2004

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessReport.CleanDatasource` This is not part of the public interface.
`static class`	`ProcessReport.DrillDownTemplate` This is not part of the public interface.
`static class`	`ProcessReport.PhoneHomeStats`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TEMPLATE_TYPE_DOCM` The template is a Word 2007 DOCM file.
`static int`	`TEMPLATE_TYPE_DOCX` The template is a Word 2007 DOCX file.
`static int`	`TEMPLATE_TYPE_HTML` The template is an HTML fragment...
`static int`	`TEMPLATE_TYPE_PPTM` The template is a Powerpoint Presentation PPTM file.
`static int`	`TEMPLATE_TYPE_PPTX` The template is a Powerpoint Presentation PPTX file.
`static int`	`TEMPLATE_TYPE_UNKNOWN` Parse the template to determine what format it is.
`static int`	`TEMPLATE_TYPE_XLSM` The template is an Excel 2007 Macro enabled XLSM file.
`static int`	`TEMPLATE_TYPE_XLSX` The template is an Excel 2007 XLSX file.

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
`ProcessReport(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.
`ProcessReport(java.io.InputStream templateStream)` Create a ProcessReport object with the passed in template.
`ProcessReport(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.
`ProcessReport(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.
`ProcessReport(ProcessReport src)` Do not use!!! Not part of the public API.
`ProcessReport(ProcessReport src, java.io.OutputStream out)` Creates and returns a copy of this object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abort()` Call to abort the report processing.
`void`	`addImportInfo(java.util.List importInfo)` This is not part of the public API - do not use.
`java.lang.String`	`adjustFontName(DocHeader hdr, java.lang.String font)` Return the font name.
`int`	`adjustFontSize(int size)` Return the font size.
`BatchReport`	`batchNext(java.io.OutputStream report)` Generates the next document in the batch and returns the results of that document.
`void`	`batchSetup(java.util.Map<java.lang.String,DataSourceProvider> dataProviders, java.lang.String batchForEach, java.util.Map<java.lang.String,java.lang.String> parameters)` Prepares the object to run batch reports.
`void`	`buildSchema(java.io.OutputStream xmlSchema)` Generates a UDT schema XML files based on the tags in the template.
`void`	`checkTimeout()` This is NOT part of the public API.
`static void`	`clean(java.io.InputStream template, java.io.OutputStream cleanedStream, int cleanedType, boolean removeUnused, int tagStyle, ProcessReport.CleanDatasource[] datasources, int paramMode, int templateVersion)` Clean the requested template.
`static void`	`clean(java.io.InputStream template, java.io.OutputStream cleanedStream, int cleanedType, boolean removeUnused, int tagStyle, ProcessReport.CleanDatasource[] datasources, int paramMode, int templateVersion, boolean fixExpressions)` Clean the requested template.
`void`	`cleanSelects(ProcessReport.CleanDatasource[] arrDatasources, int mode)` This is not part of the official API - do not use this.
`void`	`cleanSelects(ProcessReport.CleanDatasource[] arrDatasources, int mode, boolean fixExpressions)` This is not part of the official API - do not use this.
`void`	`close()` Call when you are done with this object, including done with the OutputStream returned by getReport if that stream was created by ProcessReport.
`java.util.List<java.lang.String>`	`findPodsUsed()` Find Pod's being used by a Document.
`java.lang.String`	`getBaseDirectory()` Get the base directory used for imported files that have a relative path.
`int`	`getCharset()` Html and txt files are generated using a charset (the rest use unicode).
`ChartProvider`	`getChartProvider()` Returns the chart provider used for this process.
`int`	`getChartRenderType()` What HtmlImage.BITMAP_* type to render charts at for this ReportType.
`static java.lang.String`	`getCompany()` The company this copy is licensed to.
`int`	`getCopyMetadata()` Get if the Windward metadata will be copied to the generated report.
`int`	`getDataMode()` Get the embed data setting.
`java.io.OutputStream`	`getDataStream()` As the report is run, the data for each tag can also be placed in an associated data.xml file.
`net.windward.xmlreport.ProcessReport.DataWriter`	`getDataWriter()` This is not part of the official API.
`IDebugHandler`	`getDebugHandler()` The debug handler assigned to this report if debugging.
`java.lang.String`	`getDescription()` Get the description of the document.
`ProcessReport.DrillDownTemplate`	`getDrillDownInfo()` Get the info for the template file this is in.
`ErrorInfo`	`getErrorInfo()` Get an object containing a set of errors encounterred during the report generation.
`WindwardEventHandler`	`getEventHandler()` Get event handler assigned to the report.
`int`	`getHiddenMode()` Get the mode for handling hidden objecxts in the template.
`int`	`getHyphenate()` Get if the generated report will be hyphenated.
`ImportInfo[]`	`getImportInfo()` Get all imports in the processed template.
`java.lang.String`	`getKeywords()` Get the keywords of the document.
`java.util.Locale`	`getLocale()` This call returns the locale used in creating a report.
`static int`	`getMaxReportPages()`
`int`	`getNumPages()` Returns how many pages long a report is.
`java.lang.Object`	`getOutputBuilderData()` Optional data to pass to the external output builder.
`java.util.Map<java.lang.String,java.lang.Object>`	`getParameters()` Returns the map of parameters for this report.
`int`	`getRenderExtent()` How the generated report will be cropped.
`java.lang.String`	`getRenderPages()` The pages that will be generated.
`java.io.OutputStream`	`getReport()` Return the final report.
`java.lang.String`	`getSubject()` Get the subject of the document.
`static TemplateInfo`	`getTemplateMetrics(java.io.InputStream file)` Returns information about all vars, datasources, and tags referenced in the template.
`static TemplateInfo`	`getTemplateMetrics(java.io.InputStream file, boolean quiet)` Returns information about all vars, datasources, and tags referenced in the template.
`static TemplateInfo`	`getTemplateMetrics(java.io.InputStream file, boolean quiet, boolean ignoreTags)`
`java.lang.String`	`getTemplateTypeString()` The extension of the template.
`int`	`getTemplateVersion()` Set the verion of Windward/AutoTag this template was created for.
`int`	`getTimeout()` Set the number of seconds to timeout generating a report.
`java.lang.String`	`getTitle()` Get the title of the document.
`static java.lang.String`	`getVersion()` The version of Windward Reports.
`static int`	`getVersionMajor()` The major version number of Windward Reports.
`static int`	`getVersionMinor()` The minor version number of Windward Reports.
`static int`	`getVersionRelease()` The release version number of Windward Reports.
`int`	`getWriteTags()` Get the style unprocessed tags are written out as.
`boolean`	`hasDatasourcesApplied()` true if datasources have been applied to this report.
`static void`	`init()` This method should be called before any other code anywhere in Windward Reports.
`boolean`	`isCopyEmbeddedObjects()` True if embedded objects are to be copied to output.
`boolean`	`isDebugMode()` Get if debug mode is on or off.
`boolean`	`isIgnoreTags()`
`boolean`	`isLayoutDocument()` If set to false, then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report.
`boolean`	`isPageBasedReport()` true if the generated report is page based.
`boolean`	`isPreservePodFraming()` True if Pod framing should be preserved for Pods in the document.
`boolean`	`isRemoveUnusedFormats()` True to remove all unused formatting information from the template when rendering the report.
`boolean`	`isReportTypeDocx()` True if the output report is a Word DOCX or DOCM file.
`boolean`	`isReportTypeExcel()` True if the output report is an Excel file, including CSV.
`boolean`	`isReportTypeOpenXml()` true if the report type is DOCX, PPTX, or XLSX.
`boolean`	`isReportTypePpt()` True if the output report is a PowerPoint file.
`boolean`	`isReportTypeWord()` True if the output report is a Word file, including Rtf.
`boolean`	`isSameOpenXml()` true if the template and report output are the same OpenXML format.
`boolean`	`isTemplateTypeDOCX()` true if the template is a DOCX.
`boolean`	`isTemplateTypeOpenXml()` true if the template is a DOCX, XLSX, or PPTX.
`boolean`	`isTemplateTypePPTX()` true if the template is a PPTX.
`boolean`	`isTemplateTypeXLSX()` true if the template is a XLSX.
`boolean`	`isTrackImports()` True if you want to call getImports after processing datasources.
`boolean`	`isUseExternalOutputBuilder()` Returns true if it will use the external output builder.
`Document`	`loadTemplate(java.io.InputStream file, int type, DocHeader hdr, DocBody parentDoc, boolean removeUnusedFormats, java.lang.String encoding, java.lang.String[] importStack)` This is not part of the official API.
`byte[]`	`mergePodItemStyles(byte[] podItemData, boolean usePodStyles)` This is not part of the official API.
`boolean`	`performLayout()` Returns true if the report will be laid out in processComplete().
`void`	`process()` Create a report from the input streams, writing it to the output (report) stream.
`long`	`processComplete()` Process the final report and create the output.
`void`	`processData(DataSourceProvider datasourceProvider, java.lang.String datasourceName)` Process a set of data for the report.
`void`	`processData(java.util.Map<java.lang.String,DataSourceProvider> dataProviders)` Processes multiple sets of data for the report.
`void`	`processSetup()` Process the template and get the report ready to process data files.
`void`	`processSetup(int inputType)` Process the template and get the report ready to process data files.
`void`	`setBaseDirectory(java.lang.String directory)` Set the base directory used for imported files that have a relative path.
`void`	`setCharset(int num)` Html and txt files are generated using a charset (the rest use unicode).
`void`	`setCopyEmbeddedObjects(boolean copyEmbeddedObjects)` True if embedded objects are to be copied to output.
`void`	`setCopyMetadata(int copy)` Set if the Windward metadata will be copied to the generated report.
`void`	`setDataMode(int mode)` Set the embed data setting.
`void`	`setDataStream(java.io.OutputStream stream)` As the report is run, the data for each tag can also be placed in an associated data.xml file.
`void`	`setDebugHandler(IDebugHandler debugHandler)` The debug handler assigned to this report if debugging.
`void`	`setDebugMode(boolean debugOn)` Set debug mode on or off.
`void`	`setDescription(java.lang.String description)` Set the description of the document.
`void`	`setDrillDownInfo(ProcessReport.DrillDownTemplate drillDownInfo)` Set the info for the template file this is in.
`void`	`setEventHandler(WindwardEventHandler eventHandler)` Assign event handler to the report.
`void`	`setHiddenMode(int mode)` Get the mode for handling hidden objecxts in the template.
`void`	`setHyphenate(int mode)` Set if the generated report will be hyphenated.
`void`	`setIgnoreTags(boolean ignore)`
`void`	`setKeywords(java.lang.String docKeywords)` Set the keywords of the document.
`void`	`setLayoutDocument(boolean layoutDocument)` If set to false, then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report.
`void`	`setLocale(java.util.Locale locale)` This call set's the locale used in creating a report.
`static void`	`setOutputBuilder(IOutputBuilderEngine outputBuilder)` Set the output builder.
`void`	`setOutputBuilderData(java.lang.Object outputBuilderData)` Optional data to pass to the external output builder.
`void`	`setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)` Adds a map that is used for ${variable} substitution.
`void`	`setPreservePodFraming(boolean preserve)` True if Pod framing should be preserved for Pods in the document.
`void`	`setRemoveUnusedFormats(boolean remove)` True to remove all unused formatting information from the template when rendering the report.
`void`	`setRenderExtent(int extent)` How the generated report will be cropped.
`void`	`setRenderPages(java.lang.String pages)` The pages that will be generated.
`void`	`setSubject(java.lang.String docSubject)` Set the subject of the document.
`void`	`setTemplateVersion(int version)` Set the verion of Windward/AutoTag this template was created for.
`void`	`setTimeout(int seconds)` Set the number of seconds to timeout generating a report.
`void`	`setTitle(java.lang.String docTitle)` Set the title of the document.
`void`	`setTrackErrors(int flag)` Enable or disable the error handling and verify features.
`void`	`setTrackImports(boolean trackImports)` True if you want to call getImports after processing datasources.
`void`	`setUseExternalOutputBuilder(boolean useExternalOutputBuilder)` Set to true to use the external output builder.
`void`	`setWriteTags(int tagStyle)` Set the style unprocessed tags are written out as.
`static void`	`shutdown()` Releases all resources held by Windward Reports.
`static void`	`statLine(java.lang.String msg, boolean logIt)`
`void`	`updatePods(UdtUpdate[] pods)` Deprecated. Use the import tag instead for content that needs to be updated.

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

- Field Detail
  - TEMPLATE_TYPE_UNKNOWN
```
public static final int TEMPLATE_TYPE_UNKNOWN
```
    Parse the template to determine what format it is.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_HTML
```
public static final int TEMPLATE_TYPE_HTML
```
    The template is an HTML fragment...
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_DOCX
```
public static final int TEMPLATE_TYPE_DOCX
```
    The template is a Word 2007 DOCX file.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_XLSX
```
public static final int TEMPLATE_TYPE_XLSX
```
    The template is an Excel 2007 XLSX file.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_PPTX
```
public static final int TEMPLATE_TYPE_PPTX
```
    The template is a Powerpoint Presentation PPTX file.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_XLSM
```
public static final int TEMPLATE_TYPE_XLSM
```
    The template is an Excel 2007 Macro enabled XLSM file.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_DOCM
```
public static final int TEMPLATE_TYPE_DOCM
```
    The template is a Word 2007 DOCM file.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_PPTM
```
public static final int TEMPLATE_TYPE_PPTM
```
    The template is a Powerpoint Presentation PPTM file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
  - ProcessReport
```
public ProcessReport(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 check fails. The message will list the license check that failed.
    
    SetupException
- Method Detail
  - getVersionMajor
```
public static int getVersionMajor()
```
    The major version number of Windward Reports. Version numbers are in the form MAJOR.MINOR.RELEASE.
    
    Returns:
    
    The major version number.
  - getVersionMinor
```
public static int getVersionMinor()
```
    The minor version number of Windward Reports. Version numbers are in the form MAJOR.MINOR.RELEASE.
    
    Returns:
    
    The minor version number.
  - getVersionRelease
```
public static int getVersionRelease()
```
    The release version number of Windward Reports. Version numbers are in the form MAJOR.MINOR.RELEASE.
    
    Returns:
    
    The release version number.
  - getVersion
```
public static java.lang.String getVersion()
```
    The version of Windward Reports. Version numbers are generally in the form "MAJOR.MINOR.RELEASE" or "MAJOR.MINOR.RELEASE beta".
    
    Returns:
    
    The version.
  - getCompany
```
public static java.lang.String getCompany()
```
    The company this copy is licensed to.
    
    Returns:
    
    The company name.
  - getMaxReportPages
```
public static int getMaxReportPages()
```
  - getWriteTags
```
public int getWriteTags()
```
    Get the style unprocessed tags are written out as. Is one of the TAG_STYLE_* values.
    
    Specified by:
    
    getWriteTags in interface ProcessReportAPIBase
    
    Returns:
    
    the style unprocessed tags are written out as.
  - setWriteTags
```
public void setWriteTags(int tagStyle)
```
    Set the style unprocessed tags are written out as. Is one of the TAG_STYLE_* values.
    
    Specified by:
    
    setWriteTags in interface ProcessReportAPIBase
    
    Parameters:
    
    tagStyle - the style unprocessed tags are written out as.
  - setTemplateVersion
```
public void setTemplateVersion(int version)
```
    Set the verion of Windward/AutoTag this template was created for. The default is the latest version number.
    
    Specified by:
    
    setTemplateVersion in interface ProcessReportAPIBase
    
    Parameters:
    
    version - The major version number the report was created in.
  - getTemplateVersion
```
public int getTemplateVersion()
```
    Set the verion of Windward/AutoTag this template was created for. The default is the latest version number.
    
    Specified by:
    
    getTemplateVersion in interface ProcessReportAPIBase
    
    Returns:
    
    The major version number the report was created in.
  - isPreservePodFraming
```
public boolean isPreservePodFraming()
```
    True if Pod framing should be preserved for Pods in the document. This is only valid for an OpenXML output format. The default is false.
    
    Specified by:
    
    isPreservePodFraming in interface ProcessReportAPIBase
    
    Returns:
    
    true if Pod framing should be preserved for Pods in the document.
  - setPreservePodFraming
```
public void setPreservePodFraming(boolean preserve)
```
    True if Pod framing should be preserved for Pods in the document. This is only valid for an OpenXML output format. The default is false.
    
    Specified by:
    
    setPreservePodFraming in interface ProcessReportAPIBase
    
    Parameters:
    
    preserve - true if Pod framing should be preserved for Pods in the document.
  - isTrackImports
```
public boolean isTrackImports()
```
    True if you want to call getImports after processing datasources. Default is false.
    
    Specified by:
    
    isTrackImports in interface ProcessReportAPIBase
    
    Returns:
    
    True if you want to call getImports after processing datasources.
  - setTrackImports
```
public void setTrackImports(boolean trackImports)
```
    True if you want to call getImports after processing datasources. Default is false.
    
    Specified by:
    
    setTrackImports in interface ProcessReportAPIBase
    
    Parameters:
    
    trackImports - True if you want to call getImports after processing datasources.
  - setRemoveUnusedFormats
```
public void setRemoveUnusedFormats(boolean remove)
```
    True to remove all unused formatting information from the template when rendering the report. As an example, in a Word document if a style is defined in the header and is not used within the document, it is not written in the list of styles in the generated Word report. This does not touch the template, just the generated report.
    The default is false.
    
    Specified by:
    
    setRemoveUnusedFormats in interface ProcessReportAPIBase
    
    Parameters:
    
    remove - true if removing all unused formatting in the generated report.
  - isRemoveUnusedFormats
```
public boolean isRemoveUnusedFormats()
```
    True to remove all unused formatting information from the template when rendering the report. As an example, in a Word document if a style is defined in the header and is not used within the document, it is not written in the list of styles in the generated Word report. This does not touch the template, just the generated report.
    The default is false.
    
    Specified by:
    
    isRemoveUnusedFormats in interface ProcessReportAPIBase
    
    Returns:
    
    true if removing all unused formatting in the generated report.
  - setTimeout
```
public void setTimeout(int seconds)
```
    Set the number of seconds to timeout generating a report. If the report takes longer than this amount of time, it will throw a TimeoutException. A time of 0 means there is no timeout. The default is 0. The count starts when you call processSetup but will only throw the exception in processData and processComplete.
    
    Specified by:
    
    setTimeout in interface ProcessReportAPIBase
    
    Parameters:
    
    seconds - The number of seconds to timeout report generation at. 0 for no timeout.
  - getTimeout
```
public int getTimeout()
```
    Set the number of seconds to timeout generating a report. If the report takes longer than this amount of time, it will throw a TimeoutException. A time of 0 means there is no timeout. The default is 0. The count starts when you call processSetup but will only throw the exception in processData and processComplete.
    
    Specified by:
    
    getTimeout in interface ProcessReportAPIBase
    
    Returns:
    
    The number of seconds to timeout report generation at. 0 for no timeout.
  - abort
```
public void abort()
```
    Call to abort the report processing. The report will throw a TimeoutException shortly after this is called.
  - 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_METADATA_IF_NO_DATASOURCE.
    
    Specified by:
    
    getCopyMetadata in interface ProcessReportAPIBase
    
    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_METADATA_IF_NO_DATASOURCE.
    
    Specified by:
    
    setCopyMetadata in interface ProcessReportAPIBase
    
    Parameters:
    
    copy - one of the COPY_* static ints.
  - getHyphenate
```
public int getHyphenate()
```
    Get if the generated report will be hyphenated. The default is HYPHENATE_TEMPLATE.
    
    Specified by:
    
    getHyphenate in interface ProcessReportAPIBase
    
    Returns:
    
    One of the ProcessReportAPI.HYPHENATE_* constants.
  - setHyphenate
```
public void setHyphenate(int mode)
```
    Set if the generated report will be hyphenated.
    
    Specified by:
    
    setHyphenate in interface ProcessReportAPIBase
    
    Parameters:
    
    mode - One of the ProcessReportAPI.HYPHENATE_* constants.
  - isCopyEmbeddedObjects
```
public boolean isCopyEmbeddedObjects()
```
    True if embedded objects are to be copied to output. Objects are copied as objects for DOCX -> DOCX and XLSX -> XLSX. For all other cases the output is the last rendered image of the object in the template (which is stored in the template with the object by Office). Default is true.
    
    Specified by:
    
    isCopyEmbeddedObjects in interface ProcessReportAPIBase
    
    Returns:
    
    true if embedded objects are to be copied to output.
  - setCopyEmbeddedObjects
```
public void setCopyEmbeddedObjects(boolean copyEmbeddedObjects)
```
    True if embedded objects are to be copied to output. Objects are copied as objects for DOCX -> DOCX and XLSX -> XLSX. For all other cases the output is the last rendered image of the object in the template (which is stored in the template with the object by Office). Default is true.
    
    Specified by:
    
    setCopyEmbeddedObjects in interface ProcessReportAPIBase
    
    Parameters:
    
    copyEmbeddedObjects - true if embedded objects are to be copied to output.
  - performLayout
```
public boolean performLayout()
```
    Returns true if the report will be laid out in processComplete(). To be false isLayoutDocument() & isPageBasedReport() must be false.
    
    Returns:
    
    true if the report will be laid out in processComplete().
  - isLayoutDocument
```
public boolean isLayoutDocument()
```
    If set to false, then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report. In this case the ProcessReport.getNumPages() will return an undefined value (usually -1) and any fields in DOCX that depend on page, section, num pages, etc. numbers will be wrong and the fields will need to be updated. The advantage of turning this off is document production will be faster. This setting is ignored for formats that need to layout (PDF, printer, text, etc.)
    
    Specified by:
    
    isLayoutDocument in interface ProcessReportAPIBase
    
    Returns:
    
    true if the document is laid out, false if that step is skipped. Default is true.
  - setLayoutDocument
```
public void setLayoutDocument(boolean layoutDocument)
```
    If set to false, then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report. In this case the ProcessReport.getNumPages() will return an undefined value (usually -1) and any fields in DOCX that depend on page, section, num pages, etc. numbers will be wrong and the fields will need to be updated. The advantage of turning this off is document production will be faster. This setting is ignored for formats that need to layout (PDF, printer, text, etc.)
    
    Specified by:
    
    setLayoutDocument in interface ProcessReportAPIBase
    
    Parameters:
    
    layoutDocument - true if the document is laid out, false if that step is skipped. Default is true.
  - getHiddenMode
```
public int getHiddenMode()
```
    Get the mode for handling hidden objecxts in the template. Uses a bitmas of the HIDDEN_* constant ints.
    
    Specified by:
    
    getHiddenMode in interface ProcessReportAPIBase
    
    Returns:
    
    The mode for handling hidden objecxts in the template.
  - setHiddenMode
```
public void setHiddenMode(int mode)
```
    Get the mode for handling hidden objecxts in the template. Uses a bitmas of the HIDDEN_* constant ints.
    
    Specified by:
    
    setHiddenMode in interface ProcessReportAPIBase
    
    Parameters:
    
    mode - The mode for handling hidden objecxts in the template.
  - isUseExternalOutputBuilder
```
public boolean isUseExternalOutputBuilder()
```
    Returns true if it will use the external output builder. The external output builder must be loaded and be capable of rendering from the template type to the output type, using all properties set in the ProcessReport object. Default is true.
    
    Specified by:
    
    isUseExternalOutputBuilder in interface ProcessReportAPIBase
    
    Returns:
    
    true if it will use the external output builder.
  - setUseExternalOutputBuilder
```
public void setUseExternalOutputBuilder(boolean useExternalOutputBuilder)
```
    Set to true to use the external output builder. The external output builder must be loaded and be capable of rendering from the template type to the output type, using all properties set in the ProcessReport object. Default is true.
    
    Specified by:
    
    setUseExternalOutputBuilder in interface ProcessReportAPIBase
    
    Parameters:
    
    useExternalOutputBuilder - true if it will use the external output builder.
  - getOutputBuilderData
```
public java.lang.Object getOutputBuilderData()
```
    Optional data to pass to the external output builder.
    
    Specified by:
    
    getOutputBuilderData in interface ProcessReportAPIBase
  - setOutputBuilderData
```
public void setOutputBuilderData(java.lang.Object outputBuilderData)
```
    Optional data to pass to the external output builder.
    
    Specified by:
    
    setOutputBuilderData in interface ProcessReportAPIBase
  - getDataMode
```
public int getDataMode()
```
    Get the embed data setting. Uses flags of EMBED_* constant ints. 0 for no embed.
    
    Specified by:
    
    getDataMode in interface ProcessReportAPIBase
    
    Returns:
    
    the embed data setting. Uses flags of EMBED_* constant ints.
  - setDataMode
```
public void setDataMode(int mode)
```
    Set the embed data setting. Uses flags of EMBED_* constant ints. 0 for no embed.
    
    Specified by:
    
    setDataMode in interface ProcessReportAPIBase
    
    Parameters:
    
    mode - the embed data setting. Uses flags of EMBED_* constant ints.
  - getDataStream
```
public java.io.OutputStream getDataStream()
                                   throws java.io.IOException,
                                          AlreadyProcessedException
```
    As the report is run, the data for each tag can also be placed in an associated data.xml file. This xml will have a node for each tag and depedning on the settings, the node will contain the tag attributes and/or the data extracted from the datasource for that tag.
    You can only call this method if getDataMode != 0. If you did not call setDataStream this will return a ByteArrayOutputStream with the generated data.xml file in UTF-8. You can only call this after calling processComplete.
    
    Specified by:
    
    getDataStream in interface ProcessReportAPIBase
    
    Returns:
    
    The generated data.xml file.
    
    Throws:
    
    java.io.IOException
    
    AlreadyProcessedException
  - setDataStream
```
public void setDataStream(java.io.OutputStream stream)
```
    As the report is run, the data for each tag can also be placed in an associated data.xml file. This xml will have a node for each tag and depending on the settings, the node will contain the tag attributes and/or the data extracted from the datasource for that tag.
    You may not call this if the DataMode includes DATA_MODE_EMBED. Calling this has no impact if DataMode == 0.
    
    Specified by:
    
    setDataStream in interface ProcessReportAPIBase
    
    Parameters:
    
    stream - The stream to write the data.xml file to.
  - getDataWriter
```
public net.windward.xmlreport.ProcessReport.DataWriter getDataWriter()
```
    This is not part of the official API. Do not call this.
    
    Returns:
    
    The writer for the data.xml file.
  - isIgnoreTags
```
public boolean isIgnoreTags()
```
    Returns:
    
    True if Windward tags should be ignored and treated as a normal part of the document.
  - setIgnoreTags
```
public void setIgnoreTags(boolean ignore)
```
    Parameters:
    
    ignore - True if Windward tags should be ignored and treated as a normal part of the document.
  - shutdown
```
public static void shutdown()
```
    Releases all resources held by Windward Reports. After calling this you cannot call any method in Windward Reports.
  - init
```
public static void init()
                 throws LicenseException,
                        SetupException
```
    This method should be called before any other code anywhere in Windward Reports. It can be called repeated times with no bad effects. While it is not necessary to call this method, it is recommended as this will verify the license and initialize the system. Otherwise these steps happen when the first report object is created.
    
    Throws:
    
    LicenseException - thrown if the license check fails. The message will list the license check that failed.
    
    SetupException
  - statLine
```
public static void statLine(java.lang.String msg,
                            boolean logIt)
```
  - setOutputBuilder
```
public static void setOutputBuilder(IOutputBuilderEngine outputBuilder)
                             throws SetupException
```
    Set the output builder. Use this method instead of the properties file if you want to provide an object. This must be called after init.
    
    Parameters:
    
    outputBuilder - The output builder to use.
    
    Throws:
    
    SetupException
  - isReportTypeExcel
```
public boolean isReportTypeExcel()
```
    True if the output report is an Excel file, including CSV.
    
    Specified by:
    
    isReportTypeExcel in interface ProcessReportAPIBase
    
    Returns:
    
    True if the output report is an Excel file
  - isReportTypeWord
```
public boolean isReportTypeWord()
```
    True if the output report is a Word file, including Rtf.
    
    Specified by:
    
    isReportTypeWord in interface ProcessReportAPIBase
    
    Returns:
    
    True if the output report is a Word file
  - isReportTypeDocx
```
public boolean isReportTypeDocx()
```
    True if the output report is a Word DOCX or DOCM file.
    
    Returns:
    
    True if the output report is a Word file
  - isReportTypePpt
```
public boolean isReportTypePpt()
```
    True if the output report is a PowerPoint file.
    
    Returns:
    
    True if the output report is a PowerPoint file
  - isReportTypeOpenXml
```
public boolean isReportTypeOpenXml()
```
    true if the report type is DOCX, PPTX, or XLSX.
  - isSameOpenXml
```
public boolean isSameOpenXml()
```
    true if the template and report output are the same OpenXML format. So true for DOCX -> DOCX, false for DOCX -> XLSX.
  - isTemplateTypeOpenXml
```
public boolean isTemplateTypeOpenXml()
```
    true if the template is a DOCX, XLSX, or PPTX.
  - isTemplateTypeDOCX
```
public boolean isTemplateTypeDOCX()
```
    true if the template is a DOCX.
  - isTemplateTypePPTX
```
public boolean isTemplateTypePPTX()
```
    true if the template is a PPTX.
  - isTemplateTypeXLSX
```
public boolean isTemplateTypeXLSX()
```
    true if the template is a XLSX.
  - getTemplateTypeString
```
public java.lang.String getTemplateTypeString()
```
    The extension of the template.
  - getChartRenderType
```
public int getChartRenderType()
```
    What HtmlImage.BITMAP_* type to render charts at for this ReportType.
  - 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
    
    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
    
    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
    
    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
    
    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.
  - setCharset
```
public void setCharset(int num)
```
    Html and txt files are generated using a charset (the rest use unicode). Normally html files are generated using utf-8 (unicode) except for HTML_1 which uses the native charset. Txt files are normally generated using the native charset. The native charset is not the java native charset, it is the default charset set in the template. This call allows you to force to charset the report is written in. The passed in value is the Windows codepage (Western Europe is 1252). This has nothing to do with reading in the template, it only affects the charset the output report is written in. The special constants CHARSET_* allow you to set this to values other than a specific charset.
    
    Specified by:
    
    setCharset in interface ProcessReportAPIBase
    
    Parameters:
    
    num - The charset to use when generating an html or txt report.
  - getCharset
```
public int getCharset()
```
    Html and txt files are generated using a charset (the rest use unicode). Normally html files are generated using utf-8 (unicode) except for HTML_1 which uses the native charset. Txt files are normally generated using the native charset. The native charset is not the java native charset, it is the default charset set in the template document. This call allows you to force to charset the report is written in. The passed in value is the Windows codepage (Western Europe is 1252). This has nothing to do with reading in the template, it only affects the charset the output report is written in. The special constants CHARSET_* allow you to set this to values other than a specific charset.
    
    Specified by:
    
    getCharset in interface ProcessReportAPIBase
    
    Returns:
    
    The charset to use when generating an html or txt report.
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    This call set's the locale used in creating a report. If not set, the default is not the system locale - it is the locale of the report template. This affects; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>.
    
    The passed in value can be any locale or the values LOCALE_DEFAULT or LOCALE_SYSTEM. LOCALE_DEFAULT will use the locale in the report template. LOCALE_DEFAULT will use the system locale.
    
    Specified by:
    
    setLocale in interface ProcessReportAPIBase
    
    Parameters:
    
    locale - The locale to use when generating a report.
  - getLocale
```
public java.util.Locale getLocale()
```
    This call returns the locale used in creating a report. This method should not be called until after the report template has been parsed.. This is used by; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>.
    
    This will return null if set to LOCALE_DEFAULT until after the template has been parsed. Once the template has been parsed it will return the locale of the template in that case.
    
    Specified by:
    
    getLocale in interface ProcessReportAPIBase
    
    Returns:
    
    The locale used when generating areport.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Set the description of the document. For phone home reports only, this will be written to the run entry in the database.
    
    Specified by:
    
    setDescription in interface ProcessReportAPIBase
    
    Parameters:
    
    description - The value of the description.
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description of the document. For phone home reports only, this will be written to the run entry in the database.
    
    Specified by:
    
    getDescription in interface ProcessReportAPIBase
    
    Returns:
    
    The value of the description.
  - setTitle
```
public void setTitle(java.lang.String docTitle)
```
    Set the title of the document.
    
    Specified by:
    
    setTitle in interface ProcessReportAPIBase
    
    Parameters:
    
    docTitle - The value of the title.
  - getTitle
```
public java.lang.String getTitle()
```
    Get the title of the document.
    
    Specified by:
    
    getTitle in interface ProcessReportAPIBase
    
    Returns:
    
    The value of the title.
  - setSubject
```
public void setSubject(java.lang.String docSubject)
```
    Set the subject of the document.
    
    Specified by:
    
    setSubject in interface ProcessReportAPIBase
    
    Parameters:
    
    docSubject - The value of the subject.
  - getSubject
```
public java.lang.String getSubject()
```
    Get the subject of the document.
    
    Specified by:
    
    getSubject in interface ProcessReportAPIBase
    
    Returns:
    
    The value of the subject.
  - setKeywords
```
public void setKeywords(java.lang.String docKeywords)
```
    Set the keywords of the document. This are delimited by a ','.
    
    Specified by:
    
    setKeywords in interface ProcessReportAPIBase
    
    Parameters:
    
    docKeywords - The value of the keywords.
  - getKeywords
```
public java.lang.String getKeywords()
```
    Get the keywords of the document. They are delimited by a ','.
    
    Specified by:
    
    getKeywords in interface ProcessReportAPIBase
    
    Returns:
    
    The value of the keywords.
  - isPageBasedReport
```
public boolean isPageBasedReport()
```
    true if the generated report is page based. PDF & printer output.
    
    Specified by:
    
    isPageBasedReport in interface ProcessReportAPIBase
    
    Returns:
    
    true if the generated report is page based.
  - setDebugMode
```
public void setDebugMode(boolean debugOn)
```
    Set debug mode on or off. If debug mode is on, common user errors will be written to the report rather than throwing an exception.
    
    Specified by:
    
    setDebugMode in interface ProcessReportAPIBase
    
    Parameters:
    
    debugOn - Set to true to set debug mode on.
  - isDebugMode
```
public boolean isDebugMode()
```
    Get if debug mode is on or off.
    
    Specified by:
    
    isDebugMode in interface ProcessReportAPIBase
    
    Returns:
    
    The type true if debug mode is on.
  - setParameters
```
public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)
```
    Description copied from interface: ProcessReportAPIBase
    
    Adds a map that is used for ${variable} substitution. When ${key} is found in any tag, it is replaced with the matching value. The key and value strings are not evaluated in any way, it is just a text substitution. This replace occurs before any other evaluation of a tag so the value string can have ${variable} values that will then be evaluated. This makes a shallow copy creating a new map object, but copying the map entries across.
    These parameters are shared by all datasources. If one datasource adds, removes, or changes a parameter, all other datasources see this change.
    This call sets the map so calling it a second time replaces the map passed in the first time. The map is copied so on return changes to the passed in map will not affect the data source.
    The values passed in a map must be a String, Number (Integer, Float, etc), Date, or SelectBase derived class.
    
    Specified by:
    
    setParameters in interface ProcessReportAPIBase
    
    Parameters:
    
    parameters - The map of parameter pairs.
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getParameters()
```
    Description copied from interface: ProcessReportAPIBase
    
    Returns the map of parameters for this report. This returns the underlying map so changes to the returned map will change the values in this object's map.
    These parameters are shared by all datasources. If one datasource adds, removes, or changes a parameter, all other datasources see this change.
    
    Specified by:
    
    getParameters in interface ProcessReportAPIBase
    
    Returns:
    
    the map of parameters for this report.
  - setBaseDirectory
```
public void setBaseDirectory(java.lang.String directory)
```
    Set the base directory used for imported files that have a relative path.
    
    Specified by:
    
    setBaseDirectory in interface ProcessReportAPIBase
    
    Parameters:
    
    directory - The base directory. Does not need to have a final /.
  - getBaseDirectory
```
public java.lang.String getBaseDirectory()
```
    Get the base directory used for imported files that have a relative path.
    
    Specified by:
    
    getBaseDirectory in interface ProcessReportAPIBase
    
    Returns:
    
    The base directory. Will always have a trailing /.
  - setDrillDownInfo
```
public void setDrillDownInfo(ProcessReport.DrillDownTemplate drillDownInfo)
```
    Set the info for the template file this is in. This is used only for DrillDown links and is not part of the public API.
    
    Specified by:
    
    setDrillDownInfo in interface ProcessReportAPIBase
    
    Parameters:
    
    drillDownInfo - The template info.
  - getDrillDownInfo
```
public ProcessReport.DrillDownTemplate getDrillDownInfo()
```
    Get the info for the template file this is in. This is used only for DrillDown links and is not part of the public API.
    
    Specified by:
    
    getDrillDownInfo in interface ProcessReportAPIBase
    
    Returns:
    
    The template info.
  - getNumPages
```
public int getNumPages()
```
    Returns how many pages long a report is. Can only be called after process completes. For html and text reports (which by definition are 1 page long) it will return the number of pages it would be if it was a paged report.
    
    Specified by:
    
    getNumPages in interface ProcessReportAPIBase
    
    Returns:
    
    The number of pages in the completed document.
  - hasDatasourcesApplied
```
public boolean hasDatasourcesApplied()
```
    true if datasources have been applied to this report.
    
    Returns:
    
    true if datasources have been applied to this report.
  - processSetup
```
public void processSetup()
                  throws AlreadyProcessedException,
                         TemplateParseException,
                         java.io.IOException,
                         TagException,
                         DataSourceException,
                         LicenseException,
                         OutputLimitationException
```
    Process the template and get the report ready to process data files. This should only be called once for a given ProcessReport object! This method can only be called by objects create with ProcessReport(template) or ProcessReport(template, report).
    
    Specified by:
    
    processSetup in interface ProcessReportAPIBase
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
  - processSetup
```
public void processSetup(int inputType)
                  throws AlreadyProcessedException,
                         TemplateParseException,
                         java.io.IOException,
                         TagException,
                         DataSourceException,
                         LicenseException,
                         OutputLimitationException
```
    Process the template and get the report ready to process data files. This should only be called once for a given ProcessReport object! This method can only be called by objects create with ProcessReport(template) or ProcessReport(template, report).
    
    Specified by:
    
    processSetup in interface ProcessReportAPIBase
    
    Parameters:
    
    inputType - The format of the input template. Use one of the INPUT_FILE_TYPE_* integers.
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
  - checkTimeout
```
public void checkTimeout()
```
    This is NOT part of the public API. This will throw a TimeoutException if called and the report is past the timeout end time.
  - getChartProvider
```
public ChartProvider getChartProvider()
```
    Returns the chart provider used for this process. The default is ChartDirectorChartProvider. This is not part of the public API.
    
    Returns:
    
    The chart provider in use.
  - loadTemplate
```
public Document loadTemplate(java.io.InputStream file,
                             int type,
                             DocHeader hdr,
                             DocBody parentDoc,
                             boolean removeUnusedFormats,
                             java.lang.String encoding,
                             java.lang.String[] importStack)
                      throws java.io.IOException,
                             TemplateParseException,
                             TagException,
                             DataSourceException,
                             OutputLimitationException
```
    This is not part of the official API. This reads in a template file from the passed in stream and returns a Document which has been processed up to and including tag substitution. This is also used to import one template file into another template file. Do not use this method!
    
    Parameters:
    
    file - The stream to read the template from.
    
    type - Use one of the INPUT_FILE_TYPE_* static ints.
    
    hdr - The header of the body this is being inserted into. Null if the main template.
    
    parentDoc - The body this is being inserted into. Null if the main template.
    
    removeUnusedFormats - true to remove unused formats from the returned template.
    
    encoding - The encoding in palce for this template.
    
    importStack - The import stack if this is for an import
    
    Returns:
    
    The processed file.
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
  - getTemplateMetrics
```
public static TemplateInfo getTemplateMetrics(java.io.InputStream file)
                                       throws SetupException,
                                              TemplateParseException,
                                              DataSourceException,
                                              java.io.IOException,
                                              TagException,
                                              AlreadyProcessedException,
                                              OutputLimitationException,
                                              TinyException
```
    Returns information about all vars, datasources, and tags referenced in the template. If there is a <wr:set var='name' value='3'/> that will not be in this vars list.
    
    Parameters:
    
    file - The stream to read the template from.
    
    Returns:
    
    The information about of all vars, datasources, and tags.
    
    Throws:
    
    AlreadyProcessedException - thrown if setup not called or complete called.
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    SetupException
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - getTemplateMetrics
```
public static TemplateInfo getTemplateMetrics(java.io.InputStream file,
                                              boolean quiet,
                                              boolean ignoreTags)
                                       throws SetupException,
                                              TemplateParseException,
                                              DataSourceException,
                                              java.io.IOException,
                                              TagException,
                                              AlreadyProcessedException,
                                              OutputLimitationException,
                                              TinyException
```
    Throws:
    
    SetupException
    
    TemplateParseException
    
    DataSourceException
    
    java.io.IOException
    
    TagException
    
    AlreadyProcessedException
    
    OutputLimitationException
    
    TinyException
  - getTemplateMetrics
```
public static TemplateInfo getTemplateMetrics(java.io.InputStream file,
                                              boolean quiet)
                                       throws SetupException,
                                              TemplateParseException,
                                              DataSourceException,
                                              java.io.IOException,
                                              TagException,
                                              AlreadyProcessedException,
                                              OutputLimitationException,
                                              TinyException
```
    Returns information about all vars, datasources, and tags referenced in the template. If there is a <wr:set var='name' value='3'/> that will not be in this vars list.
    
    Parameters:
    
    file - The stream to read the template from.
    
    Returns:
    
    The information about of all vars, datasources, and tags.
    
    Throws:
    
    AlreadyProcessedException - thrown if setup not called or complete called.
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    SetupException
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - clean
```
public static void clean(java.io.InputStream template,
                         java.io.OutputStream cleanedStream,
                         int cleanedType,
                         boolean removeUnused,
                         int tagStyle,
                         ProcessReport.CleanDatasource[] datasources,
                         int paramMode,
                         int templateVersion)
                  throws SetupException,
                         TemplateParseException,
                         DataSourceException,
                         java.io.IOException,
                         TagException,
                         AlreadyProcessedException,
                         OutputLimitationException,
                         TinyException
```
    Clean the requested template.
    
    Parameters:
    
    template - The input template stream.
    
    cleanedStream - The stream to write the cleaned template to.
    
    cleanedType - The ProcessReport.TEMPLATE_TYPE_* type for the cleaned template.
    
    removeUnused - true to remove unused styles, fonts, etc.
    
    tagStyle - The style tags are written out as. Is one of the ProcessReport.TAG_STYLE_* values.
    
    datasources - The type of each datasource to be cleaned.
    
    paramMode - The BaseTag.PARAM_MODE_* to convert tags to.
    
    templateVersion - The version the template was created under. -1 for unknown.
    
    Throws:
    
    SetupException
    
    TemplateParseException
    
    DataSourceException
    
    java.io.IOException
    
    TagException
    
    AlreadyProcessedException
    
    OutputLimitationException
    
    TinyException
  - clean
```
public static void clean(java.io.InputStream template,
                         java.io.OutputStream cleanedStream,
                         int cleanedType,
                         boolean removeUnused,
                         int tagStyle,
                         ProcessReport.CleanDatasource[] datasources,
                         int paramMode,
                         int templateVersion,
                         boolean fixExpressions)
                  throws SetupException,
                         TemplateParseException,
                         DataSourceException,
                         java.io.IOException,
                         TagException,
                         AlreadyProcessedException,
                         OutputLimitationException,
                         TinyException
```
    Clean the requested template.
    
    Parameters:
    
    template - The input template stream.
    
    cleanedStream - The stream to write the cleaned template to.
    
    cleanedType - The ProcessReport.TEMPLATE_TYPE_* type for the cleaned template.
    
    removeUnused - true to remove unused styles, fonts, etc.
    
    tagStyle - The style tags are written out as. Is one of the ProcessReport.TAG_STYLE_* values.
    
    datasources - The type of each datasource to be cleaned.
    
    paramMode - The BaseTag.PARAM_MODE_* to convert tags to.
    
    templateVersion - The version the template was created under. -1 for unknown.
    
    fixExpressions - Attempt to fix evaluable expressions.
    
    Throws:
    
    SetupException
    
    TemplateParseException
    
    DataSourceException
    
    java.io.IOException
    
    TagException
    
    AlreadyProcessedException
    
    OutputLimitationException
    
    TinyException
  - buildSchema
```
public void buildSchema(java.io.OutputStream xmlSchema)
                 throws java.io.IOException,
                        DataSourceException,
                        TagException,
                        AlreadyProcessedException
```
    Generates a UDT schema XML files based on the tags in the template.
    
    Specified by:
    
    buildSchema in interface ProcessReportAPIBase
    
    Parameters:
    
    xmlSchema - The schema XML file created.
    
    Throws:
    
    AlreadyProcessedException - thrown if setup not called or complete called.
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
  - setEventHandler
```
public void setEventHandler(WindwardEventHandler eventHandler)
```
    Assign event handler to the report. This object is called during specific events in the report processing and is available in custom functions (macros).
    
    Specified by:
    
    setEventHandler in interface ProcessReportAPIBase
    
    Parameters:
    
    eventHandler - The event handler for this report.
  - getEventHandler
```
public WindwardEventHandler getEventHandler()
```
    Get event handler assigned to the report. This object is called during specific events in the report processing and is available in custom functions (macros).
    
    Specified by:
    
    getEventHandler in interface ProcessReportAPIBase
    
    Returns:
    
    The event handler for this report.
  - getDebugHandler
```
public IDebugHandler getDebugHandler()
```
    The debug handler assigned to this report if debugging.
    
    Returns:
    
    The debug handler assigned to this report.
  - setDebugHandler
```
public void setDebugHandler(IDebugHandler debugHandler)
```
    The debug handler assigned to this report if debugging.
    With power comes responsibility. Using this feature gives you the ability to honk up report generation. So be careful.
    Running with this on will slow down report generation - a lot!
    
    Parameters:
    
    debugHandler - The debug handler assigned to this report.
  - cleanSelects
```
public void cleanSelects(ProcessReport.CleanDatasource[] arrDatasources,
                         int mode)
                  throws AlreadyProcessedException
```
    This is not part of the official API - do not use this. This will convert selects to the parameter syntax and convert to always using select=
    
    Parameters:
    
    arrDatasources - The names of the datasources to convert.
    
    mode - The BaseTag.PARAM_MODE_* to convert to.
    
    Throws:
    
    AlreadyProcessedException
  - cleanSelects
```
public void cleanSelects(ProcessReport.CleanDatasource[] arrDatasources,
                         int mode,
                         boolean fixExpressions)
                  throws AlreadyProcessedException
```
    This is not part of the official API - do not use this. This will convert selects to the parameter syntax and convert to always using select=
    
    Parameters:
    
    arrDatasources - The names of the datasources to convert.
    
    mode - The BaseTag.PARAM_MODE_* to convert to.
    
    fixExpressions - Attempt to fix evaluable expressions.
    
    Throws:
    
    AlreadyProcessedException
  - processData
```
public void processData(DataSourceProvider datasourceProvider,
                        java.lang.String datasourceName)
                 throws java.io.IOException,
                        TagException,
                        AlreadyProcessedException,
                        DataSourceException,
                        TemplateParseException,
                        OutputLimitationException,
                        TinyException
```
    Process a set of data for the report. This method can be called multiple times - but only once for each datasource. This method can only be called by objects create with ProcessReport(template) or ProcessReport(template, report).
    Do not pass in buffered streams if you have the option. ProcessReport wraps all streams in buffers, generally BufferedReader and BufferedWriter.
    
    Specified by:
    
    processData in interface ProcessReportAPIBase
    
    Parameters:
    
    datasourceProvider - The data that will be placed into the report where there are tags.
    
    datasourceName - The name of the datasource to process. Only tags with this datasource will be processed. A value of "" is legitimate and signifies the default datasource.
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - processData
```
public void processData(java.util.Map<java.lang.String,DataSourceProvider> dataProviders)
                 throws java.io.IOException,
                        TagException,
                        AlreadyProcessedException,
                        DataSourceException,
                        TemplateParseException,
                        OutputLimitationException,
                        TinyException
```
    Processes multiple sets of data for the report. This method can be called multiple times - but only once for each datasource. This method can only be called by objects create with ProcessReport(template) or ProcessReport(template, report).
    Do not pass in buffered streams if you have the option. ProcessReport wraps all streams in buffers, generally BufferedReader and BufferedWriter.
    
    Specified by:
    
    processData in interface ProcessReportAPIBase
    
    Parameters:
    
    dataProviders -
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - batchSetup
```
public void batchSetup(java.util.Map<java.lang.String,DataSourceProvider> dataProviders,
                       java.lang.String batchForEach,
                       java.util.Map<java.lang.String,java.lang.String> parameters)
                throws TagException,
                       AlreadyProcessedException,
                       DataSourceException
```
    Prepares the object to run batch reports. After this setup batchNext() can be called repetitively for each batched report.
    
    Specified by:
    
    batchSetup in interface ProcessReportAPIBase
    
    Parameters:
    
    dataProviders - All of the datasources to process. key = the name of the datasource, value = the datasource.
    
    batchForEach - The text of a forEach tag that is the batch query. The datasource for this tag must be in the dataProviders.
    
    parameters - Parameters that may have ${var} parameters in the value part of the entry. This is returned in each iteration with the ${var} values substituted with the string value of that var. The key value is ignored by the engine.
    
    Throws:
    
    TagException
    
    AlreadyProcessedException
    
    DataSourceException
  - batchNext
```
public BatchReport batchNext(java.io.OutputStream report)
                      throws java.io.IOException,
                             TagException,
                             AlreadyProcessedException,
                             DataSourceException,
                             TemplateParseException,
                             OutputLimitationException,
                             TinyException
```
    Generates the next document in the batch and returns the results of that document. Returns null if no more to run. Performs the equivilent of processData(), processComplete() for each generated report.
    
    Specified by:
    
    batchNext in interface ProcessReportAPIBase
    
    Parameters:
    
    report - The stream to write the generated report to. If null the engine will create a ByteArrayOutputStream.
    
    Returns:
    
    The generated document and a way to make calls on the returned object to get ${vars} for the batch iteration.
    
    Throws:
    
    java.io.IOException
    
    TagException
    
    AlreadyProcessedException
    
    DataSourceException
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - updatePods
```
public void updatePods(UdtUpdate[] pods)
                throws DataSourceException,
                       java.io.IOException,
                       TagException,
                       TemplateParseException,
                       OutputLimitationException,
                       TinyException
```
    Deprecated. Use the import tag instead for content that needs to be updated.
    
    Update the Pods. You need to call setup, this method, and then complete.
    
    Specified by:
    
    updatePods in interface ProcessReportAPIBase
    
    Parameters:
    
    pods - The Pods to update in the template.
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - mergePodItemStyles
```
public byte[] mergePodItemStyles(byte[] podItemData,
                                 boolean usePodStyles)
                          throws java.lang.Exception
```
    This is not part of the official API. Do not call this.
    
    Throws:
    
    java.lang.Exception
  - findPodsUsed
```
public java.util.List<java.lang.String> findPodsUsed()
                                              throws DataSourceException,
                                                     java.io.IOException,
                                                     TagException,
                                                     TemplateParseException,
                                                     OutputLimitationException,
                                                     TinyException
```
    Find Pod's being used by a Document. You need to call setup, this method, and then complete.
    
    Specified by:
    
    findPodsUsed in interface ProcessReportAPIBase
    
    Returns:
    
    String List of Pod GUIDs being used by the document.
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - processComplete
```
public long processComplete()
                     throws java.io.IOException,
                            TagException,
                            AlreadyProcessedException,
                            DataSourceException,
                            LicenseException,
                            OutputLimitationException,
                            TemplateParseException,
                            TinyException
```
    Process the final report and create the output. This must be called after processData and before getReport. This should only be called once for a given ProcessReport object! This method can only be called by objects create with ProcessReport(template) or ProcessReport(template, report).
    
    Specified by:
    
    processComplete in interface ProcessReportAPIBase
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    OutputLimitationException
    
    TemplateParseException
    
    TinyException
  - getImportInfo
```
public ImportInfo[] getImportInfo()
```
    Get all imports in the processed template. This must be called after processData as that is what finds the imports. You must call setTrackImports(true); before processing for this value to be populated.
    
    Specified by:
    
    getImportInfo in interface ProcessReportAPIBase
    
    Returns:
    
    all imports in the processed template.
  - addImportInfo
```
public void addImportInfo(java.util.List importInfo)
```
    This is not part of the public API - do not use.
  - setTrackErrors
```
public void setTrackErrors(int flag)
```
    Description copied from interface: ProcessReportAPIBase
    
    Enable or disable the error handling and verify features. If they are enabled you can call getErrorInfo() to get a list of errors encounterred during the report generation.
    By default these features are turned off (disabled).
    
    Specified by:
    
    setTrackErrors in interface ProcessReportAPIBase
    
    Parameters:
    
    flag - A combination of ERROR_HANDLING_ bits.
  - getErrorInfo
```
public ErrorInfo getErrorInfo()
```
    Description copied from interface: ProcessReportAPIBase
    
    Get an object containing a set of errors encounterred during the report generation. To enable the errors tracking you have to turn this feature on by a call to setTrackErrors().
    
    Specified by:
    
    getErrorInfo in interface ProcessReportAPIBase
    
    Returns:
    
    An instance of the ErrorInfo implementation.
  - getReport
```
public java.io.OutputStream getReport()
                               throws AlreadyProcessedException
```
    Return the final report. In the case of the ProcessReport(template) constructor, this is gauranteed to be of type ByteArrayOutputStream. If an out stream is passed in during construction, this will return that stream. This can only be called after process() or processData().
    
    Specified by:
    
    getReport in interface ProcessReportAPIBase
    
    Returns:
    
    The report as a stream.
    
    Throws:
    
    AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.
  - process
```
public void process()
             throws LicenseException,
                    java.io.IOException,
                    TemplateParseException,
                    java.lang.IllegalArgumentException,
                    TagException,
                    AlreadyProcessedException,
                    DataSourceException,
                    OutputLimitationException,
                    TinyException
```
    Create a report from the input streams, writing it to the output (report) stream. This should only be called once for a given ProcessReport object! This call is the equivilent of calling:
    processSetup();
    processData(data, "");
    processComplete();
    This can only be called on objects that were created with ProcessReport(xmlData, template, report).
    
    Specified by:
    
    process in interface ProcessReportAPIBase
    
    Throws:
    
    java.io.IOException - thrown if have problems accessing the xml, template, or report streams.
    
    LicenseException - thrown if called too often for the license type.
    
    TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.
    
    AlreadyProcessedException - thrown if call process multiple times on an object.
    
    DataSourceException - thrown if there is a problem with the datasource.
    
    java.lang.IllegalArgumentException - thrown if come across an unknown element type or an illegal reportType value is used.
    
    TemplateParseException
    
    OutputLimitationException
    
    TinyException
  - adjustFontName
```
public java.lang.String adjustFontName(DocHeader hdr,
                                       java.lang.String font)
```
    Return the font name.
    
    Parameters:
    
    hdr - The header holding the font table.
    
    font - The index into the header font table for this font.
    
    Returns:
    
    The font name.
  - adjustFontSize
```
public int adjustFontSize(int size)
```
    Return the font size.
    
    Parameters:
    
    size - The size of the font in half points.
    
    Returns:
    
    The font size in half points.
  - close
```
public void close()
```
    Call when you are done with this object, including done with the OutputStream returned by getReport if that stream was created by ProcessReport.
    
    Specified by:
    
    close in interface ProcessReportAPIBase

Class ProcessReport

Nested Class Summary

Field Summary

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

Field Detail

TEMPLATE_TYPE_UNKNOWN

TEMPLATE_TYPE_HTML

TEMPLATE_TYPE_DOCX

TEMPLATE_TYPE_XLSX

TEMPLATE_TYPE_PPTX

TEMPLATE_TYPE_XLSM

TEMPLATE_TYPE_DOCM

TEMPLATE_TYPE_PPTM

Constructor Detail

ProcessReport

ProcessReport

ProcessReport

ProcessReport

ProcessReport

ProcessReport

Method Detail

getVersionMajor

getVersionMinor

getVersionRelease

getVersion

getCompany

getMaxReportPages

getWriteTags

setWriteTags

setTemplateVersion

getTemplateVersion

isPreservePodFraming

setPreservePodFraming

isTrackImports

setTrackImports

setRemoveUnusedFormats

isRemoveUnusedFormats

setTimeout

getTimeout

abort

getCopyMetadata

setCopyMetadata

getHyphenate

setHyphenate

isCopyEmbeddedObjects

setCopyEmbeddedObjects

performLayout

isLayoutDocument

setLayoutDocument

getHiddenMode

setHiddenMode

isUseExternalOutputBuilder

setUseExternalOutputBuilder

getOutputBuilderData

setOutputBuilderData

getDataMode

setDataMode

getDataStream

setDataStream

getDataWriter

isIgnoreTags

setIgnoreTags

shutdown

init

statLine

setOutputBuilder

isReportTypeExcel

isReportTypeWord

isReportTypeDocx

isReportTypePpt

isReportTypeOpenXml

isSameOpenXml

isTemplateTypeOpenXml

isTemplateTypeDOCX

isTemplateTypePPTX

isTemplateTypeXLSX