Class ScraperCsvConverter

Basic implementation of IScraperCsvConverter interface.

Inheritance

object

ScraperCsvConverter

ScraperCsvBMWBank

ScraperCsvBankOfScotland

ScraperCsvBarclays

ScraperCsvBunq

ScraperCsvCommerzbank

ScraperCsvDkbVisa

ScraperCsvN26

ScraperCsvPostbank

ScraperCsvVW

Implements

IScraperCsvConverter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Subsembly.Scraper

Assembly: Subsembly.Scraper.dll

Syntax

public abstract class ScraperCsvConverter : IScraperCsvConverter

Constructors

ScraperCsvConverter(string, string, Encoding)

Declaration

protected ScraperCsvConverter(string sName, string sFileNameSuffix, Encoding aEncoding = null)

Parameters

Type	Name	Description
string	sName
string	sFileNameSuffix
Encoding	aEncoding

Properties

FileNameSuffix

Declaration

public string FileNameSuffix { get; }

Property Value

Type	Description
string

Name

Declaration

public string Name { get; }

Property Value

Type	Description
string

Methods

Convert(out SepaStatement, byte[], int, int)

Converts a raw, binary CSV data blob that contains account statement data to a CAMT statement for further processing.

Declaration

public ScraperResult Convert(out SepaStatement aStmt, byte[] vbCsvData, int nOffset, int nLength)

Parameters

Type	Name	Description
SepaStatement	aStmt
byte[]	vbCsvData
int	nOffset
int	nLength

Returns

Type	Description
ScraperResult

CreateCsv()

Creates a Subsembly.Csv.CsvFile instance, suitable for parsing the CSV format.

Declaration

protected virtual CsvFile CreateCsv()

Returns

Type	Description
CsvFile

Remarks

The default implementation returns a default constructed Subsembly.Csv.CsvFile.

A derived class may override this method in order to provide a suitably initialized Subsembly.Csv.CsvFile appropriate for its CSV format.

DetectEncoding(byte[], int, int)

Tries to detect the correct encoding from the given binary CSV data.

Declaration

protected virtual Encoding DetectEncoding(byte[] vbCsvData, int nOffset, int nLength)

Parameters

Type	Name	Description
byte[]	vbCsvData
int	nOffset
int	nLength

Returns

Type	Description
Encoding

Remarks

A derived class may override this method in order to provide a well known encoding appropriate for its CSV format.

GetEncoding(byte[])

Declaration

public Encoding GetEncoding(byte[] vbCsvData)

Parameters

Type	Name	Description
byte[]	vbCsvData

Returns

Type	Description
Encoding

GetEncoding(byte[], int, int)

Declaration

public Encoding GetEncoding(byte[] vbCsvData, int nOffset, int nLength)

Parameters

Type	Name	Description
byte[]	vbCsvData
int	nOffset
int	nLength

Returns

Type	Description
Encoding

ReadCsvFinish(SepaStatement)

Finalize reading of the CSV file.

Declaration

protected virtual ScraperResult ReadCsvFinish(SepaStatement aStmt)

Parameters

Type	Name	Description
SepaStatement	aStmt

Returns

Type	Description
ScraperResult

Remarks

The default implementation just returns Subsembly.Scraper.ScraperResult.Success. An implementation may override this in order to set accumulated values in the SepaStatement.

ReadCsvHeader(SepaStatement, CsvFile)

Read the header part of the CSV file.

Declaration

protected virtual ScraperResult ReadCsvHeader(SepaStatement aStmt, CsvFile aCsvFile)

Parameters

Type	Name	Description
SepaStatement	aStmt	At this time an basically empty SepaStatement. Any useful information that can be obtained from the CSV header, such as account information or balance values, can be stored into this.
CsvFile	aCsvFile

Returns

Type	Description
ScraperResult

Remarks

The default implementation just calls Subsembly.Csv.CsvFile.ReadHeader() and returns Subsembly.Scraper.ScraperResult.Success. An implementation may have to override this in order to read more complicate multi-line header structures.

ReadCsvValues(SepaStatement, CsvValues)

Read the given Subsembly.Csv.CsvValues and probably add a new SepaStatementEntry to the SepaStatement.

Declaration

protected abstract ScraperResult ReadCsvValues(SepaStatement aStmt, CsvValues aCsv)

Parameters

Type	Name	Description
SepaStatement	aStmt
CsvValues	aCsv

Returns

Type	Description
ScraperResult

ResetCsv()

Override this in order to reset any instance data used for the CSV import.

Declaration

protected virtual void ResetCsv()

Implements

IScraperCsvConverter