Public Member Functions |
| JobDataOdbc () |
| Constructor for JobDataOdbc.
|
| JobDataOdbc (String sDsn, String sUser, String sPassword, String sSqlSelect) |
| Constructor for JobDataOdbc.
|
String | getDsn () |
| Gets the DSN (ODBC data-source-name).
|
String | getPassword () |
| Gets the password for the database connection.
|
String | getSqlSelect () |
| Gets the SQL select statement for fetching the records from the database.
|
String | getUser () |
| Get the user-name for the database connection.
|
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 | setDsn (String sDsn) |
| Sets the DSN (ODBC data-source-name).
|
void | setHandleEscapeSequences (boolean bHandleEscapeSequences) |
| Sets a flag indicating whether escape sequences like \n or \x40 should be translated by TFORMer.
|
void | setPassword (String sPassword) |
| Sets the password for the database connection.
|
void | setReuseValues (boolean bReuseValues) |
| Sets a flag indicating whether DataField values should be reused in consecutive Records.
|
void | setSqlSelect (String sSqlSelect) |
| Sets the SQL select statement for fetching the records from the database.
|
void | setUser (String sUser) |
| Sets the user-name for the database connection.
|
Provides access to JobDataOdbc (an ODBC connection that serves as JobData for a Job).
Overview
The
JobDataOdbc enables
TFORMer SDK to use arbitrary database-tables or queries as
JobData for printing a
Job.The data in such a table provides the values of the DataFields. The table is read Record by Record using the specified SQL SELECT statement.
TFORMer SDK matches the column-names of the table or query with the corresponding
DataField names in the
FormLayout. If required use SQL aliases to provide identical column names.The order of the columns in the table or query does not matter.The DSN represents the name of the database connection as defined in the Microsoft Windows Control Panel. Please keep in mind that the DSN is a part of the connection string and thus a complete specification is required.This may yield the following code:
jobDataOdbc.setDsn("DSN=TFORMer_Sample");
Example
This example demonstrates how to use the pre-installed ODBC data-source (named TFORMer_Sample) for generating a report as PDF. The table tbl_Example looks like follows:
ChapterNumber | Caption | PageNumber |
1 | Content | 2 |
1.1 | Table of Figures | 6 |
1.2 | List of Tables | 6 |
2 | Disclaimer | 7 |
... | ... | ... |
This is the code to use this table as a
JobDataOdbc:
Job printJob = new Job();
printJob.setRepositoryName("C:\\Documents and Settings\\All Users\\Application Data\\TEC-IT\\TFORMer\\7.0\\Examples\\Command Line\\ODBCReportPDF\\ODBCReportPDF.tff");
JobData jobData = new JobDataOdbc("DSN=TFORMer_Sample", "", "", "SELECT FROM tbl_Example");
printJob.setJobData(jobData);
printJob.setOutputName ("/temp/out.pdf");
printJob.setPrinterType (EPrinterType.PDFFile);
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.