TFORMer SDK - JAVA  7.0
Public Member Functions
DataSourceCsv Class Reference

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

List of all members.

Public Member Functions

ComputedField addComputedField (String name) throws TFormerException
 Creates and adds a ComputedField to the DataSource.
DSFieldMapping addFieldMapping (String name) throws TFormerException
 Creates and adds a DSFieldMapping to the DataSource.
DataSourceParameter addParameter (String name) throws TFormerException
 Creates and adds a DataSourceParameter to the DataSource.
void dispose () throws TFormerException
 Releases the resources allocated by the instance.
void dump (PrintStream s) throws IOException, TFormerException
 Dumps the current instance into a text stream.
String getComment () throws TFormerException
 Gets the comment for the DataSource.
ComputedField getComputedField (String name) throws TFormerException
 Gets a ComputedField defined in the DataSource.
String getCopyColumnName () throws TFormerException
 Gets the CopyColumnName of the DataSource.
String getDescription () throws TFormerException
 Gets the description of the DataSource.
DSFieldMapping getFieldMapping (String name) throws TFormerException
 Gets a DSFieldMapping defined in the DataSource.
String getFilename () throws TFormerException
 Gets the filename of the CSV file.
ComputedField getFirstComputedField () throws TFormerException
 Gets the first ComputedField defined in the DataSource.
DSFieldMapping getFirstDSFieldMapping () throws TFormerException
 Gets the first DSFieldMapping defined in the DataSource.
DataSourceParameter getFirstParameter () throws TFormerException
 Gets the first DataSourceParameter defined in the DataSource.
String getName () throws TFormerException
 Gets the name of the DataSource.
DataSource getNext () throws TFormerException
 Gets the next DataSource instance defined in the Project.
int getNumberOfComputedFields () throws TFormerException
 Gets the number of ComputedFields defined in the DataSource.
int getNumberOfFieldMappings () throws TFormerException
 Gets the number of DSFieldMappings defined in the DataSource.
int getNumberOfParameters () throws TFormerException
 Gets the number of DataSourceParameters defined in the DataSource.
DataSourceParameter getParameter (String name) throws TFormerException
 Gets a DataSourceParameter defined in the DataSource.
String getQualifier () throws TFormerException
 Gets the qualifier character that encloses DataField values.
String getSeparator () throws TFormerException
 Gets the separator character that separates DataField-names or DataField-values.
DataSourceType getType () throws TFormerException
 Gets the type of the DataSource.
boolean isDefault () throws TFormerException
 Gets a value indicating whether this object stores the default DataSource.
boolean isHandleEscapeSequences () throws TFormerException
 Gets if escape sequences should be translated on data retrieval or not.
boolean isHasColumnNames () throws TFormerException
 Determines if the DataSourceCsv expects column names in the first line of the CSV file.
void removeComputedField (ComputedField computedField) throws TFormerException
 Removes the ComputedField from the DataSource.
void removeComputedField (String name) throws TFormerException
 Removes the ComputedField from the DataSource.
void removeFieldMapping (DSFieldMapping fieldMapping) throws TFormerException
 Removes the DSFieldMapping from the DataSource.
void removeFieldMapping (String name) throws TFormerException
 Removes the DSFieldMapping from the DataSource.
void removeParameter (DataSourceParameter parameter) throws TFormerException
 Removes the DataSourceParameter from the DataSource.
void removeParameter (String name) throws TFormerException
 Removes the DataSourceParameter from the DataSource.
void setComment (String sComment) throws TFormerException
 Sets the comment for the DataSource.
void setCopyColumnName (String sCopyColumnName) throws TFormerException
 Sets the CopyColumnName of the DataSource.
void setDescription (String sDescription) throws TFormerException
 Sets the description of the DataSource.
void setFilename (String sFile) throws TFormerException
 Sets the filename of the CSV file.
void setHandleEscapeSequences (boolean bEscapeSequences) throws TFormerException
 Sets if escape sequences should be translated on data retrieval or not.
void setHasColumnNames (boolean bHasColumnNames) throws TFormerException
 Sets the HasColumnNames of the DataSourceCsv.
void setName (String sName) throws TFormerException
 Sets the name of the DataSource.
void setQualifier (String sTextQualifier) throws TFormerException
 Sets the qualifier character that encloses DataField values.
void setSeparator (String sFieldSeparator) throws TFormerException
 Sets the separator character that separates DataField-names or DataField-values.
String toString ()
 Returns a string representation of the instance.

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:

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:
nameThe 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:
nameThe 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:
nameThe 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:
sInstance of the stream

Reimplemented from DataSource.

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:
nameThe 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:
nameThe 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

Gets the first ComputedField defined in the DataSource.

Returns:
The first ComputedField object in the list or null
See also:
ComputedField

Gets the first DSFieldMapping defined in the DataSource.

Returns:
The first DSFieldMapping in the list or null

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:
nameThe 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:
computedFieldThe ComputedField
See also:
ComputedField
void removeComputedField ( String  name) throws TFormerException [inherited]

Removes the ComputedField from the DataSource.

Parameters:
nameThe name of the ComputedField
See also:
ComputedField
void removeFieldMapping ( DSFieldMapping  fieldMapping) throws TFormerException [inherited]

Removes the DSFieldMapping from the DataSource.

Parameters:
fieldMappingThe DSFieldMapping
void removeFieldMapping ( String  name) throws TFormerException [inherited]

Removes the DSFieldMapping from the DataSource.

Parameters:
nameThe 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:
parameterThe DataSourceParameter
See also:
DataSourceParameter
void removeParameter ( String  name) throws TFormerException [inherited]

Removes the DataSourceParameter from the DataSource.

Parameters:
nameThe name of the DataSourceParameter
See also:
DataSourceParameter
void setComment ( String  sComment) throws TFormerException [inherited]

Sets the comment for the DataSource.

Parameters:
sCommentThe comment for the DataSource
void setCopyColumnName ( String  sCopyColumnName) throws TFormerException [inherited]

Sets the CopyColumnName of the DataSource.

Parameters:
sCopyColumnNameThe CopyColumnName of the DataSource
See also:
DataSource
void setDescription ( String  sDescription) throws TFormerException [inherited]

Sets the description of the DataSource.

Parameters:
sDescriptionThe description of the DataSource
void setFilename ( String  sFile) throws TFormerException

Sets the filename of the CSV file.

Parameters:
sFileThe 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:
bEscapeSequencestrue if escape sequences should be translated.
See also:
Escape Sequences, DataSource
void setHasColumnNames ( boolean  bHasColumnNames) throws TFormerException

Sets the HasColumnNames of the DataSourceCsv.

Parameters:
bHasColumnNamestrue 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:
sNameThe 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:
sTextQualifierThe 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:
sFieldSeparatorThe 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-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Tue Oct 23 2012 16:33:20 for TFORMer SDK - JAVA with doxygen 1.8.0