org.easybatch.core.reader

Interface RecordReader

All Known Implementing Classes:

AbstractBatchReader, BatchReader, BlockingQueueRecordReader, FileBatchReader, FileRecordReader, IterableBatchReader, IterableRecordReader, StandardInputRecordReader, StringBatchReader, StringRecordReader

public interface RecordReader

Interface for record reader. This will be used by easy batch to sequentially read records from a data source.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

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 reader has a next record.
void	open() Open the reader.
Record	readNextRecord() Read next record from the data source.

Method Detail

open

void open()
          throws RecordReaderOpeningException

Open the reader.

Throws:

RecordReaderOpeningException - thrown if an exception occurs during reader opening

hasNextRecord

boolean hasNextRecord()

Check if the reader has a next record.

Returns:

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

readNextRecord

Record readNextRecord()
                      throws RecordReadingException

Read next record from the data source.

Returns:

the next record from the data source.

Throws:

RecordReadingException - thrown if an exception occurs during reading next record

getTotalRecords

Long getTotalRecords()

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

Returns:

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

getDataSourceName

String getDataSourceName()

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

Returns:

the data source name this reader is reading data from

close

void close()
           throws RecordReaderClosingException

Close the reader.

Throws:

RecordReaderClosingException - thrown if an exception occurs during reader closing