Class ScraperCsvConverter

Basic implementation of IScraperCsvConverter interface.

Inheritance
System.Object
ScraperCsvConverter
ScraperCsvBankOfScotland
ScraperCsvBarclays
ScraperCsvBMWBank
ScraperCsvBunq
ScraperCsvCommerzbank
ScraperCsvDkbVisa
ScraperCsvPostbank
ScraperCsvVW
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.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
System.String sName
System.String sFileNameSuffix
System.Text.Encoding aEncoding

Properties

FileNameSuffix

Declaration
public string FileNameSuffix { get; }
Property Value
Type Description
System.String

Name

Declaration
public string Name { get; }
Property Value
Type Description
System.String

Methods

Convert(out SepaStatement, Byte[], Int32, Int32)

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
System.Byte[] vbCsvData
System.Int32 nOffset
System.Int32 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
Subsembly.Csv.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[], Int32, Int32)

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
System.Byte[] vbCsvData
System.Int32 nOffset
System.Int32 nLength
Returns
Type Description
System.Text.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
System.Byte[] vbCsvData
Returns
Type Description
System.Text.Encoding

GetEncoding(Byte[], Int32, Int32)

Declaration
public Encoding GetEncoding(byte[] vbCsvData, int nOffset, int nLength)
Parameters
Type Name Description
System.Byte[] vbCsvData
System.Int32 nOffset
System.Int32 nLength
Returns
Type Description
System.Text.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.
Subsembly.Csv.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
Subsembly.Csv.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