org.jberet.support.io

Class JacksonCsvItemWriter

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.JacksonCsvItemReaderWriterBase

org.jberet.support.io.JacksonCsvItemWriter

All Implemented Interfaces:

javax.batch.api.chunk.ItemWriter

@Named
 @Dependent
public class JacksonCsvItemWriter
extends JacksonCsvItemReaderWriterBase
implements javax.batch.api.chunk.ItemWriter

An implementation of javax.batch.api.chunk.ItemWriter that writes data in CSV format using jackson-dataformat-csv.

Since:

1.2.0

See Also:

CsvItemWriter, JacksonCsvItemReader, JacksonCsvItemReaderWriterBase

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.dataformat.csv.CsvGenerator	csvGenerator
protected Map<String,String>	csvGeneratorFeatures A comma-separated list of key-value pairs that specify com.fasterxml.jackson.dataformat.csv.CsvGenerator.Feature.
protected Map<String,String>	jsonGeneratorFeatures A comma-separated list of key-value pairs that specify com.fasterxml.jackson.core.JsonGenerator features.
protected String	lineSeparator Character used to separate data rows.
protected Class	outputDecorator Fully-qualified name of a class that implements com.fasterxml.jackson.core.io.OutputDecorator, which can be used to decorate output destinations.
protected String	writeMode Instructs this class, 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.JacksonCsvItemReaderWriterBase

beanType, columns, columnSeparator, csvMapper, nullValue, quoteChar, useHeader

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

customDataTypeModules, customDeserializers, customSerializers, deserializationFeatures, jsonFactory, jsonFactoryFeatures, jsonFactoryLookup, mapperFeatures, objectMapper, serializationFeatures

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

NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors

Constructor and Description
JacksonCsvItemWriter()

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.JacksonCsvItemReaderWriterBase

buildCsvSchema, init, initJsonFactory

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

initJsonFactoryAndObjectMapper, registerModule

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

writeMode

@Inject
protected String writeMode

Instructs this class, 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.

lineSeparator

@Inject
protected String lineSeparator

Character used to separate data rows. Only used by generator; parser accepts three standard linefeeds ("\r", "\r\n", "\n"). Optional protected and defaults to '\n'.

See Also:

"com.fasterxml.jackson.dataformat.csv.CsvSchema"

jsonGeneratorFeatures

@Inject
protected Map<String,String> jsonGeneratorFeatures

A comma-separated list of key-value pairs that specify com.fasterxml.jackson.core.JsonGenerator features. Optional property and defaults to null. Keys and values must be defined in com.fasterxml.jackson.core.JsonGenerator.Feature. For example,

 WRITE_BIGDECIMAL_AS_PLAIN=true, WRITE_NUMBERS_AS_STRINGS=true, QUOTE_NON_NUMERIC_NUMBERS=false
 

See Also:

"com.fasterxml.jackson.core.JsonGenerator.Feature"

csvGeneratorFeatures

@Inject
protected Map<String,String> csvGeneratorFeatures

A comma-separated list of key-value pairs that specify com.fasterxml.jackson.dataformat.csv.CsvGenerator.Feature. Optional property and defaults to null. For example,

 ALWAYS_QUOTE_STRINGS=false, STRICT_CHECK_FOR_QUOTING=true, OMIT_MISSING_TAIL_COLUMNS=false
 

With the above configuration, this writer will quote string values only when necessary, and will omit columns without matching value when they are the last values of the row.

See Also:

"com.fasterxml.jackson.dataformat.csv.CsvGenerator.Feature"

outputDecorator

@Inject
protected Class outputDecorator

Fully-qualified name of a class that implements com.fasterxml.jackson.core.io.OutputDecorator, which can be used to decorate output destinations. Typical use is to use a filter abstraction (filtered output stream, writer) around original output destination, and apply additional processing during write operations. Optional property and defaults to null. For example,

 org.jberet.support.io.JsonItemReaderTest$NoopOutputDecorator
 

See Also:

"com.fasterxml.jackson.core.io.OutputDecorator", "com.fasterxml.jackson.core.JsonFactory#setOutputDecorator(com.fasterxml.jackson.core.io.OutputDecorator)"

csvGenerator

protected com.fasterxml.jackson.dataformat.csv.CsvGenerator csvGenerator

Constructor Detail

JacksonCsvItemWriter

public JacksonCsvItemWriter()

Method Detail

writeItems

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

Specified by:

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

Throws:

Exception

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

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

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

Throws:

Exception