ProcessReportAPI (Windward Studios 21.2 API)

All Superinterfaces:

ProcessReportAPIBase

All Known Subinterfaces:

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

All Known Implementing Classes:

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

Deprecated.
Use ProcessReport instead.
```
public interface ProcessReportAPI
extends 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.

Version:

2.0 2 January 2004

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHARSET_DEFAULT` Deprecated. Set the charset based on Windward Report's internal rules.
`static int`	`CHARSET_RTF` Deprecated. This was only valid for RTF templates which are no longer supported.
`static int`	`CHARSET_UNICODE` Deprecated. Set the charset to unicode.
`static int`	`COPY_METADATA_ALWAYS` Deprecated. Always copy the windward metadata to the output report.
`static int`	`COPY_METADATA_IF_NO_DATASOURCE` Deprecated. Copy the windward metadata to the output report if no datasources were applied to the report.
`static int`	`COPY_METADATA_NEVER` Deprecated. Never copy the windward metadata to the output report.
`static int`	`DATA_MODE_ALL_ATTRIBUTES` Deprecated. Data file will include all tag attributes (including select) as an attribute.
`static int`	`DATA_MODE_DATA` Deprecated. Data file will include the data from each tag.
`static int`	`DATA_MODE_EMBED` Deprecated. The data file will be embedded in the generated report.
`static int`	`DATA_MODE_INCLUDE_BITMAPS` Deprecated. Data file will include the contents of any imported bitmap.
`static int`	`DATA_MODE_SELECT` Deprecated. Data file will include the select for each tag as an attribute.
`static int`	`ERROR_HANDLING_ALL` Deprecated. The bitmask that turns the complete error handling functionality on.
`static int`	`ERROR_HANDLING_NONE` Deprecated. The bitmask that turns the complete error handling functionality off.
`static int`	`ERROR_HANDLING_ONLY` Deprecated. THe bitmask that says to only do error checking, do not generate a report.
`static int`	`ERROR_HANDLING_TRACK_ERRORS` Deprecated. Handle errors as indicated by a tag properties.
`static int`	`ERROR_HANDLING_VERIFY` Deprecated. Perform verification during a report generation.
`static int`	`HIDDEN_IGNORE_PRINT_RANGE` Deprecated. Ignore the print area set in the XLSX file.
`static int`	`HIDDEN_SHOW_ALL_ROWS_COLUMNS` Deprecated. Include hidden rows and columns in a worksheet.
`static int`	`HIDDEN_SHOW_HIDDEN_SHEETS` Deprecated. Include worksheets set to hidden in the output.
`static int`	`HIDDEN_SHOW_NO_PRINT` Deprecated. Include worksheets set to not print in the output.
`static int`	`HYPHENATE_OFF` Deprecated.
`static int`	`HYPHENATE_ON` Deprecated.
`static int`	`HYPHENATE_TEMPLATE` Deprecated.
`static java.util.Locale`	`LOCALE_DEFAULT` Deprecated. Set the locale based on Windward Report's internal rules.
`static java.util.Locale`	`LOCALE_SYSTEM` Deprecated. Set the locale to the system's default locale.
`static int`	`MODE_PROCESS_EMBEDDED_ALWAYS` Deprecated. Always process an embedded object and write out the generated object & screenshot, even if no tags were processed.
`static int`	`MODE_PROCESS_EMBEDDED_COPY` Deprecated. Copy embedded objects across as is.
`static int`	`MODE_PROCESS_EMBEDDED_DROP` Deprecated. Drop embedded objects, they are not included in the output.
`static int`	`MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED` Deprecated. Process an embedded object applying the parent template datasources and variables.
`static int`	`MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT` Deprecated. Same as IF_DATA_APPLIED but the object is not re-rendered for a new screenshot.
`static int`	`RENDER_EXTENT_ALL` Deprecated. In get/setExtent() - the extent will be the entire document, nothing is cropped.
`static int`	`RENDER_EXTENT_CROP_EVERYTHING` Deprecated. Combination of CROP_MARGINS, CROP_HEADER_AND_FOOTER, & CROP_CONTENT.
`static int`	`RENDER_EXTENT_CROP_HEADER_AND_FOOTER` Deprecated. In get/setExtent() - The header and footer will not be rendered.
`static int`	`RENDER_EXTENT_CROP_MARGINS` Deprecated. In get/setExtent() - the margins will be cropped, even if that removes content.
`static int`	`RENDER_EXTENT_CROP_TO_CONTENT` Deprecated. In get/setExtent() - The smallest rectangle for each page that does not crop content.
`static int`	`TAG_STYLE_FIELD` Deprecated. Write tags out as a field (Word), in the autotag() macro (Excel), or as a hyperlink (PPT).
`static int`	`TAG_STYLE_FIELD_2007` Deprecated. Write tags out as Fields/macro and bitmap/chart (Open XML).
`static int`	`TAG_STYLE_TEXT` Deprecated. Write tags out as plain text.
`static int`	`TYP_CSV` Deprecated. The output will be a CSV document.
`static int`	`TYP_DOCX` Deprecated. The output will be a DOCX document.
`static int`	`TYP_HTML` Deprecated. The output report stream will be an HTML document
`static int`	`TYP_IMAGE` Deprecated. The output will be a series of bitmaps.
`static int`	`TYP_PDF` Deprecated. The output report stream will be a PDF document
`static int`	`TYP_PPTX` Deprecated. The output will be a PPTX documnet.
`static int`	`TYP_PRINTER` Deprecated. The output will be a Printer document
`static int`	`TYP_PS` Deprecated. The output will be a postscript document.
`static int`	`TYP_RTF` Deprecated. The output report stream will be a RTF document
`static int`	`TYP_TXT` Deprecated. The output report stream will be an ASCII text document
`static int`	`TYP_XLSX` Deprecated. x The output will be a XLSX document.

Method Summary
- Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase
  batchNext, batchSetup, buildSchema, close, duplicate, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getModeProcessEmbedded, getNumPages, getOutputBuilder, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getReportType, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, hasProcessedTags, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags

- Field Detail
  - RENDER_EXTENT_ALL
```
static final int RENDER_EXTENT_ALL
```
    Deprecated.
    
    In get/setExtent() - the extent will be the entire document, nothing is cropped.
    
    See Also:
    
    Constant Field Values
  - RENDER_EXTENT_CROP_MARGINS
```
static final int RENDER_EXTENT_CROP_MARGINS
```
    Deprecated.
    
    In get/setExtent() - the margins will be cropped, even if that removes content. These are flags and can be combined.
    
    See Also:
    
    Constant Field Values
  - RENDER_EXTENT_CROP_HEADER_AND_FOOTER
```
static final int RENDER_EXTENT_CROP_HEADER_AND_FOOTER
```
    Deprecated.
    
    In get/setExtent() - The header and footer will not be rendered. This does not crop the header/footer area, use RENDER_EXTENT_CROP_MARGINS with this to crop that part out. These are flags and can be combined.
    
    See Also:
    
    Constant Field Values
  - RENDER_EXTENT_CROP_TO_CONTENT
```
static final int RENDER_EXTENT_CROP_TO_CONTENT
```
    Deprecated.
    
    In get/setExtent() - The smallest rectangle for each page that does not crop content. Each page can be a different size. These are flags and can be combined.
    
    See Also:
    
    Constant Field Values
  - RENDER_EXTENT_CROP_EVERYTHING
```
static final int RENDER_EXTENT_CROP_EVERYTHING
```
    Deprecated.
    
    Combination of CROP_MARGINS, CROP_HEADER_AND_FOOTER, & CROP_CONTENT. This gets you the tightest possible picture.
    
    See Also:
    
    Constant Field Values
  - TYP_RTF
```
static final int TYP_RTF
```
    Deprecated.
    
    The output report stream will be a RTF document
    
    See Also:
    
    Constant Field Values
  - TYP_PDF
```
static final int TYP_PDF
```
    Deprecated.
    
    The output report stream will be a PDF document
    
    See Also:
    
    Constant Field Values
  - TYP_HTML
```
static final int TYP_HTML
```
    Deprecated.
    
    The output report stream will be an HTML document
    
    See Also:
    
    Constant Field Values
  - TYP_TXT
```
static final int TYP_TXT
```
    Deprecated.
    
    The output report stream will be an ASCII text document
    
    See Also:
    
    Constant Field Values
  - TYP_DOCX
```
static final int TYP_DOCX
```
    Deprecated.
    
    The output will be a DOCX document.
    
    See Also:
    
    Constant Field Values
  - TYP_XLSX
```
static final int TYP_XLSX
```
    Deprecated.
    
    x The output will be a XLSX document.
    
    See Also:
    
    Constant Field Values
  - TYP_PPTX
```
static final int TYP_PPTX
```
    Deprecated.
    
    The output will be a PPTX documnet.
    
    See Also:
    
    Constant Field Values
  - TYP_PRINTER
```
static final int TYP_PRINTER
```
    Deprecated.
    
    The output will be a Printer document
    
    See Also:
    
    Constant Field Values
  - TYP_CSV
```
static final int TYP_CSV
```
    Deprecated.
    
    The output will be a CSV document. Added in version 10.
    
    See Also:
    
    Constant Field Values
  - TYP_IMAGE
```
static final int TYP_IMAGE
```
    Deprecated.
    
    The output will be a series of bitmaps.
    
    See Also:
    
    Constant Field Values
  - TYP_PS
```
static final int TYP_PS
```
    Deprecated.
    
    The output will be a postscript document.
    
    See Also:
    
    Constant Field Values
  - CHARSET_DEFAULT
```
static final int CHARSET_DEFAULT
```
    Deprecated.
    
    Set the charset based on Windward Report's internal rules. For html this is utf-8 (unicode) unless it's HTML_1 in which case it's the rtf template language. For txt it's the rtf template native format.
    
    See Also:
    
    Constant Field Values
  - CHARSET_UNICODE
```
static final int CHARSET_UNICODE
```
    Deprecated.
    
    Set the charset to unicode.
    
    See Also:
    
    Constant Field Values
  - CHARSET_RTF
```
static final int CHARSET_RTF
```
    Deprecated. This was only valid for RTF templates which are no longer supported.
    
    Set the charset to the default in the template rtf file.
    
    See Also:
    
    Constant Field Values
  - LOCALE_DEFAULT
```
static final java.util.Locale LOCALE_DEFAULT
```
    Deprecated.
    
    Set the locale based on Windward Report's internal rules. If the locale was never set, e.g. via the properties file or report.setLocale() API call, it defaults to Locale.getDefault(). When the report object loads a template the locale may change as it is set to the template native format.
  - LOCALE_SYSTEM
```
static final java.util.Locale LOCALE_SYSTEM
```
    Deprecated.
    
    Set the locale to the system's default locale. This is set to what is defined in the properties file or to Locale.getDefault() if nothing is set in the properties.
  - TAG_STYLE_TEXT
```
static final int TAG_STYLE_TEXT
```
    Deprecated.
    
    Write tags out as plain text.
    
    See Also:
    
    Constant Field Values
  - TAG_STYLE_FIELD
```
static final int TAG_STYLE_FIELD
```
    Deprecated.
    
    Write tags out as a field (Word), in the autotag() macro (Excel), or as a hyperlink (PPT).
    
    See Also:
    
    Constant Field Values
  - TAG_STYLE_FIELD_2007
```
static final int TAG_STYLE_FIELD_2007
```
    Deprecated.
    
    Write tags out as Fields/macro and bitmap/chart (Open XML).
    
    See Also:
    
    Constant Field Values
  - COPY_METADATA_NEVER
```
static final int COPY_METADATA_NEVER
```
    Deprecated.
    
    Never copy the windward metadata to the output report.
    
    See Also:
    
    Constant Field Values
  - COPY_METADATA_IF_NO_DATASOURCE
```
static final int COPY_METADATA_IF_NO_DATASOURCE
```
    Deprecated.
    
    Copy the windward metadata to the output report if no datasources were applied to the report. This is the default.
    
    See Also:
    
    Constant Field Values
  - COPY_METADATA_ALWAYS
```
static final int COPY_METADATA_ALWAYS
```
    Deprecated.
    
    Always copy the windward metadata to the output report.
    
    See Also:
    
    Constant Field Values
  - HYPHENATE_OFF
```
static final int HYPHENATE_OFF
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - HYPHENATE_TEMPLATE
```
static final int HYPHENATE_TEMPLATE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - HYPHENATE_ON
```
static final int HYPHENATE_ON
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_SHOW_NO_PRINT
```
static final int HIDDEN_SHOW_NO_PRINT
```
    Deprecated.
    
    Include worksheets set to not print in the output.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_SHOW_HIDDEN_SHEETS
```
static final int HIDDEN_SHOW_HIDDEN_SHEETS
```
    Deprecated.
    
    Include worksheets set to hidden in the output. This will not include the WR_DATA (Windward metadata) sheet.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_SHOW_ALL_ROWS_COLUMNS
```
static final int HIDDEN_SHOW_ALL_ROWS_COLUMNS
```
    Deprecated.
    
    Include hidden rows and columns in a worksheet.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_IGNORE_PRINT_RANGE
```
static final int HIDDEN_IGNORE_PRINT_RANGE
```
    Deprecated.
    
    Ignore the print area set in the XLSX file. (ie, print the whole sheet.)
    
    See Also:
    
    Constant Field Values
  - DATA_MODE_DATA
```
static final int DATA_MODE_DATA
```
    Deprecated.
    
    Data file will include the data from each tag.
    
    See Also:
    
    Constant Field Values
  - DATA_MODE_SELECT
```
static final int DATA_MODE_SELECT
```
    Deprecated.
    
    Data file will include the select for each tag as an attribute.
    
    See Also:
    
    Constant Field Values
  - DATA_MODE_ALL_ATTRIBUTES
```
static final int DATA_MODE_ALL_ATTRIBUTES
```
    Deprecated.
    
    Data file will include all tag attributes (including select) as an attribute.
    
    See Also:
    
    Constant Field Values
  - DATA_MODE_INCLUDE_BITMAPS
```
static final int DATA_MODE_INCLUDE_BITMAPS
```
    Deprecated.
    
    Data file will include the contents of any imported bitmap. The bitmap will be uuencoded.
    
    See Also:
    
    Constant Field Values
  - DATA_MODE_EMBED
```
static final int DATA_MODE_EMBED
```
    Deprecated.
    
    The data file will be embedded in the generated report.
    
    See Also:
    
    Constant Field Values
  - MODE_PROCESS_EMBEDDED_DROP
```
static final int MODE_PROCESS_EMBEDDED_DROP
```
    Deprecated.
    
    Drop embedded objects, they are not included in the output.
    
    See Also:
    
    Constant Field Values
  - MODE_PROCESS_EMBEDDED_COPY
```
static final int MODE_PROCESS_EMBEDDED_COPY
```
    Deprecated.
    
    Copy embedded objects across as is.
    
    See Also:
    
    Constant Field Values
  - MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED
```
static final int MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED
```
    Deprecated.
    
    Process an embedded object applying the parent template datasources and variables. If any tags were processed write out the generated object and screenshot. If no tags were processed, copy across the embedded object as is.
    
    See Also:
    
    Constant Field Values
  - MODE_PROCESS_EMBEDDED_ALWAYS
```
static final int MODE_PROCESS_EMBEDDED_ALWAYS
```
    Deprecated.
    
    Always process an embedded object and write out the generated object & screenshot, even if no tags were processed.
    
    See Also:
    
    Constant Field Values
  - MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT
```
static final int MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT
```
    Deprecated.
    
    Same as IF_DATA_APPLIED but the object is not re-rendered for a new screenshot.
    
    See Also:
    
    Constant Field Values
  - ERROR_HANDLING_TRACK_ERRORS
```
static final int ERROR_HANDLING_TRACK_ERRORS
```
    Deprecated.
    
    Handle errors as indicated by a tag properties.
    
    See Also:
    
    Constant Field Values
  - ERROR_HANDLING_VERIFY
```
static final int ERROR_HANDLING_VERIFY
```
    Deprecated.
    
    Perform verification during a report generation.
    
    See Also:
    
    Constant Field Values
  - ERROR_HANDLING_NONE
```
static final int ERROR_HANDLING_NONE
```
    Deprecated.
    
    The bitmask that turns the complete error handling functionality off.
    
    See Also:
    
    Constant Field Values
  - ERROR_HANDLING_ALL
```
static final int ERROR_HANDLING_ALL
```
    Deprecated.
    
    The bitmask that turns the complete error handling functionality on.
    
    See Also:
    
    Constant Field Values
  - ERROR_HANDLING_ONLY
```
static final int ERROR_HANDLING_ONLY
```
    Deprecated.
    
    THe bitmask that says to only do error checking, do not generate a report.
    
    See Also:
    
    Constant Field Values

Interface ProcessReportAPI

Field Summary

Method Summary

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

Field Detail

RENDER_EXTENT_ALL

RENDER_EXTENT_CROP_MARGINS

RENDER_EXTENT_CROP_HEADER_AND_FOOTER

RENDER_EXTENT_CROP_TO_CONTENT

RENDER_EXTENT_CROP_EVERYTHING

TYP_RTF

TYP_PDF

TYP_HTML

TYP_TXT

TYP_DOCX

TYP_XLSX

TYP_PPTX

TYP_PRINTER

TYP_CSV

TYP_IMAGE

TYP_PS

CHARSET_DEFAULT

CHARSET_UNICODE

CHARSET_RTF

LOCALE_DEFAULT

LOCALE_SYSTEM

TAG_STYLE_TEXT

TAG_STYLE_FIELD

TAG_STYLE_FIELD_2007

COPY_METADATA_NEVER

COPY_METADATA_IF_NO_DATASOURCE

COPY_METADATA_ALWAYS

HYPHENATE_OFF

HYPHENATE_TEMPLATE

HYPHENATE_ON

HIDDEN_SHOW_NO_PRINT

HIDDEN_SHOW_HIDDEN_SHEETS

HIDDEN_SHOW_ALL_ROWS_COLUMNS

HIDDEN_IGNORE_PRINT_RANGE

DATA_MODE_DATA

DATA_MODE_SELECT

DATA_MODE_ALL_ATTRIBUTES

DATA_MODE_INCLUDE_BITMAPS

DATA_MODE_EMBED

MODE_PROCESS_EMBEDDED_DROP

MODE_PROCESS_EMBEDDED_COPY

MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED

MODE_PROCESS_EMBEDDED_ALWAYS

MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT

ERROR_HANDLING_TRACK_ERRORS

ERROR_HANDLING_VERIFY

ERROR_HANDLING_NONE

ERROR_HANDLING_ALL

ERROR_HANDLING_ONLY