Package com.broadleafcommerce.common.dataexport.service

Class CSVExportFileWriter

java.lang.Object

com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter

All Implemented Interfaces:

ExportFileWriter<CSVExportFileWriteContext>

public class CSVExportFileWriter
extends Object
implements ExportFileWriter<CSVExportFileWriteContext>

An implementation of ExportFileWriter that can write CSV files.

Author:

Samarth Dhruva (samarthd)

Constructor Summary

Constructors

Constructor	Description
CSVExportFileWriter()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(Export export)	Returns whether the writer can support writing the file for the given export.
CSVExportFileWriteContext	createExecutionContext(OutputStream outputStream)	Creates a new instance of an ExportFileWriteContext for writing to the given outputStream.
String	getFileExtension()	Returns the file extension that should be used for the export file that the writer will be writing to.
ExportFileWriteResponse	writeHeaders(LinkedHashSet<String> headers, CSVExportFileWriteContext executionContext)	Writes the given headers to the output file.
ExportFileWriteResponse	writeRows(List<Map<String,String>> rows, CSVExportFileWriteContext executionContext)	Writes the given rows to the export file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVExportFileWriter

public CSVExportFileWriter()

Method Detail

canHandle

public boolean canHandle(Export export)

Description copied from interface: ExportFileWriter

Returns whether the writer can support writing the file for the given export. Generally this should be entirely based on Export.fileType.

Specified by:

canHandle in interface ExportFileWriter<CSVExportFileWriteContext>

Parameters:

export - details about the export that will be processed

Returns:

true if the file writer can support writing the file for the given export, false otherwise

getFileExtension

public String getFileExtension()

Description copied from interface: ExportFileWriter

Returns the file extension that should be used for the export file that the writer will be writing to.

Specified by:

getFileExtension in interface ExportFileWriter<CSVExportFileWriteContext>

Returns:

the file extension (including the ".") that should be used for the export file

createExecutionContext

public CSVExportFileWriteContext createExecutionContext(OutputStream outputStream)

Description copied from interface: ExportFileWriter

Creates a new instance of an ExportFileWriteContext for writing to the given outputStream.

Specified by:

createExecutionContext in interface ExportFileWriter<CSVExportFileWriteContext>

Parameters:

outputStream - the output stream that the writer should be writing to

Returns:

a new instance of a file writing context that is bound to the given output stream

writeHeaders

public ExportFileWriteResponse writeHeaders(LinkedHashSet<String> headers,
                                            CSVExportFileWriteContext executionContext)

Description copied from interface: ExportFileWriter

Writes the given headers to the output file. The ExportFileWriteContext.outputStream should be left open for further writes.

Specified by:

writeHeaders in interface ExportFileWriter<CSVExportFileWriteContext>

Parameters:

headers - the headers that need to be written to the export file

executionContext - state information for the particular export being written

Returns:

a response describing whether the write operation succeeded or failed

writeRows

public ExportFileWriteResponse writeRows(List<Map<String,String>> rows,
                                         CSVExportFileWriteContext executionContext)

Description copied from interface: ExportFileWriter

Writes the given rows to the export file. The ExportFileWriteContext.outputStream should be left open for further writes.

Specified by:

writeRows in interface ExportFileWriter<CSVExportFileWriteContext>

Parameters:

rows - the rows that need to be written to the export file

executionContext - state information for the particular export being written

Returns:

a response describing whether the write operation succeeded or failed