org.easybatch.core.reader

Class BatchReader

java.lang.Object

org.easybatch.core.reader.BatchReader

All Implemented Interfaces:

RecordReader

Direct Known Subclasses:

AbstractBatchReader

public abstract class BatchReader
extends Object
implements RecordReader

Read a batch of records.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchSize
protected long	currentRecordNumber
protected RecordReader	delegate

Constructor Summary

Constructors

Constructor and Description
BatchReader(int batchSize, RecordReader delegate)

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.
abstract boolean	hasNextRecord() Check if the reader has a next record.
void	open() Open the reader.
abstract Batch	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

Field Detail

delegate

protected RecordReader delegate

batchSize

protected int batchSize

currentRecordNumber

protected long currentRecordNumber

Constructor Detail

BatchReader

public BatchReader(int batchSize,
           RecordReader delegate)

Method Detail

open

public void open()
          throws RecordReaderOpeningException

Description copied from interface: RecordReader

Open the reader.

Specified by:

open in interface RecordReader

Throws:

RecordReaderOpeningException - thrown if an exception occurs during reader opening

hasNextRecord

public abstract boolean hasNextRecord()

Description copied from interface: RecordReader

Check if the reader has a next record.

Specified by:

hasNextRecord in interface RecordReader

Returns:

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

readNextRecord

public abstract Batch readNextRecord()
                              throws RecordReadingException

Description copied from interface: RecordReader

Read next record from the data source.

Specified by:

readNextRecord in interface RecordReader

Returns:

the next record from the data source.

Throws:

RecordReadingException - thrown if an exception occurs during reading next record

getTotalRecords

public Long getTotalRecords()

Description copied from interface: RecordReader

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

Description copied from interface: RecordReader

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()
           throws RecordReaderClosingException

Description copied from interface: RecordReader

Close the reader.

Specified by:

close in interface RecordReader

Throws:

RecordReaderClosingException - thrown if an exception occurs during reader closing