Specialized DataSource for CSV data (character separated values). More...

Public Member Functions
ComputedField	AddComputedField (string name)
	Creates and adds a ComputedField to the DataSource. More...

DSFieldMapping	AddFieldMapping (string name)
	Creates and adds a DSFieldMapping to the DataSource. More...

DataSourceParameter	AddParameter (string name)
	Creates and adds a DataSourceParameter to the DataSource. More...

void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

ComputedField	GetComputedField (string name)
	Gets a ComputedField defined in the DataSource. More...

DSFieldMapping	GetFieldMapping (string name)
	Gets a DSFieldMapping defined in the DataSource. More...

DataSourceParameter	GetParameter (string name)
	Gets a DataSourceParameter defined in the DataSource. More...

void	RemoveComputedField (ComputedField computedField)
	Removes the ComputedField from the DataSource. More...

void	RemoveComputedField (string name)
	Removes the ComputedField from the DataSource. More...

void	RemoveFieldMapping (DSFieldMapping fieldMapping)
	Removes the DSFieldMapping from the DataSource. More...

void	RemoveFieldMapping (string name)
	Removes the DSFieldMapping from the DataSource. More...

void	RemoveParameter (DataSourceParameter datasourceParameter)
	Removes the DataSourceParameter from the DataSource. More...

void	RemoveParameter (string name)
	Removes the DataSourceParameter from the DataSource. More...

override string	ToString ()
	Returns a string representation of the instance. More...

Properties
string	Comment `[get, set]`
	Gets/Sets the comment for the DataSource. More...

string	CopyColumnName `[get, set]`
	Gets/Sets the CopyColumnName of the DataSource. More...

string	Description `[get, set]`
	Gets/Sets the description of the DataSource. More...

string	Filename `[get, set]`
	Gets/Sets the filename of the CSV file. More...

ComputedField	FirstComputedField `[get]`
	Gets the first ComputedField defined in the DataSource. More...

DSFieldMapping	FirstFieldMapping `[get]`
	Gets the first DSFieldMapping defined in the DataSource. More...

DataSourceParameter	FirstParameter `[get]`
	Gets the first DataSourceParameter defined in the DataSource. More...

bool	HandleEscapeSequences `[get, set]`
	Gets/Sets if escape sequences should be translated on data retrieval or not. More...

bool	HasColumnNames `[get, set]`
	Gets/Sets if the DataSourceCsv expects column names in the first line of the CSV file. More...

bool	IsDefault `[get]`
	Gets a value indicating whether this object stores the default DataSource. More...

string	Name `[get, set]`
	Gets/Sets the name of the DataSource. More...

DataSource	Next `[get]`
	Gets the next DataSource instance defined in the Project. More...

int	NumberOfComputedFields `[get]`
	Gets the number of ComputedFields defined in the DataSource. More...

int	NumberOfFieldMappings `[get]`
	Gets the number of DSFieldMappings defined in the DataSource. More...

int	NumberOfParameters `[get]`
	Gets the number of DataSourceParameters defined in the DataSource. More...

string	Qualifier `[get, set]`
	Gets/Sets the qualifier character that encloses DataField values. More...

string	Separator `[get, set]`
	Gets/Sets the separator character that separates DataField-names or DataField-values. More...

DataSourceType	Type `[get]`
	Gets the type of the DataSource. More...

Detailed Description

Specialized DataSource for CSV data (character separated values).

Overview

DataSourceCsv is a specialized DataSource for importing data from CSV files. This class is used to manipulate existing DataSourceCsv objects.
To create a new DataSource use TFORMer Designer or Project.AddDataSource.

The main properties to characterize a DataSourceCsv are:

The filename
The separator character
This is usually a comma , and separates the single column names (= the names of the DataFields) and column values (= values of DataFields) from each other
The qualifier character
The qualifier character encloses column-values (e.g. "This is a string").
Has column names
Specifies if the CSV file contains the DataField names in the first line. If no names are provided TFORMer assumes the names Field_0, Field_1, etc.

Modifying an Existing CSV-DataSource

  // Retrieve the global Project
  // DataSources are defined in a Project or a global Project
  Project project = repository.GlobalProject;
 
  // Retrieve the DataSource by name
  // Since we know the type of the DataSource, we can cast it to DataSourceCsv
  DataSourceCsv dataSource = (DataSourceCsv)project.GetDataSource("CSV");
 
  // Modify some DataSource properties  
  dataSource.Qualifier = "'";
  dataSource.Separator = ",";  

Member Function Documentation

◆ AddComputedField()

ComputedField AddComputedField ( string name )

inherited

Creates and adds a ComputedField to the DataSource.

Parameters

name	The name of the ComputedField

Returns: A new ComputedField

See also: ComputedField

◆ AddFieldMapping()

DSFieldMapping AddFieldMapping ( string name )

inherited

Creates and adds a DSFieldMapping to the DataSource.

Parameters

name	The name of the DataField for which a DSFieldMapping should be created.

Returns: A new DSFieldMapping

◆ AddParameter()

DataSourceParameter AddParameter ( string name )

inherited

Creates and adds a DataSourceParameter to the DataSource.

Parameters

name	The name of the DataSourceParameter

Returns: A new DataSourceParameter

See also: DataSourceParameter

◆ Dispose()

void Dispose ( )

inherited

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ GetComputedField()

ComputedField GetComputedField ( string name )

inherited

Gets a ComputedField defined in the DataSource.

Parameters

name	The name of the ComputedField

Returns: A valid object instance or null

See also: ComputedField

◆ GetFieldMapping()

DSFieldMapping GetFieldMapping ( string name )

inherited

Gets a DSFieldMapping defined in the DataSource.

Retrieves the DSFieldMapping for a given DataField name from the DataSource

Parameters

name	The name of a DataField

Returns: A valid object instance or null

◆ GetParameter()

DataSourceParameter GetParameter ( string name )

inherited

Gets a DataSourceParameter defined in the DataSource.

Parameters

name	The name of the DataSourceParameter

Returns: A valid object instance or null

See also: DataSourceParameter

◆ RemoveComputedField() [1/2]

void RemoveComputedField ( ComputedField computedField )

inherited

Removes the ComputedField from the DataSource.

Parameters

computedField The ComputedField

See also: ComputedField

◆ RemoveComputedField() [2/2]

void RemoveComputedField ( string name )

inherited

Removes the ComputedField from the DataSource.

Parameters

name	The name of the ComputedField

See also: ComputedField

◆ RemoveFieldMapping() [1/2]

void RemoveFieldMapping ( DSFieldMapping fieldMapping )

inherited

Removes the DSFieldMapping from the DataSource.

Parameters

fieldMapping The DSFieldMapping

◆ RemoveFieldMapping() [2/2]

void RemoveFieldMapping ( string name )

inherited

Removes the DSFieldMapping from the DataSource.

Parameters

name	The name of the DataField for which the mapping should be deleted

◆ RemoveParameter() [1/2]

void RemoveParameter ( DataSourceParameter datasourceParameter )

inherited

Removes the DataSourceParameter from the DataSource.

Parameters

datasourceParameter The DataSourceParameter

See also: DataSourceParameter

◆ RemoveParameter() [2/2]

void RemoveParameter ( string name )

inherited

Removes the DataSourceParameter from the DataSource.

Parameters

name	The name of the DataSourceParameter

See also: DataSourceParameter

◆ ToString()

override string ToString ( )

Returns a string representation of the instance.

Returns: A string representation of the instance

Property Documentation

◆ Comment

string Comment

getsetinherited

Gets/Sets the comment for the DataSource.

Returns: The comment for the DataSource

◆ CopyColumnName

string CopyColumnName

getsetinherited

Gets/Sets the CopyColumnName of the DataSource.

Returns: The CopyColumnName of the DataSource

See also: DataSource

◆ Description

string Description

getsetinherited

Gets/Sets the description of the DataSource.

Returns: The description of the DataSource

◆ Filename

string Filename

getset

Gets/Sets the filename of the CSV file.

Returns: The filename of the CSV file.

◆ FirstComputedField

ComputedField FirstComputedField

getinherited

Gets the first ComputedField defined in the DataSource.

Returns: The first ComputedField object in the list or null

See also: ComputedField

◆ FirstFieldMapping

DSFieldMapping FirstFieldMapping

getinherited

Gets the first DSFieldMapping defined in the DataSource.

Returns: The first DSFieldMapping in the list or null

◆ FirstParameter

DataSourceParameter FirstParameter

getinherited

Gets the first DataSourceParameter defined in the DataSource.

Returns: The first DataSourceParameter defined in the DataSource or null

See also: DataSourceParameter

◆ HandleEscapeSequences

bool HandleEscapeSequences

getsetinherited

Gets/Sets if escape sequences should be translated on data retrieval or not.

Returns: true if escape sequences should be translated.

See also: Escape Sequences, DataSource

◆ HasColumnNames

bool HasColumnNames

getset

Gets/Sets if the DataSourceCsv expects column names in the first line of the CSV file.

Returns: true if column-names are provided in the first line of the CSV file.

◆ IsDefault

bool IsDefault

getinherited

Gets a value indicating whether this object stores the default DataSource.

Returns: true if this DataSource is the default DataSource.

See also: DataSource

◆ Name

string Name

getsetinherited

Gets/Sets the name of the DataSource.

Returns: The name of the DataSource

◆ Next

DataSource Next

getinherited

Gets the next DataSource instance defined in the Project.

A Project stores a list of DataSource objects. To retrieve the first DataSource in the Project see Project.FirstDataSource.

Returns: null if there aren't other instances in the Project, otherwise a valid instance of this class (DataSourceCsv, DataSourceOdbc or DataSourceXml)

See also: Project

◆ NumberOfComputedFields

int NumberOfComputedFields

getinherited

Gets the number of ComputedFields defined in the DataSource.

Returns: The number of ComputedFields defined in the DataSource

See also: ComputedField

◆ NumberOfFieldMappings

int NumberOfFieldMappings

getinherited

Gets the number of DSFieldMappings defined in the DataSource.

Returns: The number of DSFieldMappings defined in the DataSource

◆ NumberOfParameters

int NumberOfParameters

getinherited

Gets the number of DataSourceParameters defined in the DataSource.

Returns: The number of DataSourceParameters defined in the DataSource

See also: DataSourceParameter

◆ Qualifier

string Qualifier

getset

Gets/Sets the qualifier character that encloses DataField values.

A common qualifier is the double quote ("). To disable the use of a qualifier set this property to '\0'.

Returns: The qualifier character that encloses DataField values

◆ Separator

string Separator

getset

Gets/Sets the separator character that separates DataField-names or DataField-values.

Common values for separators are , or ;.

Returns: The separator character that separates DataField-names or DataField-values

◆ Type

DataSourceType Type

getinherited

Gets the type of the DataSource.

The DataSourceType is read-only, and is set on creation. It specifies the type of a DataSource (e.g. DataSourceOdbc, DataSourceCsv, DataSourceXml).

Returns: The DataSourceType of the DataSource

© 2006-2023 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Thu Dec 28 2023 18:45:19 for TFORMer SDK - NET with doxygen 1.9.4

Public Member Functions

Properties

Detailed Description

Overview

Modifying an Existing CSV-DataSource

Member Function Documentation

◆ AddComputedField()

◆ AddFieldMapping()

◆ AddParameter()

◆ Dispose()

◆ GetComputedField()

◆ GetFieldMapping()

◆ GetParameter()

◆ RemoveComputedField() [1/2]

◆ RemoveComputedField() [2/2]

◆ RemoveFieldMapping() [1/2]

◆ RemoveFieldMapping() [2/2]

◆ RemoveParameter() [1/2]

◆ RemoveParameter() [2/2]

◆ ToString()

Property Documentation

◆ Comment

◆ CopyColumnName

◆ Description

◆ Filename

◆ FirstComputedField

◆ FirstFieldMapping

◆ FirstParameter

◆ HandleEscapeSequences

◆ HasColumnNames

◆ IsDefault

◆ Name

◆ Next

◆ NumberOfComputedFields

◆ NumberOfFieldMappings

◆ NumberOfParameters

◆ Qualifier

◆ Separator

◆ Type