CsvItemReaderWriterBase (jberet-support 1.3.0.Final API)

java.lang.Object
- org.jberet.support.io.ItemReaderWriterBase
- - org.jberet.support.io.CsvItemReaderWriterBase

Direct Known Subclasses:

CsvItemReader, CsvItemWriter
```
public abstract class CsvItemReaderWriterBase
extends ItemReaderWriterBase
```
The base class for CsvItemReader and CsvItemWriter. This class also holds common CSV-related batch artifact properties.

Since:

1.0.0

See Also:

CsvItemReader, CsvItemWriter

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class`	`beanType` Specifies a fully-qualified class or interface name that maps to a row of the source CSV file.
`protected org.supercsv.cellprocessor.ift.CellProcessor[]`	`cellProcessorInstances`
`protected String`	`cellProcessors` Specifies a list of cell processors, one for each column.
`protected String`	`charset` The name of the character set to be used for reading and writing data, e.g., UTF-8.
`protected String`	`commentMatcher` Specifies a `CommentMatcher` for reading CSV resource.
`protected String`	`delimiterChar` The delimiter character (separates each cell in a row).
`protected String`	`encoder` Specifies a custom encoder when writing CSV.
`protected String`	`endOfLineSymbols` The end of line symbols to use when writing (Windows, Mac and Linux style line breaks are all supported when reading, so this preference won't be used at all for reading).
`protected String[]`	`nameMapping` Specify the bean fields or map keys corresponding to CSV columns.
`protected String`	`preference` Specifies one of the 4 predefined CSV preferences: `STANDARD_PREFERENCE` `EXCEL_PREFERENCE` `EXCEL_NORTH_EUROPE_PREFERENCE` `TAB_PREFERENCE`
`protected String`	`quoteChar` The quote character (used when a cell contains special characters, such as the delimiter char, a quote char, or spans multiple lines).
`protected String`	`quoteMode` Allows you to enable surrounding quotes for writing (if a column wouldn't normally be quoted because it doesn't contain special characters).
`protected String`	`surroundingSpacesNeedQuotes` Whether spaces surrounding a cell need quotes in order to be preserved (see below).

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase
NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors
Constructor and Description

CsvItemReaderWriterBase()

Constructors
Constructor and Description
`CsvItemReaderWriterBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.supercsv.cellprocessor.ift.CellProcessor[]`	`getCellProcessors()` Gets the cell processors for reading CSV resource.
`protected org.supercsv.comment.CommentMatcher`	`getCommentMatcher(String val)` Gets the configured `org.supercsv.comment.CommentMatcher`.
`protected org.supercsv.prefs.CsvPreference`	`getCsvPreference()` Creates or obtains `org.supercsv.prefs.CsvPreference` according to the configuration in JSL document.
`protected org.supercsv.encoder.CsvEncoder`	`getEncoder(String val)` Gets the configured `org.supercsv.encoder.CsvEncoder`.
`protected String[]`	`getNameMapping()` Gets the field names of the target bean, if they differ from the CSV header, or if there is no CSV header.
`protected org.supercsv.quote.QuoteMode`	`getQuoteMode(String val)` Gets the configured `org.supercsv.quote.QuoteMode`.

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
  - nameMapping
```
@Inject
protected String[] nameMapping
```
    Specify the bean fields or map keys corresponding to CSV columns. If the CSV columns exactly match bean fields or map keys, then no need to specify this property.
    
    See Also:
    
    getNameMapping()
  - beanType
```
@Inject
protected Class beanType
```
    Specifies a fully-qualified class or interface name that maps to a row of the source CSV file. For example,
    - java.util.List
    - java.util.Map
    - org.jberet.support.io.Person
    - my.own.BeanType
  - preference
```
@Inject
protected String preference
```
    Specifies one of the 4 predefined CSV preferences:
    - STANDARD_PREFERENCE
    - EXCEL_PREFERENCE
    - EXCEL_NORTH_EUROPE_PREFERENCE
    - TAB_PREFERENCE
    See Also:
    
    getCsvPreference()
  - quoteChar
```
@Inject
protected String quoteChar
```
    The quote character (used when a cell contains special characters, such as the delimiter char, a quote char, or spans multiple lines). See CSV Preferences. The default quoteChar is double quote ("). If " is present in the CSV data cells, specify quoteChar to some other characters, e.g., |.
  - delimiterChar
```
@Inject
protected String delimiterChar
```
    The delimiter character (separates each cell in a row).
    
    See Also:
    
    CSV Preferences
  - endOfLineSymbols
```
@Inject
protected String endOfLineSymbols
```
    The end of line symbols to use when writing (Windows, Mac and Linux style line breaks are all supported when reading, so this preference won't be used at all for reading).
    
    See Also:
    
    CSV Preferences
  - surroundingSpacesNeedQuotes
```
@Inject
protected String surroundingSpacesNeedQuotes
```
    Whether spaces surrounding a cell need quotes in order to be preserved (see below). The default value is false (quotes aren't required).
    
    See Also:
    
    CSV Preferences
  - commentMatcher
```
@Inject
protected String commentMatcher
```
    Specifies a CommentMatcher for reading CSV resource. The CommentMatcher determines whether a line should be considered a comment. For example,
    - "startsWith #"
    - "matches 'regexp'"
    - "my.own.CommentMatcherImpl"
    See Also:
    
    CSV Preferences, getCommentMatcher(String)
  - encoder
```
@Inject
protected String encoder
```
    Specifies a custom encoder when writing CSV. For example,
    - default
    - select 1, 2, 3
    - select true, true, false
    - column 1, 2, 3
    - column true, true, false
    - my.own.MyCsvEncoder
    See Also:
    
    CSV Preferences, getEncoder(String)
  - quoteMode
```
@Inject
protected String quoteMode
```
    Allows you to enable surrounding quotes for writing (if a column wouldn't normally be quoted because it doesn't contain special characters). For example,
    - default
    - always
    - select 1, 2, 3
    - select true, true, false
    - column 1, 2, 3
    - column true, true, false
    - my.own.MyQuoteMode
    See Also:
    
    CSV Preferences, getQuoteMode(String)
  - cellProcessors
```
@Inject
protected String cellProcessors
```
    Specifies a list of cell processors, one for each column. See Super CSV docs for supported cell processor types. The rules and syntax are as follows:
    - The size of the resultant list must equal to the number of CSV columns.
    - Cell processors appear in the same order as CSV columns.
    - If no cell processor is needed for a column, enter null.
    - Each column may have null, 1, 2, or multiple cell processors, separated by comma (,)
    - Cell processors for different columns must be separated with semi-colon (;).
    - Cell processors may contain parameters enclosed in parenthesis, and multiple parameters are separated with comma (,).
    - string literals in cell processor parameters must be enclosed within single quotes, e.g., 'xxx'
    For example, to specify cell processors for 5-column CSV:
```
 value = "
      null;
      Optional, StrMinMax(1, 20);
      ParseLong;
      NotNull;
      Optional, ParseDate('dd/MM/yyyy')
 "
 
```
    See Also:
    
    Super CSV docs, getCellProcessors()
  - charset
```
@Inject
protected String charset
```
    The name of the character set to be used for reading and writing data, e.g., UTF-8. This property is optional, and if not set, the platform default charset is used.
  - cellProcessorInstances
```
protected org.supercsv.cellprocessor.ift.CellProcessor[] cellProcessorInstances
```
- Constructor Detail
  - CsvItemReaderWriterBase
```
public CsvItemReaderWriterBase()
```
- Method Detail
  - getCsvPreference
```
protected org.supercsv.prefs.CsvPreference getCsvPreference()
```
    Creates or obtains org.supercsv.prefs.CsvPreference according to the configuration in JSL document.
    
    Returns:
    
    CsvPreference
  - getCellProcessors
```
protected org.supercsv.cellprocessor.ift.CellProcessor[] getCellProcessors()
```
    Gets the cell processors for reading CSV resource. The default implementation returns an empty array, and subclasses may override it to provide more meaningful cell processors.
    
    Returns:
    
    an array of cell processors
  - getNameMapping
```
protected String[] getNameMapping()
```
    Gets the field names of the target bean, if they differ from the CSV header, or if there is no CSV header.
    
    Returns:
    
    an string array of field names of the target bean. Return null if CSV header exactly match the bean field.
  - getQuoteMode
```
protected org.supercsv.quote.QuoteMode getQuoteMode(String val)
```
    Gets the configured org.supercsv.quote.QuoteMode.
    Parameters:
    val - property value of quoteMode property in this batch artifact. For example,
    
    default
    always
    select 1, 2, 3
    select true, true, false
    column 1, 2, 3
    column true, true, false
    my.own.MyQuoteMode
    Returns:
    
    a QuoteMode
  - getEncoder
```
protected org.supercsv.encoder.CsvEncoder getEncoder(String val)
```
    Gets the configured org.supercsv.encoder.CsvEncoder.
    Parameters:
    val - property value of encoder property in this batch artifact. For example,
    
    default
    select 1, 2, 3
    select true, true, false
    column 1, 2, 3
    column true, true, false
    my.own.MyCsvEncoder
    Returns:
    
    a CsvEncoder
  - getCommentMatcher
```
protected org.supercsv.comment.CommentMatcher getCommentMatcher(String val)
```
    Gets the configured org.supercsv.comment.CommentMatcher.
    Parameters:
    val - property value of commentMatcher property in this batch artifact. For example,
    
    starts with '#'
    startswith '##'
    startsWith '##'
    matches '#.*#'
    my.own.MyCommentMatcher
    Returns:
    
    a CommentMatcher

Class CsvItemReaderWriterBase

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

nameMapping

beanType

preference

quoteChar

delimiterChar

endOfLineSymbols

surroundingSpacesNeedQuotes

commentMatcher

encoder

quoteMode

cellProcessors

charset

cellProcessorInstances

Constructor Detail

CsvItemReaderWriterBase

Method Detail

getCsvPreference

getCellProcessors

getNameMapping

getQuoteMode

getEncoder

getCommentMatcher