de.hybris.platform.impex.jalo.exp

Class ImpExCSVExportWriter

java.lang.Object

de.hybris.platform.impex.jalo.exp.ImpExExportWriter

de.hybris.platform.impex.jalo.exp.ImpExCSVExportWriter

public class ImpExCSVExportWriter
extends ImpExExportWriter

Implementation of the export writer using a CSVWriter for exporting items.

Constructor Summary

Constructors

Constructor and Description
ImpExCSVExportWriter(CSVWriter writer) Instantiates a new exporter with given writer.
ImpExCSVExportWriter(CSVWriter writer, SessionContext ctx) Instantiates a new exporter with given writer.

Method Summary

Modifier and Type	Method and Description
void	close() Close CSVWriter Stream.
void	comment(java.lang.String text) Writes a comment.
java.lang.Object	getExportWriter() Returns the general writer which is used for this export.
void	newLine() Write a newline.
void	writeComment(java.lang.String scrline) Writes the String comment to the writer as a line comment.
void	writeCurrentHeader(boolean asComment) Writes the the current header either as a comment, if asComment is set to true, or as a normal row if asComment is false.
void	writeLine(Item item) Exports the Item into the underlying Writer using current header.
void	writeSrcLine(java.lang.String scrline) Writes the String srcLine to the writer as a normal line.

Methods inherited from class de.hybris.platform.impex.jalo.exp.ImpExExportWriter

getAllAttributeValues, getAttributeValue, getColumnOffset, getCurrentHeader, getLanguage, setColumnOffset, setCurrentHeader, setCurrentHeader, setCurrentHeader, setCurrentHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

ImpExCSVExportWriter

public ImpExCSVExportWriter(CSVWriter writer)

Instantiates a new exporter with given writer.

Parameters:

writer - writer where the items will be exported to

ImpExCSVExportWriter

public ImpExCSVExportWriter(CSVWriter writer,
                            SessionContext ctx)

Instantiates a new exporter with given writer.

Parameters:

writer - writer where the items will be exported to

ctx - session context used for export

Method Detail

comment

public void comment(java.lang.String text)

Description copied from class: ImpExExportWriter

Writes a comment.

Specified by:

comment in class ImpExExportWriter

Parameters:

text - comment to write

close

public void close()

Close CSVWriter Stream.

Specified by:

close in class ImpExExportWriter

getExportWriter

public java.lang.Object getExportWriter()

Description copied from class: ImpExExportWriter

Returns the general writer which is used for this export. e.g. a CSvWriter or a XMLWriter. The returnvalue must be casted.

Specified by:

getExportWriter in class ImpExExportWriter

Returns:

uncasted Object

newLine

public void newLine()

Description copied from class: ImpExExportWriter

Write a newline.

Specified by:

newLine in class ImpExExportWriter

writeCurrentHeader

public void writeCurrentHeader(boolean asComment)
                        throws ImpExException

Description copied from class: ImpExExportWriter

Writes the the current header either as a comment, if asComment is set to true, or as a normal row if asComment is false. The columns are shifted according to the set column offset.

Specified by:

writeCurrentHeader in class ImpExExportWriter

Throws:

ImpExException - error while writing

See Also:

ImpExExportWriter.setColumnOffset(int), ImpExExportWriter.getColumnOffset()

writeLine

public void writeLine(Item item)
               throws ImpExException

Description copied from class: ImpExExportWriter

Exports the Item into the underlying Writer using current header.

Specified by:

writeLine in class ImpExExportWriter

Parameters:

item - Item to export.

Throws:

ImpExException - error while translating item to text

writeComment

public void writeComment(java.lang.String scrline)
                  throws java.io.IOException

Description copied from class: ImpExExportWriter

Writes the String comment to the writer as a line comment.

Specified by:

writeComment in class ImpExExportWriter

Parameters:

scrline - the line to be written to the writer

Throws:

java.io.IOException - if an error occurs while writing

writeSrcLine

public void writeSrcLine(java.lang.String scrline)
                  throws java.io.IOException

Description copied from class: ImpExExportWriter

Writes the String srcLine to the writer as a normal line.

Specified by:

writeSrcLine in class ImpExExportWriter

Parameters:

scrline - the line to be written to the writer

Throws:

java.io.IOException - if an error occurs while writing