org.jberet.support.io

Class CsvItemWriter

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.CsvItemReaderWriterBase

org.jberet.support.io.CsvItemWriter

All Implemented Interfaces:

javax.batch.api.chunk.ItemWriter

@Named
 @Dependent
public class CsvItemWriter
extends CsvItemReaderWriterBase
implements javax.batch.api.chunk.ItemWriter

An implementation of javax.batch.api.chunk.ItemWriter that writes data to CSV file or resource. This class is not designed to be thread-safe and its instance should not be shared between threads.

Since:

1.0.0

See Also:

CsvItemReaderWriterBase, CsvItemReader

Field Summary

Fields

Modifier and Type	Field and Description
protected org.supercsv.io.ICsvWriter	delegateWriter
protected String[]	header Specifies the CSV header row to write out.
protected String	writeComments Specifies the complete comment line that can be recognized by any tools or programs intended to read the current CSV output.
protected String	writeMode Instructs org.jberet.support.io.CsvItemWriter, when the target CSV resource already exists, whether to append to, or overwrite the existing resource, or fail.

Fields inherited from class org.jberet.support.io.CsvItemReaderWriterBase

beanType, cellProcessorInstances, cellProcessors, charset, commentMatcher, delimiterChar, encoder, endOfLineSymbols, nameMapping, preference, quoteChar, quoteMode, surroundingSpacesNeedQuotes

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase

NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors

Constructor and Description
CsvItemWriter()

Method Summary

Modifier and Type	Method and Description
Serializable	checkpointInfo()
void	close()
void	open(Serializable checkpoint)
void	writeItems(List<Object> items)

Methods inherited from class org.jberet.support.io.CsvItemReaderWriterBase

getCellProcessors, getCommentMatcher, getCsvPreference, getEncoder, getNameMapping, getQuoteMode

Methods inherited from class org.jberet.support.io.ItemReaderWriterBase

getInputStream, getOutputStream, getValidator, validate

Methods inherited from class java.lang.Object

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

Field Detail

header

@Inject
protected String[] header

Specifies the CSV header row to write out.

writeComments

@Inject
protected String writeComments

Specifies the complete comment line that can be recognized by any tools or programs intended to read the current CSV output. The comments should already include the required comment-defining characters or regular expressions. The value of this property will be written out as a comment line verbatim as the first line.

writeMode

@Inject
protected String writeMode

Instructs org.jberet.support.io.CsvItemWriter, when the target CSV resource already exists, whether to append to, or overwrite the existing resource, or fail. Valid values are append, overwrite, and failIfExists. Optional property, and defaults to append.

delegateWriter

protected org.supercsv.io.ICsvWriter delegateWriter

Constructor Detail

CsvItemWriter

public CsvItemWriter()

Method Detail

open

public void open(Serializable checkpoint)
          throws Exception

Specified by:

open in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

writeItems

public void writeItems(List<Object> items)
                throws Exception

Specified by:

writeItems in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

checkpointInfo in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception