org.jberet.support.io

Class CsvItemReader

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.CsvItemReaderWriterBase

org.jberet.support.io.CsvItemReader

All Implemented Interfaces:

javax.batch.api.chunk.ItemReader

@Named
 @Dependent
public class CsvItemReader
extends CsvItemReaderWriterBase
implements javax.batch.api.chunk.ItemReader

An implementation of javax.batch.api.chunk.ItemReader that reads from a CSV resource into a user-defined bean, java.util.List<String>, or java.util.Map<String, String>. Data files delimited with characters other than comma (e.g., tab, |) are also supported by configuring preference, delimiterChar, or quoteChar properties in job xml. 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, CsvItemWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected org.supercsv.io.ICsvReader	delegateReader
protected int	end Specify the end position in the data set (inclusive).
protected boolean	headerless Indicates that the input CSV resource does not contain header row.
protected int	start Specifies the start position (a positive integer starting from 1) to read the data.

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

Method Summary

Modifier and Type	Method and Description
Integer	checkpointInfo()
void	close()
void	open(Serializable checkpoint)
Object	readItem()

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

start

@Inject
protected int start

Specifies the start position (a positive integer starting from 1) to read the data. If reading from the beginning of the input CSV, there is no need to specify this property.

end

@Inject
protected int end

Specify the end position in the data set (inclusive). Optional property, and defaults to Integer.MAX_VALUE. If reading till the end of the input CSV, there is no need to specify this property.

headerless

@Inject
protected boolean headerless

Indicates that the input CSV resource does not contain header row. Optional property, valid values are true or false, and the default is false.

delegateReader

protected org.supercsv.io.ICsvReader delegateReader

Constructor Detail

CsvItemReader

public CsvItemReader()

Method Detail

open

public void open(Serializable checkpoint)
          throws Exception

Specified by:

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

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

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

Throws:

Exception

readItem

public Object readItem()
                throws Exception

Specified by:

readItem in interface javax.batch.api.chunk.ItemReader

Throws:

Exception

checkpointInfo

public Integer checkpointInfo()
                       throws Exception

Specified by:

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

Throws:

Exception