net.windward.xmlreport

Class ProcessTxt

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessTxt

All Implemented Interfaces:

ProcessReportAPI, ProcessReportAPIBase, ProcessTxtAPI

public class ProcessTxt
extends ProcessReport
implements ProcessTxtAPI

This class is the main program that takes a template stream and a datasource and merges them to create a txt report stream. The way to use this is to construct a ProcessTxt object, set any options, then call process.
When writing to this format, all characters are assumed to be 12 point fixed width.
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/interfaces inherited from class net.windward.xmlreport.ProcessReport

ProcessReport.CleanDatasource, ProcessReport.DrillDownTemplate, ProcessReport.PhoneHomeStats

Field Summary

Fields inherited from class net.windward.xmlreport.ProcessReport

TEMPLATE_TYPE_DOCM, TEMPLATE_TYPE_DOCX, TEMPLATE_TYPE_HTML, TEMPLATE_TYPE_PPTM, TEMPLATE_TYPE_PPTX, TEMPLATE_TYPE_UNKNOWN, TEMPLATE_TYPE_XLSM, TEMPLATE_TYPE_XLSX

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Constructor Summary

Constructors

Constructor and Description
ProcessTxt(java.io.InputStream template) Create a ProcessTxt object with the passed in template.
ProcessTxt(java.io.InputStream xmlData, 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.
ProcessTxt(java.io.InputStream template, java.io.OutputStream report) Create a ProcessTxt object with the passed in template, writing it to the passed in report stream.

Method Summary

Modifier and Type	Method and Description
int	adjustFontSize(int size) Return the font size.
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Creates and returns a copy of this object.
java.lang.String	getFont() Get the font used when formatting txt output.
int	getFontSize() Get the font size used when formatting txt output.
int	getRenderExtent() How the generated report will be cropped.
int	getReportType() Get the report format of the output stream.
java.lang.String	getReportTypeString() Get the report format of the output as a string.
boolean	isBreakPage() Returns true if a Ctrl-L is in the report for each page break.
boolean	isPageBasedReport() true if the generated report is page based.
boolean	isShowHeaders() Returns true if the header and footers are printed in the report.
boolean	isUseMargins() Deprecated. use getRenderExtent() instead.
boolean	isUseSoftEoln() If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line.
void	setBreakPage(boolean breakPage) Set true if a Ctrl-L is in the report for each page break.
void	setEmbededDataMode(int mode) Set the embed data setting.
void	setFont(java.lang.String font) Set the font used when formatting txt output.
void	setFontSize(int twips) Set the font size used when formatting txt output.
void	setRenderExtent(int extent) How the generated report will be cropped.
void	setShowHeaders(boolean showHeaders) Set if the header and footers are printed in the report.
void	setUseMargins(boolean useThem) Deprecated. use setRenderExtent() instead.
void	setUseSoftEoln(boolean useThem) If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line.

Methods inherited from class net.windward.xmlreport.ProcessReport

abort, addImportInfo, adjustFontName, batchNext, batchSetup, buildSchema, checkTimeout, clean, clean, cleanSelects, cleanSelects, close, findPodsUsed, getBaseDirectory, getCharset, getChartProvider, getChartRenderType, getCompany, getCopyMetadata, getDataMode, getDataStream, getDataWriter, getDebugHandler, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getMaxReportPages, getNumPages, getOutputBuilderData, getParameters, getRenderPages, getReport, getSubject, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateTypeString, getTemplateVersion, getTimeout, getTitle, getVersion, getVersionMajor, getVersionMinor, getVersionRelease, getWriteTags, hasDatasourcesApplied, init, isCopyEmbeddedObjects, isDebugMode, isIgnoreTags, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeDocx, isReportTypeExcel, isReportTypeOpenXml, isReportTypePpt, isReportTypeWord, isSameOpenXml, isTemplateTypeDOCX, isTemplateTypeOpenXml, isTemplateTypePPTX, isTemplateTypeXLSX, isTrackImports, isUseExternalOutputBuilder, loadTemplate, mergePodItemStyles, performLayout, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugHandler, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setIgnoreTags, setKeywords, setLayoutDocument, setLocale, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, shutdown, statLine, updatePods

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getNumPages, getOutputBuilderData, getParameters, getRenderPages, getReport, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, isCopyEmbeddedObjects, isDebugMode, isLayoutDocument, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLocale, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Constructor Detail

ProcessTxt

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

Create a ProcessTxt object with the passed in template. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process. The report will be in the txt format.

Parameters:

template - The report template.

Throws:

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

SetupException

ProcessTxt

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

Create a ProcessTxt object with the passed in template, writing it to the passed in report stream. Objects created with this constructor must call processSetup, processData, and processComplete. Objects created with this constructor cannot call process.The report will be in the txt format.

Parameters:

template - The report template.

report - The stream to write the report to.

Throws:

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

SetupException

ProcessTxt

public ProcessTxt(java.io.InputStream xmlData,
                  java.io.InputStream template,
                  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 txt format.

Parameters:

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

template - The report template.

report - The stream to write the report to.

Throws:

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

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

SetupException

Method Detail

duplicate

public 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. This will always return a ProcessTxt object.

Specified by:

duplicate in interface ProcessReportAPIBase

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 the license licenseKey check fails. The message will list the license check that failed.

SetupException

getReportType

public int getReportType()

Get the report format of the output stream.

Specified by:

getReportType in interface ProcessReportAPIBase

Specified by:

getReportType in interface ProcessTxtAPI

Returns:

The type (format) of the output report. Will be TYP_TXT.

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Specified by:

getReportTypeString in interface ProcessReportAPIBase

Returns:

"txt"

isPageBasedReport

public boolean isPageBasedReport()

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

Specified by:

isPageBasedReport in interface ProcessReportAPIBase

Overrides:

isPageBasedReport in class ProcessReport

Returns:

true if the generated report is page based.

setEmbededDataMode

public void setEmbededDataMode(int mode)

Set the embed data setting. Uses flags of EMBED_* constant ints. 0 for no embed.

Parameters:

mode - the embed data setting. You can only pass a 0.

isUseMargins

public boolean isUseMargins()

Deprecated. use getRenderExtent() instead.

If true, then the left page margin will be included in the output, creating leading spaces for each line. If false, the page margins will be ignored and any paragraph with no left indent will start at the begining of a line. The default is false.

Specified by:

isUseMargins in interface ProcessTxtAPI

Returns:

True if it will include the page margins, false otherwise.

setUseMargins

public void setUseMargins(boolean useThem)

Deprecated. use setRenderExtent() instead.

If true, then the left page margin will be included in the output, creating leading spaces for each line. If false, the page margins will be ignored and any paragraph with no left indent will start at the begining of a line. The default is false.

Specified by:

setUseMargins in interface ProcessTxtAPI

Parameters:

useThem - Set to true to include the page margins, false otherwise.

getRenderExtent

public int getRenderExtent()

Description copied from interface: ProcessReportAPIBase

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

Specified by:

getRenderExtent in interface ProcessReportAPIBase

Overrides:

getRenderExtent in class ProcessReport

Returns:

a ProcessReportAPI.RENDER_EXTENT_* value.

setRenderExtent

public void setRenderExtent(int extent)

Description copied from interface: ProcessReportAPIBase

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

Specified by:

setRenderExtent in interface ProcessReportAPIBase

Overrides:

setRenderExtent in class ProcessReport

Parameters:

extent - a ProcessReportAPI.RENDER_EXTENT_* value.

isUseSoftEoln

public boolean isUseSoftEoln()

If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line. If false then all paragraphs will be placed on a single line of output. The default is true.

Specified by:

isUseSoftEoln in interface ProcessTxtAPI

Returns:

True if it will include the page margins, false otherwise.

setUseSoftEoln

public void setUseSoftEoln(boolean useThem)

If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line. If false then all paragraphs will be placed on a single line of output. The default is true.

Specified by:

setUseSoftEoln in interface ProcessTxtAPI

Parameters:

useThem - Set to true to line wrap paragraphs, false otherwise.

isShowHeaders

public boolean isShowHeaders()

Returns true if the header and footers are printed in the report. False and they will not be printed. The default is false.

Specified by:

isShowHeaders in interface ProcessTxtAPI

Returns:

true if the headers and footers are printed in the final report.

setShowHeaders

public void setShowHeaders(boolean showHeaders)

Set if the header and footers are printed in the report. True to print and false and they will not be printed. The default is false.

Specified by:

setShowHeaders in interface ProcessTxtAPI

Parameters:

showHeaders - true if the headers and footers are printed in the final report.

isBreakPage

public boolean isBreakPage()

Returns true if a Ctrl-L is in the report for each page break. The default is false.

Specified by:

isBreakPage in interface ProcessTxtAPI

Returns:

true if a Ctrl-L is in the report for each page break.

setBreakPage

public void setBreakPage(boolean breakPage)

Set true if a Ctrl-L is in the report for each page break. The default is false.

Specified by:

setBreakPage in interface ProcessTxtAPI

Parameters:

breakPage - true if a Ctrl-L is in the report for each page break.

getFont

public java.lang.String getFont()

Get the font used when formatting txt output. The default is Courier.

Specified by:

getFont in interface ProcessTxtAPI

Returns:

The name of the font used to format txt output.

setFont

public void setFont(java.lang.String font)

Set the font used when formatting txt output. The default is Courier.

Specified by:

setFont in interface ProcessTxtAPI

Parameters:

font - The name of the font used to format txt output.

getFontSize

public int getFontSize()

Get the font size used when formatting txt output. This is set in TWIPS or 20ths of a point. So a value of 240 (the default) is 12 points.

Specified by:

getFontSize in interface ProcessTxtAPI

Returns:

The size of the font used to format txt output in twips.

setFontSize

public void setFontSize(int twips)

Set the font size used when formatting txt output. This is set in TWIPS or 20ths of a point. So a value of 240 (the default) is 12 points.

Specified by:

setFontSize in interface ProcessTxtAPI

Parameters:

twips - The size of the font used to format txt output in twips.

adjustFontSize

public int adjustFontSize(int size)

Return the font size.

Overrides:

adjustFontSize in class ProcessReport

Parameters:

size - The size of the font in half points. For txt this is always 24 (12 point).

Returns:

The font size in half points. Will return 24.