net.windward.xmlreport

Interface ProcessCsvAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessCsv

public interface ProcessCsvAPI
extends ProcessReportAPI

This class is a subclass of ProcessReportAPI specifically for creating an output in the CSV format.

Version:

10.0 23 August 2010

Field Summary

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

Method Summary

Modifier and Type	Method and Description
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.
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	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 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, getNumPages, getOutputBuilderData, getParameters, getRenderExtent, getRenderPages, getReport, getReportTypeString, 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, setDataMode, 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

Method Detail

getReportType

int getReportType()

Get the report format of the output stream.

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

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

isTrimWhitespace

boolean isTrimWhitespace()

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

Returns:

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

setTrimWhitespace

void setTrimWhitespace(boolean trimWhitespace)

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

Parameters:

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

getCellSeparator

char getCellSeparator()

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

Returns:

the character used to seperate cells.

setCellSeparator

void setCellSeparator(char separator)

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

Parameters:

separator - the character used to seperate cells.

getQuoteChar

char getQuoteChar()

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

Returns:

the character used to quote a cell.

setQuoteChar

void setQuoteChar(char quoteChar)

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

Parameters:

quoteChar - the character used to quote a cell.

getNewline

java.lang.String getNewline()

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

Returns:

the string used to create a newline.

setNewline

void setNewline(java.lang.String newline)

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

Parameters:

newline - the string used to create a newline.