Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T > Class Template Reference

A Summer.Batch reader for EBCDIC files.Given a file and a copybook it returns the records in the file. An IEbcdicReaderMapper is also required to match records to actual business objects More...

Inheritance diagram for Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T >:
Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T > Summer.Batch.Infrastructure.Item.File.IResourceAwareItemReaderItemStream< T > Summer.Batch.Common.Factory.IInitializationPostOperations Summer.Batch.Infrastructure.Item.Support.AbstractItemStreamItemReader< T > Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport Summer.Batch.Infrastructure.Item.IItemStreamReader< T > Summer.Batch.Infrastructure.Item.IItemStream

Public Member Functions

 EbcdicFileReader ()
 Default constructor More...
 
void AfterPropertiesSet ()
 
- Public Member Functions inherited from Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >
override T Read ()
 Reads a piece of input data and advance to the next one. Implementations must return null at the end of the input data set. In a transactional setting, caller might get the same item twice from successive calls (or otherwise), if the first call was in a transaction that rolled back. More...
 
override void Open (ExecutionContext executionContext)
 Open the stream for the provided ExecutionContext. More...
 
override void Close ()
 If any resources are needed for the stream to operate they need to be destroyed here. Once this method has been called all other methods (except open) may throw an exception. More...
 
override void Update (ExecutionContext executionContext)
 Indicates that the execution context provided during open is about to be saved. If any state is remaining, but has not been put in the context, it should be added here. More...
 
- Public Member Functions inherited from Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport
virtual void Flush ()
 Flushes the stream. More...
 
string GetExecutionContextKey (string key)
 Transform the given key to use the name of this instance as prefix. More...
 
virtual void Dispose ()
 

Protected Member Functions

override T DoRead ()
 
override void DoOpen ()
 
override void DoClose ()
 
- Protected Member Functions inherited from Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >
virtual void JumpToItem (int itemIndex)
 Move to the given item index. More...
 
- Protected Member Functions inherited from Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport
virtual void Dispose (bool disposing)
 Does the actual dipose, delegating to Close(); More...
 

Properties

IResource Resource [set]
 Resource property. More...
 
IResource Copybook [set]
 Copybook property. More...
 
IEbcdicReaderMapper< T > EbcdicReaderMapper [set]
 EbcdicReaderMapper property. More...
 
bool Rdw [set]
 Record descriptor word property. For file with variable size records, a word is used to give the record size. This flag indicates whether such a word is present or not. More...
 
- Properties inherited from Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >
int CurrentItemCount [protected get, set]
 The index of the item to start reading from. If the execution context contains a key [name].read.count (where [name] is the name of this component), the value from the execution context will be used instead. More...
 
int MaxItemCount [set]
 The maximum index of the items to be read. If the execution context contains a key [name].read.count.max (where [name] is the name of this component), the value from the execution context will be used instead. More...
 
bool SaveState [get, set]
 Flat that determines whether to save internal data in the execution context. Default value is true. Switch to false if you don't want to save any state from this stream or you don't want it to be restartable. More...
 
- Properties inherited from Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport
string Name [set]
 The name of the component that will be used as prefix for keys in the execution context. More...
 
- Properties inherited from Summer.Batch.Infrastructure.Item.File.IResourceAwareItemReaderItemStream< T >
IResource Resource [set]
 The T:Summer.Batch.IO.IResource to read from. More...
 

Detailed Description

A Summer.Batch reader for EBCDIC files.Given a file and a copybook it returns the records in the file. An IEbcdicReaderMapper is also required to match records to actual business objects

Template Parameters
T the type of the business objects to read
Type Constraints
T :class 

Constructor & Destructor Documentation

Member Function Documentation

void Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T >.AfterPropertiesSet ( )

See also
IInitializationPostOperations::AfterPropertiesSet

Implements Summer.Batch.Common.Factory.IInitializationPostOperations.

override void Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T >.DoClose ( )
protectedvirtual

See also
AbstractItemCountingItemStreamItemReader::DoClose

Implements Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >.

override void Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T >.DoOpen ( )
protectedvirtual

See also
AbstractItemCountingItemStreamItemReader::DoOpen

Implements Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >.

override T Summer.Batch.Extra.Ebcdic.EbcdicFileReader< T >.DoRead ( )
protectedvirtual

See also
AbstractItemCountingItemStreamItemReader::DoRead
Returns

Implements Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >.

Property Documentation

EbcdicReaderMapper property.

Record descriptor word property. For file with variable size records, a word is used to give the record size. This flag indicates whether such a word is present or not.

Resource property.


The documentation for this class was generated from the following file:
  • Summer.Batch.Extra/Ebcdic/EbcdicFileReader.cs