com.jidesoft.grid
Class CsvPivotTableUtils

java.lang.Object
  com.jidesoft.grid.CsvPivotTableUtils

public class CsvPivotTableUtils
extends Object

CsvPivotTableUtils is a class that has methods to export PivotTablePane's content to Character Separated Values file format.

The export feature will not consider the cell contents conversion but you can use ValueConverter to format the value if you want. It will also optionally consider table header as part of the export. You could also choose any character including comma as the separator.

It does NOT support cell span and will LOSE the collapsed rows/columns because of the CSV format limitation.

Nested Class Summary

static class

CsvPivotTableUtils.CsvPivotTableExportConfig A class that has all the parameters that could be customized when exporting a PivotTablePane to csv file.

Constructor Summary

CsvPivotTableUtils()

Method Summary

static boolean	export(PivotTablePane pivotTablePane, OutputStream out) Exports the pivotTablePane to a CSV file output steam.
static boolean	export(PivotTablePane pivotTablePane, OutputStream out, CsvPivotTableUtils.CsvPivotTableExportConfig config) Exports the pivotTablePane to a CSV file output steam.
static boolean	export(PivotTablePane pivotTablePane, OutputStream out, ValueConverter cellValueConverter) Exports the pivotTablePane to a CSV file output steam.
static boolean	export(PivotTablePane pivotTablePane, OutputStream out, ValueConverter cellValueConverter, char separator) Exports the pivotTablePane to a CSV file output steam.
static boolean	export(PivotTablePane pivotTablePane, String fileName) Exports the pivotTablePane to an CSV file.
static boolean	export(PivotTablePane pivotTablePane, String fileName, ValueConverter cellValueConverter) Exports the pivotTablePane to an CSV file.
static boolean	export(PivotTablePane pivotTablePane, String fileName, ValueConverter cellValueConverter, char separator) Exports the pivotTablePane to an CSV file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvPivotTableUtils

public CsvPivotTableUtils()

Method Detail

export

public static boolean export(PivotTablePane pivotTablePane,
                             String fileName)
                      throws IOException

Exports the pivotTablePane to an CSV file.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

fileName - the CSV file name. It should be the full path to the file.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             String fileName,
                             ValueConverter cellValueConverter)
                      throws IOException

Exports the pivotTablePane to an CSV file.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

fileName - the CSV file name. It should be the full path to the file.

cellValueConverter - the converter to convert cell value to the value that can be set to CSV cell.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             String fileName,
                             ValueConverter cellValueConverter,
                             char separator)
                      throws IOException

Exports the pivotTablePane to an CSV file.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

fileName - the CSV file name. It should be the full path to the file.

cellValueConverter - the converter to convert cell value to the value that can be set to CSV cell.

separator - the character used to separate the cells. By default, it is a comma.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             OutputStream out)
                      throws IOException

Exports the pivotTablePane to a CSV file output steam.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

out - the output stream

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             OutputStream out,
                             ValueConverter cellValueConverter)
                      throws IOException

Exports the pivotTablePane to a CSV file output steam.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

out - the output stream

cellValueConverter - the converter to convert cell value to the value that can be set to CSV cell.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             OutputStream out,
                             ValueConverter cellValueConverter,
                             char separator)
                      throws IOException

Exports the pivotTablePane to a CSV file output steam.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

out - the output stream

cellValueConverter - the converter to convert cell value to the value that can be set to CSV cell.

separator - the character used to separate the cells. By default, it is a comma.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

export

public static boolean export(PivotTablePane pivotTablePane,
                             OutputStream out,
                             CsvPivotTableUtils.CsvPivotTableExportConfig config)
                      throws IOException

Exports the pivotTablePane to a CSV file output steam.

Parameters:

pivotTablePane - the pivotTablePane to be exported.

out - the output stream

config - a collection of the parameters that could be configured during the export process.

Returns:

true if exporting succeed. If poi.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.

Throws:

IOException - if the write to the file failed.

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

Since:

3.3.8