JobData Class Reference

Abstract base class for JobData. More...

List of all members.

Public Member Functions
boolean	isHandleEscapeSequences ()
	Gets a flag indicating whether escape sequences like \n or \x40 should be translated by TFORMer.
boolean	isReuseValues ()
	Gets a flag indicating whether DataField-values should be reused in consecutive records.
void	setHandleEscapeSequences (boolean bHandleEscapeSequences)
	Sets a flag indicating whether escape sequences like \n or \x40 should be translated by TFORMer.
void	setReuseValues (boolean bReuseValues)
	Sets a flag indicating whether DataField-values should be reused in consecutive records.

---

Detailed Description

Abstract base class for JobData.

TFORMer Runtime retrieves data used for printing a Job by using JobData.

A JobData is always iterated Record by Record, the order of the records is not changed.

• Usually each Record triggers the printing of the detail-band(s) in the FormLayout.

• Report headers are printed at the top of the first page (above the first page header) after the first Record was read.

• Report footers are printed at the bottom of the last page after the last Record was read.
• Page headers and page footers are printed when required, no Record is needed to trigger them.

TFORMer requires at least one Record to produce output.

All data-fields available in a Record are processed. It depends on HandleEscapeSequences whether possible escape sequences in the values are translated into their corresponding binary representation.

If a DataField, which is used in the FormLayout, is not present in the JobData its value depends on ReuseValues.

If no or an empty JobData was specified with JobData then TFORMer Runtime uses default DataSource for printing the Job. The default data is stored in an extra file (filename-extension .xml) and contains the DataField-values used during the last TFORMer Designer session. If no file with default data exists TFORMer Runtime produces no output.

If the JobData provides more DataFields than defined (either in the stand-alone Formlayout or in the Project of the Repository), these additional DataFields will be ignored.

See also:

com.tecit.TFORMer.Printing.JobDataCsv
com.tecit.TFORMer.Printing.JobDataOdbc
com.tecit.TFORMer.Printing.JobDataRecordSet
com.tecit.TFORMer.Printing.JobDataXml

---

Member Function Documentation

boolean isHandleEscapeSequences

(

)

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

Returns:

true if escape sequences in DataField-values get translated, otherwise, false.

boolean isReuseValues

(

)

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

Returns:

true if DataField-values are cleared between records; otherwise, false.

void setHandleEscapeSequences

(

boolean

bHandleEscapeSequences

)

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, otherwise, false.

void setReuseValues

(

boolean

bReuseValues

)

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

Parameters:

bReuseValues

true if DataField-values should be cleared between records; otherwise, false.