BeanIOFlatFileItemReader (2.1.0 2.1.0 API)

java.lang.Object
- org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>
- - org.beanio.spring.BeanIOFlatFileItemReader<T>

Type Parameters:

T - Class type read from the file

All Implemented Interfaces:

ResourceAwareItemReaderItemStream<T>, ItemReader<T>, ItemStream, ItemStreamReader<T>, InitializingBean
```
public class BeanIOFlatFileItemReader<T>
extends AbstractItemCountingItemStreamItemReader<T>
implements ResourceAwareItemReaderItemStream<T>, InitializingBean
```
A Spring Batch item reader that uses a BeanIO stream mapping file to read items from a flat file. Restart capabilities are fully supported.
This implementation requires Spring 2.5 or greater, and Spring Batch 2.1.x.

Since:

1.2

Constructor Summary

Constructors
Constructor and Description

BeanIOFlatFileItemReader()
Constructs a new BeanIOFlatFileItemReader.

Constructors
Constructor and Description
`BeanIOFlatFileItemReader()` Constructs a new `BeanIOFlatFileItemReader`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected void`	`doClose()`
`protected void`	`doOpen()`
`protected T`	`doRead()`
`protected BeanReader`	`getBeanReader()` Returns the underlying `BeanReader`.
`int`	`getLineNumber()` Returns the starting line number of the first record for the most recent bean object read from this reader, or -1 when the end of the stream is reached.
`RecordContext`	`getRecordContext(int index)` Returns record information for the most recent bean object read from this reader.
`int`	`getRecordCount()` Returns the number of records read from the underlying input stream for the most recent bean object read from this reader.
`String`	`getRecordName()` Returns the record or group name of the most recent bean object read from this reader, or null if the end of the stream was reached.
`protected void`	`initializeStreamFactory()` Creates a `StreamFactory` if one was not set, loads the stream mapping resource if set, and validates the `StreamFactory` has a mapping for the configured stream name.
`protected void`	`jumpToItem(int itemIndex)`
`void`	`setEncoding(String encoding)` Sets the input stream encoding.
`void`	`setErrorHandler(BeanReaderErrorHandler errorHandler)` Sets the BeanIO error handler for handling BeanIO specific exceptions.
`void`	`setLocale(String locale)` Sets the locale for resolving error messages from a stream mapping's configured resource bundle.
`void`	`setResource(Resource resource)`
`void`	`setStreamFactory(StreamFactory streamFactory)` Sets the `StreamFactory` for loading stream mapping configurations.
`void`	`setStreamMapping(Resource streamMapping)` Sets the mapping file resource.
`void`	`setStreamName(String streamName)` Sets the mapping configuration's stream name for reading this input stream.
`void`	`setStrict(boolean strict)` In strict mode this reader will throw an exception if the input resource does not exist when opened.
`void`	`setUseSpringExceptions(boolean useSpringExceptions)` Set to `true` to force `AbstractItemCountingItemStreamItemReader.read()` to wrap BeanIO exceptions to their closest Spring-batch counterpart.

Methods inherited from class org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader
close, getCurrentItemCount, getExecutionContextUserSupport, isSaveState, open, read, setCurrentItemCount, setMaxItemCount, setName, setSaveState, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.batch.item.ItemStream
close, open, update

Methods inherited from interface org.springframework.batch.item.ItemReader
read

- Constructor Detail
  - BeanIOFlatFileItemReader
```
public BeanIOFlatFileItemReader()
```
    Constructs a new BeanIOFlatFileItemReader.
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception
  - doRead
```
protected T doRead()
            throws Exception
```
    Specified by:
    
    doRead in class AbstractItemCountingItemStreamItemReader<T>
    
    Throws:
    
    Exception
  - doOpen
```
protected void doOpen()
               throws Exception
```
    Specified by:
    
    doOpen in class AbstractItemCountingItemStreamItemReader<T>
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
                throws Exception
```
    Specified by:
    
    doClose in class AbstractItemCountingItemStreamItemReader<T>
    
    Throws:
    
    Exception
  - jumpToItem
```
protected void jumpToItem(int itemIndex)
                   throws Exception
```
    Overrides:
    
    jumpToItem in class AbstractItemCountingItemStreamItemReader<T>
    
    Throws:
    
    Exception
  - initializeStreamFactory
```
protected void initializeStreamFactory()
                                throws Exception
```
    Creates a StreamFactory if one was not set, loads the stream mapping resource if set, and validates the StreamFactory has a mapping for the configured stream name.
    
    Throws:
    
    IllegalStateException - if the configured stream name is not found in the StreamFactory after loading the stream mapping
    
    Exception
  - getRecordName
```
public String getRecordName()
```
    Returns the record or group name of the most recent bean object read from this reader, or null if the end of the stream was reached.
    
    Returns:
    
    the record or group name, or null if the stream is closed
    
    Since:
    
    2.0.6
  - getLineNumber
```
public int getLineNumber()
```
    Returns the starting line number of the first record for the most recent bean object read from this reader, or -1 when the end of the stream is reached. The line number may be zero if new lines are not used to separate characters.
    
    Returns:
    
    the line number, or -1 if the stream is closed
    
    Since:
    
    2.0.6
  - getRecordCount
```
public int getRecordCount()
```
    Returns the number of records read from the underlying input stream for the most recent bean object read from this reader. This typically returns 1 unless a bean object was mapped to a record group which may span multiple records.
    
    Returns:
    
    the record count, or -1 if the stream is closed
    
    Since:
    
    2.0.6
  - getRecordContext
```
public RecordContext getRecordContext(int index)
                               throws IndexOutOfBoundsException
```
    Returns record information for the most recent bean object read from this reader. If a bean object can span multiple records, getRecordCount() can be used to determine how many records were read from the stream.
    
    Parameters:
    
    index - the index of the record, starting at 0
    
    Returns:
    
    the RecordContext, or null if the stream is closed
    
    Throws:
    
    IndexOutOfBoundsException - if there is no record for the given index
    
    Since:
    
    2.0.6
    
    See Also:
    
    getRecordCount()
  - getBeanReader
```
protected BeanReader getBeanReader()
```
    Returns the underlying BeanReader.
    
    Returns:
    
    the BeanReader, or null if the stream is closed
    
    Since:
    
    2.0.6
  - setResource
```
public void setResource(Resource resource)
```
    Specified by:
    
    setResource in interface ResourceAwareItemReaderItemStream<T>
  - setStrict
```
public void setStrict(boolean strict)
```
    In strict mode this reader will throw an exception if the input resource does not exist when opened. Defaults to true.
    
    Parameters:
    
    strict - set to false to disable resource validation
  - setStreamFactory
```
public void setStreamFactory(StreamFactory streamFactory)
```
    Sets the StreamFactory for loading stream mapping configurations. If not set, a new default StreamFactory is created.
    
    Parameters:
    
    streamFactory - the StreamFactory to use for loading stream mapping configurations
  - setStreamMapping
```
public void setStreamMapping(Resource streamMapping)
```
    Sets the mapping file resource. A mapping file is required if a stream factory is not set.
    
    Parameters:
    
    streamMapping - the stream mapping resource
  - setStreamName
```
public void setStreamName(String streamName)
```
    Sets the mapping configuration's stream name for reading this input stream.
    
    Parameters:
    
    streamName - the stream name
  - setEncoding
```
public void setEncoding(String encoding)
```
    Sets the input stream encoding. If not set, the default system charset is used to read the input stream.
    
    Parameters:
    
    encoding - input stream encoding
  - setUseSpringExceptions
```
public void setUseSpringExceptions(boolean useSpringExceptions)
```
    Set to true to force AbstractItemCountingItemStreamItemReader.read() to wrap BeanIO exceptions to their closest Spring-batch counterpart. Defaults to false.
    - BeanReaderIOException becomes NonTransientResourceException
    - MalformedRecordException becomes NonTransientResourceException
    - UnexpectedRecordException becomes NonTransientResourceException
    - UnidentifiedRecordException becomes UnexpectedInputException
    - InvalidRecordException becomes ParseException
    Parameters:
    
    useSpringExceptions - set to true to map BeanIO exceptions to their Spring-batch counterpart
  - setErrorHandler
```
public void setErrorHandler(BeanReaderErrorHandler errorHandler)
```
    Sets the BeanIO error handler for handling BeanIO specific exceptions. If no error handler is set, the AbstractItemCountingItemStreamItemReader.read() method will throw the exception directly.
    
    Parameters:
    
    errorHandler - the BeanReaderErrorHandler for handling exceptions
  - setLocale
```
public void setLocale(String locale)
```
    Sets the locale for resolving error messages from a stream mapping's configured resource bundle. By default, the system default locale is used.
    
    Parameters:
    
    locale - the locale for resolving error messages

Class BeanIOFlatFileItemReader<T>

Constructor Summary

Method Summary

Methods inherited from class org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.batch.item.ItemStream

Methods inherited from interface org.springframework.batch.item.ItemReader

Constructor Detail

BeanIOFlatFileItemReader

Method Detail

afterPropertiesSet

doRead

doOpen

doClose

jumpToItem

initializeStreamFactory

getRecordName

getLineNumber

getRecordCount

getRecordContext

getBeanReader

setResource

setStrict

setStreamFactory

setStreamMapping

setStreamName

setEncoding

setUseSpringExceptions

setErrorHandler

setLocale