[AIX HP-UX Linux Solaris Windows]This topic applies only on the z/OS operating system.

FileReaderPattern

This pattern is used to read text data from a file.

Supporting classes

[oct2010] The TextFileReader class provides the logic to open and read text data line by line. [oct2010]

oct2010

Required properties

[oct2010] The following properties are required for the pattern. [oct2010]

oct2010

Table 1. Required properties
Property name Value
PATTERN_IMPL_CLASS Class implementing FileReaderPattern interface
FILENAME Complete path to the input file

Optional properties

[oct2010] The following properties are optional for the pattern [oct2010]
oct2010
.
Table 2. Optional properties
Property name Value Description

debug

true or false (default is false)

Enables detailed tracing on this batch datastream.

EnablePerformanceMeasurement

true or false (default is false)

Calculates the total time spent in the batch data-streams and the processRecord method, if you are using the GenericXDBatchStep.

EnableDetailedPerformanceMeasurement

true or false (default is false)

Provides a more detailed breakdown of time spent in each method of the batch data-streams.

file.encoding

Encoding of the file.

For example, 8859_1

AppendJobldToFileName

true or false (default is false)

Appends the JobID to the file name before loading the file.

Interface definition

public interface FileReaderPattern {

	/**
	 * Invoked during the step setup phase
	 * @param props
	 */
	public void initialize(Properties props);
	/**
	 * This method is invoked only once. It should be used
	 * to read any header data if necessary.
	 * @param reader
	 * @throws IOException
	 */
	public void processHeader(BufferedReader reader) throws IOException;
	
	/**
	 * This method should read the next line from the reader
	 * and return the data in suitable form to be processed
	 * by the step.
	 * @param reader
	 * @return
	 * @throws IOException
	 */
	public Object fetchRecord(BufferedReader reader) throws IOException;
  
   /**
 	  * This method can be optionally invoked from the process step 
    * to obtain the header data that was previously obtained during the processHeader 
    * call 
    * @return 
    */
    
     public Object fetchHeader(); 
}

xJCL example

<batch-data-streams>		 		 
<bds>
<logical-name>inputStream</logical-name>
<props>
     <prop name="PATTERN_IMPL_CLASS" value="com.ibm.websphere.batch.samples.tests.bds.EchoReader"/>
     <prop name="file.encoding" value="8859_1"/>
     <prop name="FILENAME" value="/opt/txlist.txt" />
     <prop name="debug" value="true"/>
</props>
<impl-class>com.ibm.websphere.batch.devframework.datastreams.patterns.TextFileReader</impl-class>
</bds>
</batch-data-streams>



Related concepts
Batch data stream framework and patterns
Related tasks
Using the batch data stream (BDS) framework
Related information
JDBCReaderPattern
JDBCWriterPattern
ByteReaderPattern
ByteWriterPattern
FileWriterPattern
[z/OS] RecordOrientedDatasetReaderPattern
[z/OS] RecordOrientedDataSetWriterPattern
JPAReaderPattern
JPAWriterPattern


Terms of Use | Feedback

Last updated: Oct 14, 2010 12:24:18 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=v700compg&product=was-nd-mp&topic=rgrid_btchpttrn5
File name: rgrid_btchpttrn5.html