TFORMer SDK - JAVA  7.0
Classes | Public Member Functions
JobDataRecordSet Class Reference

Provides access to JobDataRecordSet (a set of in-memory Record objects which serves as JobData for a Job). More...

List of all members.

Classes

class  Record
 Provides access to a Record. More...

Public Member Functions

 JobDataRecordSet ()
 Constructor for JobDataRecordSet.
void add (Record record)
 Adds the Record.
Iterator getRecords ()
 Gets an Record iterator.
boolean isHandleEscapeSequences ()
 Gets/Sets a flag indicating whether escape sequences in DataField values like \n or \x40 should be translated by TFORMer SDK.
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

Provides access to JobDataRecordSet (a set of in-memory Record objects which serves as JobData for a Job).

Overview

The JobDataRecordSet is the preferred method to pass data to TFORMer SDK from within program code. Create and fill a JobDataRecordSet and pass it to the Job using JobData.The JobDataRecordSet represents an in-memory list of Records. Each Record holds a collection of pairs of strings. The first member of such a string-pair denotes the name of the DataField, the second member denotes the value of the DataField.Although not required it is good practice to set all DataFields used in the FormLayout for each Record. If a DataField which is used in the FormLayout is not present in the JobData its value depends on JobData.setReuseValues.By default each Record is used for printing exactly once. This behavior can be changed with setNumberOfCopies.

More Information

For a general description see JobData.

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

Constructor & Destructor Documentation

Constructor for JobDataRecordSet.

Initializes a new instance of the JobDataRecordSet class.

See also:
JobDataRecordSet, JobData

Member Function Documentation

void add ( Record  record)

Adds the Record.

Parameters:
recordThe record to be added to the recordset
See also:
JobDataDataSource, JobData
Iterator getRecords ( )

Gets an Record iterator.

Returns:
An iterator for the Records in this recordset
See also:
JobDataDataSource, JobData
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 setHandleEscapeSequences ( boolean  bHandleEscapeSequences) [inherited]

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

Parameters:
bHandleEscapeSequencestrue if escape sequences in DataField-values should be translated
See also:
JobData, Escape Sequences
void setReuseValues ( boolean  bReuseValues) [inherited]

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

Parameters:
bReuseValuesfalse if DataField-values should be cleared between Records
See also:
JobData, DataField

© 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