Built-in functions for NLS

Two built-in functions are added in formulas for applying the NLS feature to the formula result.

Translate(String a)
This function searches for the NLS translation of the current field values in the bound data mapping file.
Translate(String a, String b)
This function accesses the corresponding data mapping file dynamically according to the language selected from the language drop-down list on the NLS language toolbar and searches for the NLS translation of String b in it.

Notes:

When either of the two functions is called in a formula, you are suggested not to use the formula to do further calculation unless you can make sure it is correct.
When a formula references a parameter and the parameter's Allow Multiple Values property is true, the two functions are not available in the Formula Editor for editing the formula. In this case, if you want to apply NLS in the formula result, you can bind the data mapping file to the formula directly.
The two functions can also be called in formulas on JReport Server, but they take effect only when the bound data mapping file exists on JReport Server. Moreover, only when the data mapping file is used in JReport Designer, can it be published to JReport Server together with the object it is bound to.

Example of calling the functions in a formula

The following example is based on the report CustomerContactCard.cls in the SampleReports.cat catalog file.

In JReport Designer, click File > Catalog Management > Open Catalog on the menu bar to bring out the Open Catalog File dialog.
Browse to select the SampleReports.cat catalog file in <install_root>\Demo\Reports\SampleReports, click the Open button, and then click Yes in the Warning dialog.
Click File > Open. In the Open Report dialog, select CustomerContactCard.cls from the Reports tab and click the Open button to open the report.
Preview the report and it displays as follows:
Click the Design tab to return to the design mode.
Click Edit > NLS Editor. The NLS Editor appears.
In the NLS Editor, click above the Language box, then in the Add Language dialog, select Chinese (China) from the Available Languages list and click OK to add it and return to the NLS Editor. Click OK in the NLS Editor.
Click on the Catalog Browser toolbar. The Data Mapping Editor apears.
Click the New button, then in the Create Data Mapping File dialog, input DataMapping in the File Name text field and select Chinese (China) from the Language drop-down list. Click OK to go back to the Data Mapping Editor.
Click the Import Key button, select the fields City and State in the Customers table of the displayed dialog and click OK.
Double-click cells in the Map to Value column to specify the mapping values for the imported resources in Chinese. Click OK.
Expand Data Source 1 > JDBC Connection > Tables > Customers node in the Catalog Browser, select the City column, expand the Properties panel on the left, then select DataMapping from the Data Mapping File property value drop-down list.
Make sure that the option Forbid editing data object properties in the Catalog category of the Options dialog is unchecked so that the object property values in the Catalog Browser can be changed.
Repeat the step above to set the Data Mapping File property of the column State in the same table to DataMapping. Click on the Catalog Browser toolbar to save the changes.
Right-click the formula field CustomerCityStateZip in the report and select Edit Formula from the shortcut menu to bring out the Formula Editor. The formula is written as below:
Edit the formula to Translate(@City) + ", " + Translate(@State) + " " + Translate(@"Postal Code"), then click on the toolbar to save the formula. Click File > Close to close the window.

If you have not set the data mapping file of the table columns, you can also edit the formula as follows to apply the NLS feature: Translate("DataMapping", @City)+ ", " +Translate("DataMapping", @State) + " " + Translate("DataMapping", @"Postal Code").

To make the Chinese characters displayed completely in the report, next we need to edit the font properties for the formula field CustomerCityStateZip.

Select the formula CustomerCityStateZip in the report, then set its Font Face property to SimSun and Font Size property to 12 in the Report Inspector. Click on the JReport Designer toolbar to save the report.
Select Chinese (China) from the language drop-down list on the NLS language toolbar.
Preview the report and you can find the formula result is displayed in Chinese: