org.easybatch.core.reader

Class FileRecordReader

java.lang.Object

org.easybatch.core.reader.FileRecordReader

All Implemented Interfaces:

RecordReader

public class FileRecordReader
extends Object
implements RecordReader

A convenient RecordReader that recursively reads files in a directory.

This reader produces FileRecord instances.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

Constructor Summary

Constructors

Constructor and Description
FileRecordReader(File directory) Create a FileRecordReader to read files recursively from a given directory.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the reader.
String	getDataSourceName() This method returns a human readable data source name to be shown in the batch report.
Long	getTotalRecords() Get the total record number in the data source.
boolean	hasNextRecord() Check if the directory has a next file.
void	open() Open the reader.
FileRecord	readNextRecord() Read next record from the data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileRecordReader

public FileRecordReader(File directory)

Create a FileRecordReader to read files recursively from a given directory.

Parameters:

directory - the directory to read files from.

Method Detail

open

public void open()

Open the reader.

Specified by:

open in interface RecordReader

hasNextRecord

public boolean hasNextRecord()

Check if the directory has a next file.

Specified by:

hasNextRecord in interface RecordReader

Returns:

true if the reader has a next record, false else.

readNextRecord

public FileRecord readNextRecord()

Read next record from the data source.

Specified by:

readNextRecord in interface RecordReader

Returns:

the next record from the data source.

getTotalRecords

public Long getTotalRecords()

Get the total record number in the data source. This is useful to calculate execution progress.

Specified by:

getTotalRecords in interface RecordReader

Returns:

the total record number in the data source or null if the total records number cannot be calculated in advance

getDataSourceName

public String getDataSourceName()

This method returns a human readable data source name to be shown in the batch report.

Specified by:

getDataSourceName in interface RecordReader

Returns:

the data source name this reader is reading data from

close

public void close()

Close the reader.

Specified by:

close in interface RecordReader