Using the Exit functions
This section provides you with two examples to further understand the Exit functions.
Example 1: Using parameters in the Exit functions
In this example, we provide a simple application which will run at all the three times, Before Run, After Init Parameter, and After Run.
- Develop your Java files to implement the methods. In the example, copy the following code and save it as testa.java to
C:\JReport\Designer\help
(here it is assumed that you have installed your JReport Designer to the default directory).
import java.io.*;
import java.awt.*;
import java.net.*;
import jet.util.*;
public class testa implements JURLExecuter
{
public boolean exec(String[] params)
{
System.out.println("testa : ");
for (int i = 0; i < params.length; i++)
{
System.out.print("\"" + params[i] + "\",");
}
System.out.println();
return true;
}
}
|
- Compile testa.java to generate the class file testa.class in
C:\JReport\Designer\help
.
- Modify the batch file setenv.bat in
C:\JReport\Designer\bin
by appending the path C:\JReport\Designer\help
into the batch file's ADDCLASSPATH variable:
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\JReport\Designer\help;
- Start JReport Designer, then open a report with parameter.
- In the Report Inspector, select the node that represents the report tab and specify the class and give parameters for the three functions, for example:
JURL:/ - The standard format, and followed by the class name.
testa - The class name in this example.
aa;bb;cc and 123;234;345 - The string type parameters of the class, which are divided by semicolons.
Param - A predefined JReport parameter used in the current report, which is introduced by the symbol @.
As shown above, two types of Exit function parameters are supported, they are:
- String type parameters, such as aa, C:\ and so on. In this case, the string will be passed directly to the Exit function.
- JReport predefined parameters used in the current report, which are introduced by the @ symbol. In this case, the parameter value will be passed to the Exit function.
- Run the report, the report engine will call the class that you specified in the Report Inspector.
Example 2: Using formulas in the Exit functions
JReport allows you to use formulas in the Exit functions. To do this, you can use the Data Container Link function which can return value of any formula to a parameter. And using the parameter in the Exit functions, you will get the value of the formula in the Exit functions.
- Create a formula and insert it into a report. It should be put in the child data container.
- Create a parameter with the same data type of the formula, leaving other options blank, and then insert it into the parent data container.
- Right-click the parent data container and click Data Container Link on the shortcut menu.
- In the Data Container Link dialog, click the Return Value tab, add the formula in the Field in Child Data Container to the Return Value box, then click OK.
Now, you have finished passing value of the formula to a parameter.
- Use this parameter in the Exit functions with the method described in Example 1, and then the final value of formula will be returned in the Exit functions.
Notes:
- When a JReport parameter is used as the parameter of the Before Run function, no JReport parameter value will be returned, and the returned value will be the JReport parameter name with the @ symbol.
- For the JReport parameter that are used as Exit function parameters, they must be used in the report. Otherwise, no value will be returned.
- If you want to publish the report to JReport Server and run it there, you should publish both the report and the catalog file to JReport Server. However, do not forget to add the path to the
-classpath
option in the batch file that starts JReport Server.
- Using formulas in Exit functions can also be realized by using returning values in subreport. Thus, you need to pass value of a formula in the subreport to a parameter in the main report.