net.windward.xmlreport

Interface ProcessReportAPIBase

All Known Subinterfaces:

ProcessCsvAPI, ProcessDocxAPI, ProcessHtmlAPI, ProcessOpenXmlAPI, ProcessPdfAPI, ProcessPptxAPI, ProcessPrinterAPI, ProcessReportAPI, ProcessRtfAPI, ProcessTxtAPI, ProcessXlsxAPI

All Known Implementing Classes:

ProcessCsv, ProcessDocx, ProcessGraphics2D, ProcessHtml, ProcessImage, ProcessOpenXml, ProcessPdf, ProcessPostScript, ProcessPptx, ProcessPrinter, ProcessReport, ProcessRtf, ProcessTxt, ProcessXlsx

public interface ProcessReportAPIBase

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. This class exists seperate from ProcessReportAPI because of the .net version.

Version:

2.0 2 January 2004

Method Summary

Modifier and Type	Method and Description
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> batchParameters) 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	close() Call when you are done with this object, including done with the OutputStream returned by getReport if that stream was created by ProcessReport.
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Creates and returns a copy of this object.
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() This call set's the locale used in creating a report.
int	getCopyMetadata() Get if the Windward metadata will be copied to the generated report.
int	getDataMode() As the report is run, the data for each tag can also be placed in an associated data.xml file.
java.io.OutputStream	getDataStream() As the report is run, the data for each tag can also be placed in an associated data.xml file.
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.
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.
int	getReportType() Get the report format of the output stream.
java.lang.String	getReportTypeString() Get the report format of the output as a string.
java.lang.String	getSubject() Get the subject of the document.
int	getTemplateVersion() Set the version 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.
int	getWriteTags() Get the style unprocessed tags are written out as.
boolean	isCopyEmbeddedObjects() True if embedded objects are to be copied to output.
boolean	isDebugMode() Get if debug mode is on or off.
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 UDT framing should be preserved for UDTs in the document.
boolean	isRemoveUnusedFormats() True to remove all unused formatting information from the template when rendering the report.
boolean	isReportTypeExcel() True if the output report is an Excel file, including CSV.
boolean	isReportTypeWord() True if the output report is a Word file, including Rtf.
boolean	isTrackImports() True if you want to call getImports after processing datasources.
boolean	isUseExternalOutputBuilder() Returns true if it will use the external output builder.
void	process() Create a report from the input template & datasource(s), writing it to the output (report) stream.
long	processComplete() Process the final report and create the output.
void	processData(DataSourceProvider data, java.lang.String datasource) Process a set of data for the report.
void	processData(java.util.Map<java.lang.String,DataSourceProvider> dataProviders) Process 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 others 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) As the report is run, the data for each tag can also be placed in an associated data.xml file.
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	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 templateInfo) 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	setKeywords(java.lang.String keywords) 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.
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 UDT framing should be preserved for UDTs 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 subject) Set the subject of the document.
void	setTemplateVersion(int version) Set the version 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 title) 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.
void	updatePods(UdtUpdate[] udts) Update the UDTs.

Method Detail

getRenderExtent

int getRenderExtent()

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

Returns:

a ProcessReportAPI.RENDER_EXTENT_* value.

setRenderExtent

void setRenderExtent(int extent)

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.

Parameters:

extent - a ProcessReportAPI.RENDER_EXTENT_* value.

getRenderPages

java.lang.String getRenderPages()

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.

Returns:

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

setRenderPages

void setRenderPages(java.lang.String pages)

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.

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

void setCharset(int num)

Html and txt files are generated using a charset (the others 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 rtf 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.

Parameters:

num - The charset to use when generating an html or txt report.

getCharset

int getCharset()

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 the locale used for <wr:out>. This call allows you to force the locale the report is written in. The passed in value is the Windows country/language number (English (U.S.) is 0x0409). This has nothing to do with reading in the template, it only affects the output. The special constant LOCALE_DEFAULT will have the system use the template's locale.

Returns:

The charset to use when generating an html or txt report.

setLocale

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.

Parameters:

locale - The locale to use when generating a report.

getLocale

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.

Returns:

The locale used when generating areport.

getReportType

int getReportType()

Get the report format of the output stream.

Returns:

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

getReportTypeString

java.lang.String getReportTypeString()

Get the report format of the output as a string.

Returns:

"docx", "xlsx", ...

isPageBasedReport

boolean isPageBasedReport()

true if the generated report is page based. PDF & printer output.

Returns:

true if the generated report is page based.

isReportTypeExcel

boolean isReportTypeExcel()

True if the output report is an Excel file, including CSV.

Returns:

True if the output report is an Excel file

isReportTypeWord

boolean isReportTypeWord()

True if the output report is a Word file, including Rtf.

Returns:

True if the output report is a Word file

setDescription

void setDescription(java.lang.String description)

Set the description of the document. For Windward Scout reports only, this will be written to the run entry in the database.

Parameters:

description - The value of the description.

getDescription

java.lang.String getDescription()

Get the description of the document. For Windward Scout reports only, this will be written to the run entry in the database.

Returns:

The value of the description.

setTitle

void setTitle(java.lang.String title)

Set the title of the document. In html this will set both the TITLE tag and the title meta-tag.

Parameters:

title - The value of the title.

getTitle

java.lang.String getTitle()

Get the title of the document. In html this will set both the TITLE tag and the title meta-tag.

Returns:

The value of the title.

setSubject

void setSubject(java.lang.String subject)

Set the subject of the document. In html this will set the description meta-tag.

Parameters:

subject - The value of the subject.

getSubject

java.lang.String getSubject()

Get the subject of the document. In html this will set the description meta-tag.

Returns:

The value of the subject.

setKeywords

void setKeywords(java.lang.String keywords)

Set the keywords of the document. This are delimited by a ','. In html this will set the keywords meta-tag.

Parameters:

keywords - The value of the keywords.

getKeywords

java.lang.String getKeywords()

Get the keywords of the document. They are delimited by a ','. In html this will set the keywords meta-tag.

Returns:

The value of the keywords.

setDebugMode

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.

Parameters:

debugOn - Set to true to set debug mode on.

isDebugMode

boolean isDebugMode()

Get if debug mode is on or off.

Returns:

The type true if debug mode is on.

setParameters

void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

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.

Parameters:

parameters - The map of parameter pairs.

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()

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.

Returns:

the map of parameters for this report.

setDrillDownInfo

void setDrillDownInfo(ProcessReport.DrillDownTemplate templateInfo)

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.

Parameters:

templateInfo - The template info.

getDrillDownInfo

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.

Returns:

The template info.

setBaseDirectory

void setBaseDirectory(java.lang.String directory)

Set the base directory used for imported files that have a relative path.

Parameters:

directory - The base directory. Does not need to have a final /.

getBaseDirectory

java.lang.String getBaseDirectory()

Get the base directory used for imported files that have a relative path.

Returns:

The base directory. Will always have a trailing /.

getWriteTags

int getWriteTags()

Get the style unprocessed tags are written out as. Is one of the TAG_STYLE_* values.

Returns:

the style unprocessed tags are written out as.

setWriteTags

void setWriteTags(int tagStyle)

Set the style unprocessed tags are written out as. Is one of the TAG_STYLE_* values.

Parameters:

tagStyle - the style unprocessed tags are written out as.

setTemplateVersion

void setTemplateVersion(int version)

Set the version of Windward/AutoTag this template was created for. The default is the latest version number.

Parameters:

version - The major version number the report was created in.

getTemplateVersion

int getTemplateVersion()

Set the version of Windward/AutoTag this template was created for. The default is the latest version number.

Returns:

The major version number the report was created in.

isPreservePodFraming

boolean isPreservePodFraming()

True if UDT framing should be preserved for UDTs in the document. This is only valid for an OpenXML output format. The default is false.

Returns:

true if UDT framing should be preserved for UDTs in the document.

setPreservePodFraming

void setPreservePodFraming(boolean preserve)

True if UDT framing should be preserved for UDTs in the document. This is only valid for an OpenXML output format. The default is false.

Parameters:

preserve - true if UDT framing should be preserved for UDTs in the document.

isTrackImports

boolean isTrackImports()

True if you want to call getImports after processing datasources. Default is false.

Returns:

True if you want to call getImports after processing datasources.

setTrackImports

void setTrackImports(boolean trackImports)

True if you want to call getImports after processing datasources. Default is false.

Parameters:

trackImports - True if you want to call getImports after processing datasources.

isRemoveUnusedFormats

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.

Returns:

true if removing all unused formatting in the generated report.

setRemoveUnusedFormats

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.

Parameters:

remove - true if removing all unused formatting in the generated report.

setTimeout

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.

Parameters:

seconds - The number of seconds to timeout report generation at. 0 for no timeout.

getTimeout

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.

Returns:

The number of seconds to timeout report generation at. 0 for no timeout.

getCopyMetadata

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.

Returns:

one of the COPY_* static ints.

setCopyMetadata

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.

Parameters:

copy - one of the COPY_* static ints.

getHyphenate

int getHyphenate()

Get if the generated report will be hyphenated. The default is HYPHENATE_TEMPLATE.

Returns:

One of the HYPHENATE_* constants.

setHyphenate

void setHyphenate(int mode)

Set if the generated report will be hyphenated.

Parameters:

mode - One of the HYPHENATE_* constants.

isCopyEmbeddedObjects

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.

Returns:

true if embedded objects are to be copied to output.

setCopyEmbeddedObjects

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.

Parameters:

copyEmbeddedObjects - true if embedded objects are to be copied to output.

getHiddenMode

int getHiddenMode()

Get the mode for handling hidden objecxts in the template. Uses a bitmas of the HIDDEN_* constant ints.

Returns:

The mode for handling hidden objecxts in the template.

setHiddenMode

void setHiddenMode(int mode)

Get the mode for handling hidden objecxts in the template. Uses flags of the HIDDEN_* constant ints.

Parameters:

mode - The mode for handling hidden objecxts in the template.

getDataMode

int getDataMode()

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. This data file can be returned to the caller and/or embedded in the generated report. The embed option is only for OpenXML and PDF reports. Get the data setting. Uses flags of DATA_MODE_* constant ints. 0 for no data file.

Returns:

the data setting. Uses flags of DATA_MODE_* constant ints.

setDataMode

void setDataMode(int mode)

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. This data file can be returned to the caller and/or embedded in the generated report. The embed option is only for OpenXML and PDF reports. Set the data setting. Uses flags of DATA_MODE_* constant ints. 0 for no data file.

Parameters:

mode - the data setting. Uses flags of DATA_MODE_* constant ints.

isLayoutDocument

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

Returns:

true if the documenty is laid out, false if that step is skipped. Default is true.

setLayoutDocument

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

Parameters:

layoutDocument - true if the documenty is laid out, false if that step is skipped. Default is true.

isUseExternalOutputBuilder

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.

Returns:

true if it will use the external output builder.

setUseExternalOutputBuilder

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.

Parameters:

useExternalOutputBuilder - true if it will use the external output builder.

getOutputBuilderData

java.lang.Object getOutputBuilderData()

Optional data to pass to the external output builder.

setOutputBuilderData

void setOutputBuilderData(java.lang.Object outputBuilderData)

Optional data to pass to the external output builder.

getDataStream

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 should only call this after calling processComplete.

Returns:

The generated data.xml file.

Throws:

java.io.IOException

AlreadyProcessedException

setDataStream

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

Parameters:

stream - The stream to write the data.xml file to.

getNumPages

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 Word or pdf report.

Returns:

The number of pages in the completed document.

process

void process()
      throws LicenseException,
             java.io.IOException,
             TemplateParseException,
             java.lang.IllegalArgumentException,
             TagException,
             AlreadyProcessedException,
             DataSourceException,
             OutputLimitationException,
             TinyException

Create a report from the input template & datasource(s), 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(datasource, true);
processComplete();

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.

java.lang.IllegalArgumentException - thrown if come across an unknown element type or an illegal reportType value is used.

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

processSetup

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

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.

java.lang.IllegalArgumentException - thrown if come across an unknown element type or an illegal reportType value is used.

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

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

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

setEventHandler

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

Parameters:

eventHandler - The event handler for this report.

getEventHandler

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

Returns:

The event handler for this report.

buildSchema

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.

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 datasource, 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.

processData

void processData(DataSourceProvider data,
                 java.lang.String datasource)
          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.

Parameters:

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

datasource - 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 datasource, template, or report streams.

TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

DataSourceException - thrown if there is a problem with the datasource.

TemplateParseException

OutputLimitationException

TinyException

processData

void processData(java.util.Map<java.lang.String,DataSourceProvider> dataProviders)
          throws java.io.IOException,
                 TagException,
                 AlreadyProcessedException,
                 DataSourceException,
                 TemplateParseException,
                 OutputLimitationException,
                 TinyException

Process multiple sets of data for the report. This method can be called multiple times. 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.

Parameters:

dataProviders@throws - IOException thrown if have problems accessing the datasource, template, or report streams.

Throws:

TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

DataSourceException - thrown if there is a problem with the datasource.

java.io.IOException

TemplateParseException

OutputLimitationException

TinyException

updatePods

void updatePods(UdtUpdate[] udts)
         throws DataSourceException,
                java.io.IOException,
                TagException,
                TemplateParseException,
                OutputLimitationException,
                TinyException

Update the UDTs.

Parameters:

udts - The UDTs 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

findPodsUsed

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.

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

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

Throws:

java.io.IOException - thrown if have problems accessing the datasource, template, or report streams.

TagException - thrown if there is an unmatched if/while - end. Not thrown in debug mode.

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

DataSourceException - thrown if there is a problem with the datasource.

LicenseException

OutputLimitationException

TemplateParseException

TinyException

batchSetup

void batchSetup(java.util.Map<java.lang.String,DataSourceProvider> dataProviders,
                java.lang.String batchForEach,
                java.util.Map<java.lang.String,java.lang.String> batchParameters)
         throws java.io.IOException,
                TagException,
                AlreadyProcessedException,
                DataSourceException,
                TemplateParseException,
                OutputLimitationException

Prepares the object to run batch reports. Call processSetup() before calling this method. Do not call processData() or processComplete() after calling this method. After this setup batchNext() can be called repetitively for each batched report.

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.

batchParameters - 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:

java.io.IOException

TagException

AlreadyProcessedException

DataSourceException

TemplateParseException

OutputLimitationException

batchNext

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.

Parameters:

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

Returns:

The generated document and ${var} substitutions in the parameter map.

Throws:

java.io.IOException

TagException

AlreadyProcessedException

DataSourceException

TemplateParseException

OutputLimitationException

TinyException

getImportInfo

ImportInfo[] getImportInfo()

Get all imports in the processed template. This must be called after processData as that is what finds the imports.

Returns:

all imports in the processed template.

setTrackErrors

void setTrackErrors(int flag)

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

Parameters:

flag - A combination of ERROR_HANDLING_ bits.

getErrorInfo

ErrorInfo getErrorInfo()

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().

Returns:

An instance of the ErrorInfo implementation.

getReport

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. In the case of ProcessReport(xml, template, report) this is gauranteed to be the report variable passed in. This can only be called after process() or processData().

Returns:

The report as a stream.

Throws:

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

close

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.

duplicate

ProcessReportAPIBase duplicate(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:

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

Returns:

A duplicated report object.

Throws:

AlreadyProcessedException - thrown if call the process steps out of order or call ones other than data twice.

LicenseException - thrown if called too often for the license type.

SetupException