com.webmethods.caf.faces.data.export

Class CSVTableExportProvider

java.lang.Object

com.webmethods.caf.faces.data.export.DataTableExportProvider

com.webmethods.caf.faces.data.export.CSVTableExportProvider

All Implemented Interfaces:

IContentProvider, ITableContentProvider

public class CSVTableExportProvider
extends DataTableExportProvider

Adapts a UIData component to an ITableContentProvider, specialized for exporting as CSV (comma-separated values). The main specialization is that it provides the first row as the table's column labels.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_index

Fields inherited from class com.webmethods.caf.faces.data.export.DataTableExportProvider

m_columnLabelMap, m_columnMap, m_htmlResponseBuffer, m_htmlResponseBufferBackingWriter, m_propertyKeys, m_responseBuffer, m_table, RE_IS_DUMMY_ID, RE_STRIP_COLUMN_FROM_ID

Constructor Summary

Constructors

Constructor and Description
CSVTableExportProvider()
CSVTableExportProvider(UIData table)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getCurrentRow() Returns wrapped current row object.
int	getRowCount() Return the number of rows of data objects represented by this DataModel.
int	getRowIndex() Return the zero-relative index of the currently selected row.
Object	getValue(Object propertyKey) Returns value of the given property
boolean	isRowAvailable() Return a flag indicating whether there is rowData available at the current rowIndex.
void	setRowIndex(int rowIndex) Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.

Methods inherited from class com.webmethods.caf.faces.data.export.DataTableExportProvider

clearHTMLResponseBuffer, clearResponseBuffer, getColumnLabelMap, getColumnMap, getHTMLResponseBuffer, getPropertyKeys, getResponseBuffer, getRowVariable, getTable, getType, hasProperty, refresh, render, renderAsHTML, setRowVariable, setTable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider

toString

Field Detail

m_index

protected int m_index

Constructor Detail

CSVTableExportProvider

public CSVTableExportProvider()

CSVTableExportProvider

public CSVTableExportProvider(UIData table)

Method Detail

getValue

public Object getValue(Object propertyKey)
                throws EvaluationException,
                       PropertyNotFoundException

Description copied from interface: IContentProvider

Returns value of the given property

Specified by:

getValue in interface IContentProvider

Overrides:

getValue in class DataTableExportProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

EvaluationException - if error during property evaluation

PropertyNotFoundException - if property is not supported

getCurrentRow

public Object getCurrentRow()

Description copied from interface: ITableContentProvider

Returns wrapped current row object. Can be null if not data is available

Specified by:

getCurrentRow in interface ITableContentProvider

Overrides:

getCurrentRow in class DataTableExportProvider

Returns:

current row object

See Also:

ITableContentProvider.isRowAvailable()

getRowCount

public int getRowCount()

Description copied from interface: ITableContentProvider

Return the number of rows of data objects represented by this DataModel.

Return -1, if the number of rows is unknown, or no wrappedData is available.

Specified by:

getRowCount in interface ITableContentProvider

Overrides:

getRowCount in class DataTableExportProvider

See Also:

DataModel.getRowCount()

getRowIndex

public int getRowIndex()

Description copied from interface: ITableContentProvider

Return the zero-relative index of the currently selected row.

If we are not currently positioned on a row, or no wrappedData is available, return -1.

Specified by:

getRowIndex in interface ITableContentProvider

Overrides:

getRowIndex in class DataTableExportProvider

See Also:

DataModel.getRowIndex()

isRowAvailable

public boolean isRowAvailable()

Description copied from interface: ITableContentProvider

Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false.

Specified by:

isRowAvailable in interface ITableContentProvider

Overrides:

isRowAvailable in class DataTableExportProvider

See Also:

DataModel.isRowAvailable()

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from interface: ITableContentProvider

Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.

Specified by:

setRowIndex in interface ITableContentProvider

Overrides:

setRowIndex in class DataTableExportProvider

See Also:

DataModel.getRowIndex()