- Import
First of all, you should import the classes of Client API by adding the following import statements at the beginning of your program.
import jet.client.api.*;
import jet.client.api.gui.*;
- Set Connection Information
After getting the values of command line arguments such as report URL, user, password etc., set the connection information with the following methods in class jet.client.api.JRClient.
1. Set the proxy infomation for the client
JRClient.setProxy(proxyHost, proxyPort);
The methods setProxy (String proxyHost, String proxyPort) set the proxy for the client.
Parameters:
proxyHost - The proxy host name or IP address. If it is null, no proxy will be used.
proxyPort - The proxy port.
2. Set the user ID
JRClient.setUser(user);
The method setUser(string user) sets the user ID of the report server at the client end.
3. Set the client password
JRClient.setPassword(password);
The method setPassword(string password) sets the user password.
- Login
JRClient.login(null, report);
The method(Frame frame, string jrsvrURL) is used to login to the report server jrsvrURL. A login dialog box will pop up to enter user ID and password.
Parameters:
frame - The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet. For examples: http://jrserver:8888/ or http://server:8888/servlet/jrservlet/ .
- Get Result Versions of the Report
Vector versions = JRClient.getResultVersions(null, report);
The method getResultVersions(Frame frame, String reportURL) returns the result versions of a report in a report server.
Parameters:
frame - The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL -The URL string of the report in a report server. For example: http://server:8888/servlet/jrservlet/hsqlDemo/Tutorial.cat/invoice.cls
- Export the Result to JReport Result, HTML, PDF, TEXT, Excel, Postscript and RTF
boolean[] succInfo = JRClient.exportVersionResult(report,
ver.getResultFilename(), // the result version
localFilename + ".rst", // To report result.
localFilename + ".html", // To HTML.
localFilename + ".pdf", // To PDF.
localFilename + ".txt", // To TEXT.
localFilename + ".xls", // To Excel.
localFilename + ".ps", // To Postscropt.
localFilename + ".rtf", // To RTF(Rich Text Format).
false, // isNormalText
false, // isRepeat
';', // delimiter
true, // isMultiFiles
true, // isChartApplet
true, // hasHyperlink
false, // hasPageNumber
false, // useTable
false, // relFontSize
0, // webBrowser 0 - IE, 1 - Netscape.
false); // drilldown
The method exportVersionResult is used to export a version result to different formats. It returns whether it is successful or not.
boolean[0]: if successfully exported to JReport result
boolean[1]: if successfully exported to HTML
boolean[2]: if successfully exported to PDF
boolean[3]: if successfully exported to TEXT
boolean[4]: if successfully exported to Excel
boolean[5]: if successfully exported to PS
There are a couple of exportVersionResult methods with different parameters. The method being used in the demo has following parameters:
rptURL - The URL string of the report in a report server.
versionResult - The version result filename of the report on the server side.
rstFile - The local filename with the full path, to which tempResult will be exported as a JReport result file.
htmlFile - the local filename with the full path, to which tempResult will be exported as an HTML file.
pdfFile - the local filename with the full path, to which tempResult will be exported as a PDF file.
txtFile - the local filename with the full path, to which tempResult will be exported as a TEXT file.
excelFile - the local filename with the full path, to which tempResult will be exported as an Excel file.
psFile - the local filename with the full path, to which tempResult will be exported as a PS file.
rtfFile - the local filename with the full path, to which tempResult will be exported as an RTF file.
isNormalText - Indicate whether this text file is in normal text format or not (To TEXT).
isRepeat - Indicate whether the same contents are repeated (To TEXT).
delimiter - A character which will be used in SDF (Standard Data Format) format. A delimiter could be a ',' (the CSV format) or any other characters. The default is ' ' (a blank), that is, the SSV format (To TEXT).
isMultiFiles - Indicate whether html is generated to a file or to multiple files (To HTML).
isChartApplet - Indicate whether the chart in html file is an applet (To HTML).
hasHyperlink - Indicate whether the hyperlink is generated (To HTML).
hasPageNumber - Indicate whether to generate page number (To HTML).
useTable - Indicate whether to use an HTML table to generate the HTML page (To HTML).
relFontSize - Indicate whether to generate HTML pages with relative font size (To HTML).
webBrowser - Indicate which Web browser HTML pages are being generated for (To HTML). 0 - IE; 1 - Netscape.
drilldown - Indicate whether to drilldown the HTML result (To HTML).
Note: The method exportVersionResult() is deprecated. Above JREntViewer version 3.0, it is replaced by exportVersionResult(String rptURL, String versionResult, String rstFile, String htmlFile, String pdfFile, String txtFile, String excelFile, String psFile, boolean isNormalText, boolean isRepeat, char delimiter, boolean isMultiFiles, boolean isChartApplet, boolean hasHyperlink, boolean hasPageNumber, boolean useTable, boolean relFontSize, int webBrowser).
- View theVersion in a Thread
ViewerThread vt = JRClientGUI.viewResultVersion(report,ver.getResultFilename(), "Result Version - " + ver.getCreatedTimeDisplayString());
The method viewResultVersion(String rptUrl, String resultVersion, String title) views a report result version and returns a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Parameters:
rptURL - The URL string of the report in a report server. For example: http://jrserver:8888/hsqlDemo/Tutorial.cat/invoice.cls
resultVersion - The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the report viewer that will be brought up.
- Show the Parameters of this Result Version
JRClientGUI.showVersionParamValues(null, report, ver.getVersionID(),"Parameters - " + ver.getCreatedTimeDisplayString());
The method showVersionParamValues(Frame frame, String jrsvrURL, String versionID, String title) brings up a dialog box to show the report parameter values of the result version.
Parameters:
frame - The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet.
versionID - The result version ID can be got from getVersionID() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the dialog box.
- Exit
vt.setSystemExitWhenWindowClosed();
The method setSystemExitWhenWindowClosed() sets the system to exit when the result viewer is closed.
- Compile and Run
Assume that the demo program is under C:\JREntViewer\help\api, and JReport Enterprise Viewer is installed in c:\JREntViewer.
To compile and run the demo program, you should add the some files with their paths into the classpath. For example, use the following command to compile the test program:
C:\JREntViewer\help\api>javac -classpath c:\JREntViewer\lib\JREntViewer.zip;c:\JREntViewer\lib\log4j-1.2.8.jar ResultVersionView.java
When you run the programs, you should provide parameters.
-help: Display the usage of the program (optional).
-report: The report URL to view its result from command line.
-params: Parameters of the report to view its result from command line.
-user: The user ID (optional).
-password: The user password (optional).
-proxyhost: The proxy host (optional).
-proxyport: The proxy port (optional).
An example to run the program:
C:\JREntViewer\help\api>java -classpath c:\JREntViewer\lib\JREntViewer.zip;c:\JREntViewer\lib\log4j-1.2.8.jar;C:\JREntViewer\help\api ResultVersionView -reporthttp://jrserver:8888/hsqlDemo/Tutorial.cat/invoice.cls -paramsPToday5/21/98 -useradmin -passwordadmin
Running the program, you can view the result of report "invoice" and its parameter as shown below.
