Package com.googlecode.wicket.kendo.ui.datatable.export

Class CSVDataExporter

java.lang.Object

com.googlecode.wicket.kendo.ui.datatable.export.CSVDataExporter

All Implemented Interfaces:

IDataExporter, Serializable, org.apache.wicket.util.io.IClusterable

public class CSVDataExporter
extends Object
implements IDataExporter

Provides export capability for the DataTable

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSVDataExporter.DataExporterResourceStreamWriter	Provides the IResourceStreamWriter for the CSVDataExporter

Constructor Summary

Constructors

Constructor	Description
CSVDataExporter()	Constructor
CSVDataExporter(String contentType)	Constructor

Method Summary

Modifier and Type	Method	Description
static void	export(DataTable<?> table, String filename)
static void	export(org.apache.wicket.request.cycle.RequestCycle cycle, DataTable<?> table, String filename)	Exports DataTable data to a CSV file
static void	export(org.apache.wicket.request.cycle.RequestCycle cycle, org.apache.wicket.markup.repeater.data.IDataProvider<?> provider, List<IExportableColumn> columns, String filename)	Exports DataTable data to a CSV file
<T> void	exportData(org.apache.wicket.markup.repeater.data.IDataProvider<T> provider, List<IExportableColumn> columns, OutputStream output)	Exports all data provided by the IDataProvider to the OutputStream.
<T> void	exportData(org.apache.wicket.markup.repeater.data.IDataProvider<T> provider, List<IExportableColumn> columns, OutputStream output, long first, long count)	Exports the data provided by the IDataProvider to the OutputStream.
String	getContentType()	Gets the content type
boolean	isExportHeadersEnabled()	Indicates whether headers will be written to the output
static org.apache.wicket.extensions.ajax.AjaxDownloadBehavior	newAjaxDownloadBehavior(DataTable<?> table, String filename)	Gets a new AjaxDownloadBehavior that allows to export DataTable data to a CSV file
static org.apache.wicket.extensions.ajax.AjaxDownloadBehavior	newAjaxDownloadBehavior(org.apache.wicket.markup.repeater.data.IDataProvider<?> provider, List<IExportableColumn> columns, String filename)	Gets a new AjaxDownloadBehavior that allows to export DataTable data to a CSV file
protected String	quoteValue(String value)	Quotes a value for export to CSV. According to RFC4180, this should just duplicate all occurrences of the quote character and wrap the result in the quote character.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVDataExporter

public CSVDataExporter()

Constructor

CSVDataExporter

public CSVDataExporter(String contentType)

Constructor

Parameters:

contentType - the content-type, ie: text/csv

Method Detail

getContentType

public String getContentType()

Gets the content type

Specified by:

getContentType in interface IDataExporter

Returns:

the content type

isExportHeadersEnabled

public boolean isExportHeadersEnabled()

Indicates whether headers will be written to the output

Specified by:

isExportHeadersEnabled in interface IDataExporter

Returns:

true or false

quoteValue

protected String quoteValue(String value)

Quotes a value for export to CSV.
According to RFC4180, this should just duplicate all occurrences of the quote character and wrap the result in the quote character.

Parameters:

value - The value to be quoted.

Returns:

a quoted copy of the value.

exportData

public <T> void exportData(org.apache.wicket.markup.repeater.data.IDataProvider<T> provider,
                           List<IExportableColumn> columns,
                           OutputStream output)
                    throws IOException

Exports all data provided by the IDataProvider to the OutputStream.

Specified by:

exportData in interface IDataExporter

Type Parameters:

T - the object type

Parameters:

provider - the IDataProvider

columns - the list of IColumn

output - the OutputStream

Throws:

IOException - if this could not write the file out

exportData

public <T> void exportData(org.apache.wicket.markup.repeater.data.IDataProvider<T> provider,
                           List<IExportableColumn> columns,
                           OutputStream output,
                           long first,
                           long count)
                    throws IOException

Exports the data provided by the IDataProvider to the OutputStream.

Type Parameters:

T - the object type

Parameters:

provider - the IDataProvider

columns - the list of IColumn

output - the OutputStream

first - the first row of datacount

count - the number of elements to retrieve

Throws:

IOException - if this could not write the file out

export

public static void export(DataTable<?> table,
                          String filename)

export

public static void export(org.apache.wicket.request.cycle.RequestCycle cycle,
                          DataTable<?> table,
                          String filename)

Exports DataTable data to a CSV file

Parameters:

cycle - the RequestCycle

table - the DataTable

filename - the file name of the output

export

public static void export(org.apache.wicket.request.cycle.RequestCycle cycle,
                          org.apache.wicket.markup.repeater.data.IDataProvider<?> provider,
                          List<IExportableColumn> columns,
                          String filename)

Exports DataTable data to a CSV file

Parameters:

cycle - the RequestCycle

provider - the IDataProvider

columns - the list of IExportableColumn

filename - the file name of the output

newAjaxDownloadBehavior

public static org.apache.wicket.extensions.ajax.AjaxDownloadBehavior newAjaxDownloadBehavior(DataTable<?> table,
                                                                                             String filename)

Gets a new AjaxDownloadBehavior that allows to export DataTable data to a CSV file

Parameters:

table - the DataTable

filename - the file name of the output

Returns:

a new AjaxDownloadBehavior

newAjaxDownloadBehavior

public static org.apache.wicket.extensions.ajax.AjaxDownloadBehavior newAjaxDownloadBehavior(org.apache.wicket.markup.repeater.data.IDataProvider<?> provider,
                                                                                             List<IExportableColumn> columns,
                                                                                             String filename)

Gets a new AjaxDownloadBehavior that allows to export DataTable data to a CSV file

Parameters:

provider - the IDataProvider

columns - the list of IExportableColumn

filename - the file name of the output

Returns:

a new AjaxDownloadBehavior