net.windward.xmlreport

Class ProcessCsv

java.lang.Object

net.windward.xmlreport.ProcessReport

net.windward.xmlreport.ProcessCsv

All Implemented Interfaces:

ProcessCsvAPI, ProcessReportAPI, ProcessReportAPIBase

public class ProcessCsv
extends ProcessReport
implements ProcessCsvAPI

This class is the main program that takes a template stream and a datasource and merges them to create a csv report stream. This output format only reads tables in the template. All other parts of the template are ignored. The way to use this is to construct a ProcessCsv object, set any options, then call process.
The calling method must close all streams after calling process. process will flush the output (report) stream before returning.

Version:

10.0 23 August 2010

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

Method Summary

Modifier and Type	Method and Description
ProcessReportAPIBase	duplicate(java.io.OutputStream out) Creates and returns a copy of this object.
char	getCellSeparator() Get the character used to seperate cells.
java.lang.String	getNewline() Set the string used to create a newline.
char	getQuoteChar() Get the character used to quote a cell.
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	isTrimWhitespace() Get if cells should have whitespace trimmed from beginning and end.
void	setCellSeparator(char separator) Set the character used to seperate cells.
void	setDataMode(int mode) Set the embed data setting.
void	setNewline(java.lang.String newline) Get the string used to create a newline.
void	setQuoteChar(char quoteChar) Set the character used to quote a cell.
void	setTrimWhitespace(boolean trimWhitespace) Set if cells should have whitespace trimmed from beginning and end.

Methods inherited from class net.windward.xmlreport.ProcessReport

abort, addImportInfo, adjustFontName, adjustFontSize, 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, getRenderExtent, getRenderPages, getReport, getSubject, getTemplateMetrics, getTemplateMetrics, getTemplateMetrics, getTemplateTypeString, getTemplateVersion, getTimeout, getTitle, getVersion, getVersionMajor, getVersionMinor, getVersionRelease, getWriteTags, hasDatasourcesApplied, init, isCopyEmbeddedObjects, isDebugMode, isIgnoreTags, isLayoutDocument, isPageBasedReport, 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, setDataStream, setDebugHandler, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setIgnoreTags, setKeywords, setLayoutDocument, setLocale, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, 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, getRenderExtent, getRenderPages, getReport, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, isCopyEmbeddedObjects, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLocale, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Constructor Detail

ProcessCsv

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

Create a ProcessCsv 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 csv 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

ProcessCsv

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

Create a ProcessCsv 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 csv 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

ProcessCsv

public ProcessCsv(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 csv 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 ProcessCsv 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 ProcessCsvAPI

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

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

getReportTypeString

public java.lang.String getReportTypeString()

Get the report format of the output as a string.

Specified by:

getReportTypeString in interface ProcessReportAPIBase

Returns:

"csv"

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

Overrides:

setDataMode in class ProcessReport

Parameters:

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

isTrimWhitespace

public boolean isTrimWhitespace()

Get if cells should have whitespace trimmed from beginning and end. The default is false.

Specified by:

isTrimWhitespace in interface ProcessCsvAPI

Returns:

true if cells should have whitespace trimmed from beginning and end.

setTrimWhitespace

public void setTrimWhitespace(boolean trimWhitespace)

Set if cells should have whitespace trimmed from beginning and end. The default is false.

Specified by:

setTrimWhitespace in interface ProcessCsvAPI

Parameters:

trimWhitespace - true if cells should have whitespace trimmed from beginning and end.

getCellSeparator

public char getCellSeparator()

Get the character used to seperate cells. The default is a ,

Specified by:

getCellSeparator in interface ProcessCsvAPI

Returns:

the character used to seperate cells.

setCellSeparator

public void setCellSeparator(char separator)

Set the character used to seperate cells. The default is a ,

Specified by:

setCellSeparator in interface ProcessCsvAPI

Parameters:

separator - the character used to seperate cells.

getQuoteChar

public char getQuoteChar()

Get the character used to quote a cell. The default is "

Specified by:

getQuoteChar in interface ProcessCsvAPI

Returns:

the character used to quote a cell.

setQuoteChar

public void setQuoteChar(char quoteChar)

Set the character used to quote a cell. The default is "

Specified by:

setQuoteChar in interface ProcessCsvAPI

Parameters:

quoteChar - the character used to quote a cell.

getNewline

public java.lang.String getNewline()

Set the string used to create a newline. The default is \r\n

Specified by:

getNewline in interface ProcessCsvAPI

Returns:

the string used to create a newline.

setNewline

public void setNewline(java.lang.String newline)

Get the string used to create a newline. The default is \r\n

Specified by:

setNewline in interface ProcessCsvAPI

Parameters:

newline - the string used to create a newline.