Interface used by flat file input sources to read data from a string array. More...

Inheritance diagram for Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet:

Public Member Functions
string	ReadString (int index)
	Reads a field as a string. More...

string	ReadString (string name)
	Reads a field as a string. More...

string	ReadRawString (int index)
	Reads a field as a string. More...

string	ReadRawString (string name)
	Reads a field as a string. More...

bool	ReadBoolean (int index, string trueValue="true")
	Reads a field as a boolean. More...

bool	ReadBoolean (string name, string trueValue="true")
	Reads a field as a boolean. More...

char	ReadChar (int index)
	Reads a field as a character. More...

char	ReadChar (string name)
	Reads a field as a character. More...

byte	ReadByte (int index)
	Reads a field as a byte. More...

byte	ReadByte (string name)
	Reads a field as a byte. More...

short	ReadShort (int index)
	Reads a field as a short. More...

short	ReadShort (string name)
	Reads a field as a short. More...

int	ReadInt (int index)
	Reads a field as an int. More...

int	ReadInt (string name)
	Reads a field as an int. More...

int	ReadInt (int index, int defaultValue)
	Reads a field as an int. More...

int	ReadInt (string name, int defaultValue)
	Reads a field as an int. More...

long	ReadLong (int index)
	Reads a field as a long. More...

long	ReadLong (string name)
	Reads a field as a long. More...

long	ReadLong (int index, long defaultValue)
	Reads a field as a long. More...

long	ReadLong (string name, long defaultValue)
	Reads a field as a long. More...

float	ReadFloat (int index)
	Reads a field as a float. More...

float	ReadFloat (string name)
	Reads a field as a float. More...

double	ReadDouble (int index)
	Reads a field as a double. More...

double	ReadDouble (string name)
	Reads a field as a double. More...

decimal	ReadDecimal (int index)
	Reads a field as a decimal. More...

decimal	ReadDecimal (string name)
	Reads a field as a decimal. More...

decimal	ReadDecimal (int index, decimal defaultValue)
	Reads a field as a decimal. More...

decimal	ReadDecimal (string name, decimal defaultValue)
	Reads a field as a decimal. More...

DateTime	ReadDate (int index)
	Reads a field as a date. More...

DateTime	ReadDate (string name)
	Reads a field as a date. More...

DateTime	ReadDate (int index, DateTime defaultValue)
	Reads a field as a date. More...

DateTime	ReadDate (string name, DateTime defaultValue)
	Reads a field as a date. More...

DateTime	ReadDate (int index, string pattern)
	Reads a field as a date. More...

DateTime	ReadDate (string name, string pattern)
	Reads a field as a date. More...

DateTime	ReadDate (int index, string pattern, DateTime defaultValue)
	Reads a field as a date. More...

DateTime	ReadDate (string name, string pattern, DateTime defaultValue)
	Reads a field as a date. More...

Properties
int	Count `[get]`
	The number of fields in this field set. More...

bool	HasNames `[get]`
	Whether the field set has named fields. More...

string[]	Names `[get]`
	The names of the fields. More...

string[]	Values `[get]`
	The values of the fields. More...

Detailed Description

Interface used by flat file input sources to read data from a string array.

Member Function Documentation

bool Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadBoolean	(	int	index,
		string	trueValue = `"true"`
	)

Reads a field as a boolean.

Parameters

index	the index of the field to read
trueValue	the literal corresponding to true (default is `"true"`)

Returns: true if the field contains trueValue, false otherwise

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

bool Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadBoolean	(	string	name,
		string	trueValue = `"true"`
	)

Reads a field as a boolean.

Parameters

name	the name of the field to read
trueValue	the literal corresponding to true (default is `"true"`)

Returns: true if the field contains trueValue, false otherwise

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

byte Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadByte ( int index )

Reads a field as a byte.

Parameters

index the index of the field to read

Returns: the read byte

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

byte Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadByte ( string name )

Reads a field as a byte.

Parameters

name	the name of the field to read

Returns: the read byte

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

char Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadChar ( int index )

Reads a field as a character.

Parameters

index the index of the field to read

Returns: the read character

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

char Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadChar ( string name )

Reads a field as a character.

Parameters

name	the name of the field to read

Returns: the read character

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate ( int index )

Reads a field as a date.

Parameters

index the index of the field to read

Returns: the read date

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate ( string name )

Reads a field as a date.

Parameters

name	the name of the field to read

Returns: the read date

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	int	index,
		DateTime	defaultValue
	)

Reads a field as a date.

Parameters

index	the index of the field to read
defaultValue	the default value if the field is blank

Returns: the read date

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	string	name,
		DateTime	defaultValue
	)

Reads a field as a date.

Parameters

name	the name of the field to read
defaultValue	the default value if the field is blank

Returns: the read date

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	int	index,
		string	pattern
	)

Reads a field as a date.

Parameters

index	the index of the field to read
pattern	the pattern to use to parse the date

Returns: the read date

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	string	name,
		string	pattern
	)

Reads a field as a date.

Parameters

name	the name of the field to read
pattern	the pattern to use to parse the date

Returns: the read date

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	int	index,
		string	pattern,
		DateTime	defaultValue
	)

Reads a field as a date.

Parameters

index	the index of the field to read
pattern	the pattern to use to parse the date
defaultValue	the default value if the field is blank

Returns: the read date

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

DateTime Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDate	(	string	name,
		string	pattern,
		DateTime	defaultValue
	)

Reads a field as a date.

Parameters

name	the name of the field to read
pattern	the pattern to use to parse the date
defaultValue	the default value if the field is blank

Returns: the read date

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

decimal Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDecimal ( int index )

Reads a field as a decimal.

Parameters

index the index of the field to read

Returns: the read decimal

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

decimal Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDecimal ( string name )

Reads a field as a decimal.

Parameters

name	the name of the field to read

Returns: the read decimal

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

decimal Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDecimal	(	int	index,
		decimal	defaultValue
	)

Reads a field as a decimal.

Parameters

index	the index of the field to read
defaultValue	the default value if the field is blank

Returns: the read decimal

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

decimal Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDecimal	(	string	name,
		decimal	defaultValue
	)

Reads a field as a decimal.

Parameters

name	the name of the field to read
defaultValue	the default value if the field is blank

Returns: the read decimal

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

double Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDouble ( int index )

Reads a field as a double.

Parameters

index the index of the field to read

Returns: the read double

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

double Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadDouble ( string name )

Reads a field as a double.

Parameters

name	the name of the field to read

Returns: the read double

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

float Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadFloat ( int index )

Reads a field as a float.

Parameters

index the index of the field to read

Returns: the read float

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

float Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadFloat ( string name )

Reads a field as a float.

Parameters

name	the name of the field to read

Returns: the read float

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

int Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadInt ( int index )

Reads a field as an int.

Parameters

index the index of the field to read

Returns: the read int

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

int Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadInt ( string name )

Reads a field as an int.

Parameters

name	the name of the field to read

Returns: the read int

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

int Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadInt	(	int	index,
		int	defaultValue
	)

Reads a field as an int.

Parameters

index	the index of the field to read
defaultValue	the default value if the field is blank

Returns: the read int

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

int Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadInt	(	string	name,
		int	defaultValue
	)

Reads a field as an int.

Parameters

name	the name of the field to read
defaultValue	the default value if the field is blank

Returns: the read int

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

long Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadLong ( int index )

Reads a field as a long.

Parameters

index the index of the field to read

Returns: the read long

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

long Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadLong ( string name )

Reads a field as a long.

Parameters

name	the name of the field to read

Returns: the read long

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

long Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadLong	(	int	index,
		long	defaultValue
	)

Reads a field as a long.

Parameters

index	the index of the field to read
defaultValue	the default value if the field is blank

Returns: the read long

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

long Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadLong	(	string	name,
		long	defaultValue
	)

Reads a field as a long.

Parameters

name	the name of the field to read
defaultValue	the default value if the field is blank

Returns: the read long

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

string Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadRawString ( int index )

Reads a field as a string.

Parameters

index the index of the field to read

Returns: the raw content of the field

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

string Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadRawString ( string name )

Reads a field as a string.

Parameters

name	the name of the field to read

Returns: the raw content of the field

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

short Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadShort ( int index )

Reads a field as a short.

Parameters

index the index of the field to read

Returns: the read short

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

short Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadShort ( string name )

Reads a field as a short.

Parameters

name	the name of the field to read

Returns: the read short

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

string Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadString ( int index )

Reads a field as a string.

Parameters

index the index of the field to read

Returns: the trimmed content of the field

Exceptions

ArgumentOutOfRangeException if the index does not correspond to a field

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

string Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.ReadString ( string name )

Reads a field as a string.

Parameters

name	the name of the field to read

Returns: the trimmed content of the field

Exceptions

ArgumentException if no field has the given name

Implemented in Summer.Batch.Infrastructure.Item.File.Transform.DefaultFieldSet.

Property Documentation

int Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.Count

get

The number of fields in this field set.

bool Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.HasNames

get

Whether the field set has named fields.

string [] Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.Names

get

The names of the fields.

string [] Summer.Batch.Infrastructure.Item.File.Transform.IFieldSet.Values

get

The values of the fields.

The documentation for this interface was generated from the following file:

Summer.Batch.Infrastructure/Item/File/Transform/IFieldSet.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation