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

Public Member Functions
ComputedField	addComputedField (String name) throws TFormerException
	Creates and adds a ComputedField to the DataSource. More...

DSFieldMapping	addFieldMapping (String name) throws TFormerException
	Creates and adds a DSFieldMapping to the DataSource. More...

DataSourceParameter	addParameter (String name) throws TFormerException
	Creates and adds a DataSourceParameter to the DataSource. More...

void	dispose () throws TFormerException
	Releases the resources allocated by the instance. More...

void	dump (PrintStream s) throws IOException, TFormerException
	Dumps the current instance into a text stream. More...

String	getComment () throws TFormerException
	Gets the comment for the DataSource. More...

ComputedField	getComputedField (String name) throws TFormerException
	Gets a ComputedField defined in the DataSource. More...

String	getCopyColumnName () throws TFormerException
	Gets the CopyColumnName of the DataSource. More...

String	getDescription () throws TFormerException
	Gets the description of the DataSource. More...

DSFieldMapping	getFieldMapping (String name) throws TFormerException
	Gets a DSFieldMapping defined in the DataSource. More...

String	getFilename () throws TFormerException
	Gets the filename of the CSV file. More...

ComputedField	getFirstComputedField () throws TFormerException
	Gets the first ComputedField defined in the DataSource. More...

DSFieldMapping	getFirstDSFieldMapping () throws TFormerException
	Gets the first DSFieldMapping defined in the DataSource. More...

DataSourceParameter	getFirstParameter () throws TFormerException
	Gets the first DataSourceParameter defined in the DataSource. More...

String	getName () throws TFormerException
	Gets the name of the DataSource. More...

DataSource	getNext () throws TFormerException
	Gets the next DataSource instance defined in the Project. More...

int	getNumberOfComputedFields () throws TFormerException
	Gets the number of ComputedFields defined in the DataSource. More...

int	getNumberOfFieldMappings () throws TFormerException
	Gets the number of DSFieldMappings defined in the DataSource. More...

int	getNumberOfParameters () throws TFormerException
	Gets the number of DataSourceParameters defined in the DataSource. More...

DataSourceParameter	getParameter (String name) throws TFormerException
	Gets a DataSourceParameter defined in the DataSource. More...

String	getQualifier () throws TFormerException
	Gets the qualifier character that encloses DataField values. More...

String	getSeparator () throws TFormerException
	Gets the separator character that separates DataField-names or DataField-values. More...

DataSourceType	getType () throws TFormerException
	Gets the type of the DataSource. More...

boolean	isDefault () throws TFormerException
	Gets a value indicating whether this object stores the default DataSource. More...

boolean	isHandleEscapeSequences () throws TFormerException
	Gets if escape sequences should be translated on data retrieval or not. More...

boolean	isHasColumnNames () throws TFormerException
	Determines if the DataSourceCsv expects column names in the first line of the CSV file. More...

void	removeComputedField (ComputedField computedField) throws TFormerException
	Removes the ComputedField from the DataSource. More...

void	removeComputedField (String name) throws TFormerException
	Removes the ComputedField from the DataSource. More...

void	removeFieldMapping (DSFieldMapping fieldMapping) throws TFormerException
	Removes the DSFieldMapping from the DataSource. More...

void	removeFieldMapping (String name) throws TFormerException
	Removes the DSFieldMapping from the DataSource. More...

void	removeParameter (DataSourceParameter parameter) throws TFormerException
	Removes the DataSourceParameter from the DataSource. More...

void	removeParameter (String name) throws TFormerException
	Removes the DataSourceParameter from the DataSource. More...

void	setComment (String sComment) throws TFormerException
	Sets the comment for the DataSource. More...

void	setCopyColumnName (String sCopyColumnName) throws TFormerException
	Sets the CopyColumnName of the DataSource. More...

void	setDescription (String sDescription) throws TFormerException
	Sets the description of the DataSource. More...

void	setFilename (String sFile) throws TFormerException
	Sets the filename of the CSV file. More...

void	setHandleEscapeSequences (boolean bEscapeSequences) throws TFormerException
	Sets if escape sequences should be translated on data retrieval or not. More...

void	setHasColumnNames (boolean bHasColumnNames) throws TFormerException
	Sets the HasColumnNames of the DataSourceCsv. More...

void	setName (String sName) throws TFormerException
	Sets the name of the DataSource. More...

void	setQualifier (String sTextQualifier) throws TFormerException
	Sets the qualifier character that encloses DataField values. More...

void	setSeparator (String sFieldSeparator) throws TFormerException
	Sets the separator character that separates DataField-names or DataField-values. More...

String	toString ()
	Returns a string representation of the instance. 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.getGlobalProject ();
  // 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.setQualifier("'");
  dataSource.setSeparator(",");

Member Function Documentation

ComputedField addComputedField ( String name ) throws TFormerException

inherited

Creates and adds a ComputedField to the DataSource.

Parameters

name	The name of the ComputedField

Returns: A new ComputedField

See also: ComputedField

DSFieldMapping addFieldMapping ( String name ) throws TFormerException

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

DataSourceParameter addParameter ( String name ) throws TFormerException

inherited

Creates and adds a DataSourceParameter to the DataSource.

Parameters

name	The name of the DataSourceParameter

Returns: A new DataSourceParameter

See also: DataSourceParameter

void dispose ( ) throws TFormerException

inherited

Releases the resources allocated by the instance.

Call this method in every case (even in case of exceptions) is this instance is not required anymore.

void dump ( PrintStream s ) throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters

s	Instance of the stream

String getComment ( ) throws TFormerException

inherited

Gets the comment for the DataSource.

Returns: The comment for the DataSource

ComputedField getComputedField ( String name ) throws TFormerException

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

String getCopyColumnName ( ) throws TFormerException

inherited

Gets the CopyColumnName of the DataSource.

Returns: The CopyColumnName of the DataSource

See also: DataSource

String getDescription ( ) throws TFormerException

inherited

Gets the description of the DataSource.

Returns: The description of the DataSource

DSFieldMapping getFieldMapping ( String name ) throws TFormerException

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

String getFilename ( ) throws TFormerException

Gets the filename of the CSV file.

Returns: The filename of the CSV file

ComputedField getFirstComputedField ( ) throws TFormerException

inherited

Gets the first ComputedField defined in the DataSource.

Returns: The first ComputedField object in the list or null

See also: ComputedField

DSFieldMapping getFirstDSFieldMapping ( ) throws TFormerException

inherited

Gets the first DSFieldMapping defined in the DataSource.

Returns: The first DSFieldMapping in the list or null

DataSourceParameter getFirstParameter ( ) throws TFormerException

inherited

Gets the first DataSourceParameter defined in the DataSource.

Returns: The first DataSourceParameter defined in the DataSource or null

See also: DataSourceParameter

String getName ( ) throws TFormerException

inherited

Gets the name of the DataSource.

Returns: The name of the DataSource

DataSource getNext ( ) throws TFormerException

inherited

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.getFirstDataSource.

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

int getNumberOfComputedFields ( ) throws TFormerException

inherited

Gets the number of ComputedFields defined in the DataSource.

Returns: The number of ComputedFields defined in the DataSource

See also: ComputedField

int getNumberOfFieldMappings ( ) throws TFormerException

inherited

Gets the number of DSFieldMappings defined in the DataSource.

Returns: The number of DSFieldMappings defined in the DataSource

int getNumberOfParameters ( ) throws TFormerException

inherited

Gets the number of DataSourceParameters defined in the DataSource.

Returns: The number of DataSourceParameters defined in the DataSource

See also: DataSourceParameter

DataSourceParameter getParameter ( String name ) throws TFormerException

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

String getQualifier ( ) throws TFormerException

Gets 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

String getSeparator ( ) throws TFormerException

Gets 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

DataSourceType getType ( ) throws TFormerException

inherited

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

boolean isDefault ( ) throws TFormerException

inherited

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

Returns: true if this DataSource is the default DataSource.

See also: DataSource

boolean isHandleEscapeSequences ( ) throws TFormerException

inherited

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

Returns: true if escape sequences should be translated.

See also: Escape Sequences, DataSource

boolean isHasColumnNames ( ) throws TFormerException

Determines 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.

void removeComputedField ( ComputedField computedField ) throws TFormerException

inherited

Removes the ComputedField from the DataSource.

Parameters

computedField The ComputedField

See also: ComputedField

void removeComputedField ( String name ) throws TFormerException

inherited

Removes the ComputedField from the DataSource.

Parameters

name	The name of the ComputedField

See also: ComputedField

void removeFieldMapping ( DSFieldMapping fieldMapping ) throws TFormerException

inherited

Removes the DSFieldMapping from the DataSource.

Parameters

fieldMapping The DSFieldMapping

void removeFieldMapping ( String name ) throws TFormerException

inherited

Removes the DSFieldMapping from the DataSource.

Parameters

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

void removeParameter ( DataSourceParameter parameter ) throws TFormerException

inherited

Removes the DataSourceParameter from the DataSource.

Parameters

parameter The DataSourceParameter

See also: DataSourceParameter

void removeParameter ( String name ) throws TFormerException

inherited

Removes the DataSourceParameter from the DataSource.

Parameters

name	The name of the DataSourceParameter

See also: DataSourceParameter

void setComment ( String sComment ) throws TFormerException

inherited

Sets the comment for the DataSource.

Parameters

sComment The comment for the DataSource

void setCopyColumnName ( String sCopyColumnName ) throws TFormerException

inherited

Sets the CopyColumnName of the DataSource.

Parameters

sCopyColumnName The CopyColumnName of the DataSource

See also: DataSource

void setDescription ( String sDescription ) throws TFormerException

inherited

Sets the description of the DataSource.

Parameters

sDescription The description of the DataSource

void setFilename ( String sFile ) throws TFormerException

Sets the filename of the CSV file.

Parameters

sFile The filename of the CSV file.

See also: Passing Files

void setHandleEscapeSequences ( boolean bEscapeSequences ) throws TFormerException

inherited

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

Parameters

bEscapeSequences true if escape sequences should be translated.

See also: Escape Sequences, DataSource

void setHasColumnNames ( boolean bHasColumnNames ) throws TFormerException

Sets the HasColumnNames of the DataSourceCsv.

Parameters

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

void setName ( String sName ) throws TFormerException

inherited

Sets the name of the DataSource.

Parameters

sName The name of the DataSource

void setQualifier ( String sTextQualifier ) throws TFormerException

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' (dataSource.setQualifier('\0');).

Parameters

sTextQualifier The qualifier character that encloses DataField-values.

void setSeparator ( String sFieldSeparator ) throws TFormerException

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

Common values for separators are , or ;.

Parameters

sFieldSeparator The separator character that separates DataField-names or DataField-values

String toString ( )

inherited

Returns a string representation of the instance.

Returns: A string representation of the instance

© 2006-2017 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Fri Nov 3 2017 07:59:14 for TFORMer SDK - JAVA with doxygen 1.8.9.1

Public Member Functions

Detailed Description

Overview

Modifying an Existing CSV-DataSource

Member Function Documentation