org.jberet.support.io

Class JacksonCsvItemReaderWriterBase

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.JacksonCsvItemReaderWriterBase

Direct Known Subclasses:

JacksonCsvItemReader, JacksonCsvItemWriter

public abstract class JacksonCsvItemReaderWriterBase
extends JsonItemReaderWriterBase

The base class for JacksonCsvItemReader and JacksonCsvItemWriter.

Since:

1.1.0

See Also:

JacksonCsvItemReader, JacksonCsvItemWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected Class	beanType For ItemReader, it's the java type that each data item should be converted to; for ItemWriter, it's the java type for each incoming data item.
protected String	columns Specifies CSV schema in one of the 2 ways: columns = "<fully-qualified class name>": CSV schema is defined in the named POJO class, which typically has class-level annotation com.fasterxml.jackson.annotation.JsonPropertyOrder to define property order corresponding to CSV column order.
protected String	columnSeparator Character used to separate values.
protected com.fasterxml.jackson.dataformat.csv.CsvMapper	csvMapper
protected String	nullValue When asked to write Java `null`, this String value will be used instead.
protected String	quoteChar Character used for quoting values that contain quote characters or linefeeds.
protected boolean	useHeader whether the first line of physical document defines column names (true) or not (false): if enabled, parser will take first-line values to define column names; and generator will output column names as the first line.

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
JacksonCsvItemReaderWriterBase()

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.dataformat.csv.CsvSchema	buildCsvSchema(com.fasterxml.jackson.dataformat.csv.CsvSchema schema)
protected void	init()
protected void	initJsonFactory() Initializes JsonFactory or its subtypes, e.g., com.fasterxml.jackson.dataformat.xml.XmlFactory, or com.fasterxml.jackson.dataformat.csv.CsvFactory.

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

beanType

@Inject
protected Class beanType

For ItemReader, it's the java type that each data item should be converted to; for ItemWriter, it's the java type for each incoming data item. In either case, the valid values are:

• a custom java type that represents data item and serves as the CSV schema class
• java.util.Map
• java.util.List
• java.lang.String[]
• com.fasterxml.jackson.databind.JsonNode

When using java.util.List or java.lang.String[] for reading, it is deemed raw access, and CSV schema will not be configured and any schema-related properties are ignored. Specifically, CSV header and comment lines are read as raw access content.

columns

@Inject
protected String columns

Specifies CSV schema in one of the 2 ways:

• columns = "<fully-qualified class name>":
  CSV schema is defined in the named POJO class, which typically has class-level annotation com.fasterxml.jackson.annotation.JsonPropertyOrder to define property order corresponding to CSV column order.
• columns = "<comma-separated list of column names, each of which may be followed by a space and column type>":
  use the value to manually build CSV schema. Valid column types are defined in com.fasterxml.jackson.dataformat.csv.CsvSchema.ColumnType, including:
  • STRING
  • STRING_OR_LITERAL
  • NUMBER
  • NUMBER_OR_STRING
  • BOOLEAN
  • ARRAY
  For complete list and descriptioin, see com.fasterxml.jackson.dataformat.csv.CsvSchema.ColumnType javadoc.

For example,

 columns = "org.jberet.support.io.StockTrade"
 columns = "firstName STRING, lastName STRING, age NUMBER"
 

In JacksonCsvItemReader, if this property is not defined and useHeader is true (CSV input has a header), the header is used to create CSV schema. However, when beanType is java.util.List or java.lang.String[], the reader is considered raw access, and all schema-related properties are ignored.

This property is optional for reader and required for writer class.

See Also:

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

useHeader

@Inject
protected boolean useHeader

whether the first line of physical document defines column names (true) or not (false): if enabled, parser will take first-line values to define column names; and generator will output column names as the first line. Optional property.

For JacksonCsvItemReader, if beanType is java.util.List or java.lang.String[], it is considered raw access, useHeader property is ignored and no CSV schema is used.

valid values are true or false, and the default is false.

See Also:

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

quoteChar

@Inject
protected String quoteChar

Character used for quoting values that contain quote characters or linefeeds. Optional property and defaults to " (double-quote character).

See Also:

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

columnSeparator

@Inject
protected String columnSeparator

Character used to separate values.

Optional property and defaults to , (comma character). Other commonly used values include tab ('\t') and pipe ('|')

See Also:

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

nullValue

@Inject
protected String nullValue

When asked to write Java `null`, this String value will be used instead. Optional property and defaults to empty string.

See Also:

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

csvMapper

protected com.fasterxml.jackson.dataformat.csv.CsvMapper csvMapper

Constructor Detail

JacksonCsvItemReaderWriterBase

public JacksonCsvItemReaderWriterBase()

Method Detail

init

protected void init()
             throws Exception

Throws:

Exception

initJsonFactory

protected void initJsonFactory()
                        throws Exception

Description copied from class: JsonItemReaderWriterBase

Initializes JsonFactory or its subtypes, e.g., com.fasterxml.jackson.dataformat.xml.XmlFactory, or com.fasterxml.jackson.dataformat.csv.CsvFactory. The factory should be initialized with a valid ObjectMapper. Subclass may override this method to use different concrete types of JsonFactory.

Overrides:

initJsonFactory in class JsonItemReaderWriterBase

Throws:

Exception

buildCsvSchema

protected com.fasterxml.jackson.dataformat.csv.CsvSchema buildCsvSchema(com.fasterxml.jackson.dataformat.csv.CsvSchema schema)
                                                                 throws Exception

Throws:

Exception