JobDataCsv Class Reference

Provides access to JobDataCsv (a CSV-file that serves as JobData for a Job). More...

Public Member Functions
	JobDataCsv ()
	Constructor for JobDataCsv. More...
	JobDataCsv (String sFilename, char cSeparator, char cQualifier)
	Constructor for JobDataCsv. More...
String	getFilename ()
	Gets the filename of the CSV file. More...
char	getQualifier ()
	Gets the qualifier character that encloses DataField values. More...
char	getSeparator ()
	Gets the separator character that separates DataField names or DataField values. More...
boolean	isHandleEscapeSequences ()
	Gets/Sets a flag indicating whether escape sequences in DataField values like \n or \x40 should be translated by TFORMer SDK. More...
boolean	isReuseValues ()
	Gets a flag indicating whether DataField-values should be reused in consecutive records. More...
void	setFilename (String sFilename)
	Sets the filename of the CSV file. More...
void	setHandleEscapeSequences (boolean bHandleEscapeSequences)
	Sets a flag indicating whether escape sequences like \n or \x40 should be translated by TFORMer. More...
void	setQualifier (char cQualifier)
	Sets the qualifier character that encloses DataField values. More...
void	setReuseValues (boolean bReuseValues)
	Sets a flag indicating whether DataField values should be reused in consecutive Records. More...
void	setSeparator (char cSeparator)
	Sets the separator character that separates DataField names or DataField values. More...

Detailed Description

Provides access to JobDataCsv (a CSV-file that serves as JobData for a Job).

Overview

The JobDataCsv enables TFORMer SDK to use CSV-files (or more generic: any text file in a suitable format) as JobData for printing a Job.

The data in such a file provides the values of the DataFields. Each line (except the first one - see below) is treated as a Record. TFORMer SDK matches the column names in the file with the corresponding DataField names if the FormLayout. Therefore the first row of the file must contain the DataField names, separated by a separator character. All other rows contain the DataField values, again separated by a separator character. Each value or name of a DataField may be enclosed in optional qualifier characters. This is useful if the separator character may be part of a DataField value.

The default qualifier character is the double quote ("), the default separator character is the comma (,). If the file uses no qualifiers, set the qualifier to '\0'.

Example

The following example file contains 2 records. The first line lists the DataField-names. The comma (,) is used as separator character and the double quote (") is used as qualifier character:

"Email","JobTitle","Name"
"support@tec-it.com","Support Engineer","Mr. Harald Backoffice"
"sales@tec-it.com","Sales Assistant","Mrs. Susan Frontdesk"


Assume the sample file specified above is stored in C:/temp/Import.txt. The corresponding call to create the JobData and to assign it to a Job is as follows: MISSING tff file that matches the given csv datafields, samples to be adopted too ****

  // Create a new Job instance
  Job printJob = new Job();

  // Select the FormLayout (stand-alone or Repository-based)
  // ... 
  

  // Create a new JobData instance 
  // Here we import a CSV and specify separator and qualifier character
  JobDataCsv jobData = new JobDataCsv("c:/temp/Import.txt", ',', '"');

  // Assign the JobData to the Job
  printJob.setJobData(jobData);

  // Select PDF output to /temp/out.pdf 
  printJob.setOutputName  ("/temp/out.pdf");
  printJob.setPrinterType (EPrinterType.PDFFile);

  // Generate output based on the FormLayout and the JobData
  printJob.print ();

More Information

For a general description see JobData.

See also

JobData

Note

Thread-safety: A single instance of this class must not be used by different threads.

Constructor & Destructor Documentation

JobDataCsv

(

)

Constructor for JobDataCsv.

Initializes a new instance of the JobDataCsv class.

See also

JobDataCsv

JobDataCsv	(	String	sFilename,
		char	cSeparator,
		char	cQualifier
	)

Constructor for JobDataCsv.

Initializes a new instance of the JobDataCsv class.

Parameters

sFilename	The filename.
cSeparator	The separator character.
cQualifier	The qualifier character ('\0' if no qualifier should be used).

See also

JobDataCsv, Passing Files

Member Function Documentation

String getFilename

(

)

Gets the filename of the CSV file.

Returns

The filename of the CSV file

char getQualifier

(

)

Gets the qualifier character that encloses DataField values.

Returns

The qualifier character that encloses DataField values

char getSeparator

(

)

Gets the separator character that separates DataField names or DataField values.

Returns

The separator character that separates DataField names or DataField values

boolean isHandleEscapeSequences ( )

inherited

Gets/Sets a flag indicating whether escape sequences in DataField values like \n or \x40 should be translated by TFORMer SDK.

Returns

true if escape sequences in DataField values are translated

See also

JobData, Escape Sequences

boolean isReuseValues ( )

inherited

Gets a flag indicating whether DataField-values should be reused in consecutive records.

Returns

false if DataField-values are cleared between records

See also

JobData

void setFilename

(

String

sFilename

)

Sets the filename of the CSV file.

Parameters

sFilename

The filename of the CSV file

See also

Passing Files

void setHandleEscapeSequences ( boolean  bHandleEscapeSequences )

inherited

Sets a flag indicating whether escape sequences like \n or \x40 should be translated by TFORMer.

Parameters

bHandleEscapeSequences

true if escape sequences in DataField-values should be translated

See also

JobData, Escape Sequences

void setQualifier

(

char

cQualifier

)

Sets the qualifier character that encloses DataField values.

The default qualifier is the double quote ("). To disable the use of a qualifier set it to '\0'.

Parameters

cQualifier

The qualifier character that encloses DataField values

void setReuseValues ( boolean  bReuseValues )

inherited

Sets a flag indicating whether DataField values should be reused in consecutive Records.

Parameters

bReuseValues

false if DataField-values should be cleared between Records

See also

JobData, DataField

void setSeparator

(

char

cSeparator

)

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

The default separator is the comma (,).

Parameters

cSeparator

The separator character that separates DataField names or DataField values