Public Member Functions | Protected Member Functions | Properties | List of all members
Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer Class Referenceabstract

Abstract base class for ILineTokenizer implementations. More...

Inheritance diagram for Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer:
Summer.Batch.Infrastructure.Item.File.Transform.ILineTokenizer Summer.Batch.Infrastructure.Item.File.Transform.DelimitedLineTokenizer Summer.Batch.Infrastructure.Item.File.Transform.FixedLengthTokenizer

Public Member Functions

IFieldSet Tokenize (string line)
 Split a line into tokens. More...
 

Protected Member Functions

 AbstractLineTokenizer ()
 Default parameterless constructor to create default values. More...
 
abstract IList< string > DoTokenize (string line)
 Abstract method that does the actual tokenizing. More...
 

Properties

string[] Names [get, set]
 Column names. May be null. More...
 
bool Strict [get, set]
 Property for strict mode. In strict mode the resulting field set must have the specified number of columns. If not in strict mode, the field set will be padded with empty columns or truncated to adjust its size. More...
 
IFieldSetFactory FieldSetFactory [get, set]
 The factory that creates field sets. Default is an instance of DefaultFieldSetFactory. More...
 
bool HasNames [get]
 Whether column names are specified. More...
 

Detailed Description

Abstract base class for ILineTokenizer implementations.

Constructor & Destructor Documentation

Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.AbstractLineTokenizer ( )
protected

Default parameterless constructor to create default values.

Member Function Documentation

abstract IList<string> Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.DoTokenize ( string  line)
protectedpure virtual

Abstract method that does the actual tokenizing.

Parameters
linethe line to tokenize
Returns
a list of field values

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DelimitedLineTokenizer, and Summer.Batch.Infrastructure.Item.File.Transform.FixedLengthTokenizer.

IFieldSet Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.Tokenize ( string  line)

Split a line into tokens.

Parameters
linethe line to tokenize
Returns
a fieldset containing the tokens

Implements Summer.Batch.Infrastructure.Item.File.Transform.ILineTokenizer.

Property Documentation

IFieldSetFactory Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.FieldSetFactory
getset

The factory that creates field sets. Default is an instance of DefaultFieldSetFactory.

bool Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.HasNames
get

Whether column names are specified.

string [] Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.Names
getset

Column names. May be null.

bool Summer.Batch.Infrastructure.Item.File.Transform.AbstractLineTokenizer.Strict
getset

Property for strict mode. In strict mode the resulting field set must have the specified number of columns. If not in strict mode, the field set will be padded with empty columns or truncated to adjust its size.

The documentation for this class was generated from the following file:
  • Summer.Batch.Infrastructure/Item/File/Transform/AbstractLineTokenizer.cs