CSVExportBean (webMethods CAF

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.webmethods.caf.faces.data.export
Class CSVExportBean

java.lang.Object
  com.webmethods.caf.faces.data.export.CSVExportBean

Writes the content of an ITableContentProvider as a csv file. The ITableContentProvider must specify the list of available columns via its IContentProvider.getPropertyKeys() method.

Field Summary
`protected ITableContentProvider`	`m_contentProvider` Export content provider.
`protected boolean`	`m_downloadForced` True to force file download dialog.
`protected String`	`m_exportCharacterEncoding` Export character encoding.
`protected String`	`m_exportFileName` Default filename in file download dialog.
`protected Pattern`	`RE_REPLACE_QUOTES`
`protected Pattern`	`RE_SHOULD_ESCAPE`

Fields inherited from interface com.webmethods.caf.faces.bean.IFileExportBean
`UNKNOWN_CONTENT_LENGTH`

Constructor Summary
`CSVExportBean()`
`CSVExportBean(ITableContentProvider contentProvider)`
`CSVExportBean(ITableContentProvider contentProvider, String exportFileName)`

Method Summary
`protected String`	`escapeValue(Object o)` Converts the specified object to a string and escapes it as a csv field value.
`ITableContentProvider`	`getContentProvider()`
`String`	`getExportCharacterEncoding()` Returns character encoding for this export file content (valid only when isExportBinary() == false)
`int`	`getExportContentLength()` Return the length of the content that is to be exported.
`String`	`getExportContentType()` Gets the content type of the response being sent to the client.
`String`	`getExportFileName()` Return the file name for the exported data
`boolean`	`isDownloadForced()` Return true to send the response headers that will force the user to choose what to do with the file (Open vs.
`boolean`	`isExportBinary()` Return true if the export will be sending binary data to the response, false if the export will be sending text.
`void`	`setContentProvider(ITableContentProvider value)`
`void`	`setDownloadForced(boolean value)`
`void`	`setExportCharacterEncoding(String value)`
`void`	`setExportFileName(String value)`
`void`	`writeExportBytes(OutputStream outStream)` Invoked to allow the bean to write binary data to the output stream.
`void`	`writeExportText(PrintWriter writer)` Invoked to allow the bean to write the export text to the output writer.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

protected Pattern RE_SHOULD_ESCAPE

protected Pattern RE_REPLACE_QUOTES

protected boolean m_downloadForced

True to force file download dialog.

protected String m_exportFileName

Default filename in file download dialog.

protected String m_exportCharacterEncoding

Export character encoding.

protected ITableContentProvider m_contentProvider

Export content provider.

Constructor Detail

public CSVExportBean()

public CSVExportBean(ITableContentProvider contentProvider)

public CSVExportBean(ITableContentProvider contentProvider,
                     String exportFileName)

Method Detail