org.easybatch.core.reader

Class StringRecordReader

java.lang.Object

org.easybatch.core.reader.StringRecordReader

All Implemented Interfaces:

RecordReader

public class StringRecordReader
extends Object
implements RecordReader

A convenient RecordReader that reads data from a String.

This reader produces StringRecord instances.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

Constructor Summary

Constructors

Constructor and Description
StringRecordReader(String dataSource) Create a StringRecordReader.

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.
StringRecord	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

StringRecordReader

public StringRecordReader(String dataSource)

Create a StringRecordReader.

Parameters:

dataSource - The String data source

Method Detail

open

public void open()

Description copied from interface: RecordReader

Open the reader.

Specified by:

open in interface RecordReader

hasNextRecord

public 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 StringRecord readNextRecord()

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.

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

Description copied from interface: RecordReader

Close the reader.

Specified by:

close in interface RecordReader