Previous Page Next Page

Adding Hierarchical Data Sources to a Catalog

Adding a general HDS to a catalog

Example of adding a general HDS

Importing an HDS from an XML file to a catalog

The XSD file used for HDS

You have two ways to add an HDS to a JReport catalog: adding a general HDS or importing from an XML file.

Adding a general HDS to a catalog

1. Create a catalog or open a catalog.
2. In the Catalog Manager, right-click the node of a data source and choose New General Hierarchical Data Source from the shortcut menu.

   If you want to add the HDS to a new data source in the catalog, select any of the existing catalog data source, click New Data Source on the Catalog Manager toolbar, then in the New Data source dialog, specify the name of the data source, select the Hierarchical connection type and click OK.

3. In the New General Hierarchical Data Source dialog, click the Browse button to specify the HDS class name.

   

4. Type a number or parameter string in the Parameter box. The parameter string must match the format defined in the HDS class.

   You can reference parameters and constant level formulas predefined in the current catalog data source in the format @FieldName and the special field User Name as @username in the PARAMETER string.

5. Click Load Tree. The data source tree will then be parsed. Modify the column properties in the Columns box as required.
6. Click OK to add the HDS.

Example of adding a general HDS

There are three classes used in this example. Their source code files are HierarchicalDataSource.java, HierarchicalDatasetMetaData.java, and HierarchicalDataset.java, which are available in <install_root>\help\samples\APIUDS\hierarchicalUDS. In this example, the HierarchicalDataSource.java will return the result set from the demo HSQL DB.

1. Copy the above three files to <install_root>\help. Modify the demo HSQL DB path in both HierarchicalDatasetMetaData.java and HierarchicalDataset.java.
2. Compile the Java files to generate HierarchicalDataSource.class, HierarchicalDatasetMetaData.class, and HierarchicalDataset.class.
3. Append the path <install_root>\help into the ADDCLASSPATH variable of the batch file setenv.bat in <install_root>\bin, so that at runtime HierarchicalDataSource can be found.
4. Start JReport Designer with the batch file you just modified and open an existing catalog.
5. In the Catalog Manager, right-click the data source to which to add the HDS, then select New General Hierarchical Data Source from the shortcut menu. The appears.
6. In the New General Hierarchical Data Source dialog, click the Browse button to find the class HierarchicalDataSource.class.
7. Type a number in the Parameter box. Then, only the records whose employee ID is less than this number will be fetched.
8. Click Load Tree. The data source tree will then be parsed.
9. Modify the column properties in the Columns box as required.
10. Click OK to add the HDS.

Importing an HDS from an XML file to a catalog

1. Create a catalog or open a catalog.
2. In the Catalog Manager, right-click the node of a data source and choose New XML Hierarchical Data Source from the shortcut menu.

   If you want to add the HDS to a new data source in the catalog, select any of the existing catalog data source, click New Data Source on the Catalog Manager toolbar, then in the New Data source dialog, specify the name of the data source, select the XML connection type, check the Hierarchical Data Source radio button and click OK.

3. In the New XML Hierarchical Data Source dialog, click the Browse buttons to specify the XML URI and XSD URI as required. Click the Load Tree button to load the structure of the XML file, the root of the file is then be listed in the Root Name text box.

   

   JReport Designer supports all kinds of URI as the XML data source.

   • If you want to specify a schema file for the XML data source file, you must first make sure that the schema file path specified in the XML data source file is consistent with the path you specified in the XSD URI field, and that this file actually exists. Click the Load Tree button to load the structure of the XML file. The root of the file will then be listed in the Root Name field. Modify the column properties in the Columns box as required.
   • JReport Designer supports static string inline with multiple parameters, for example:

     http://localhost:8888/jrserver%2fSampleReports%2fSampleReports.cat/Key Performance Indicators Report.cls?jrs.cmd=jrs.try_vw&jrs.result_type=7&jrs.param$p_Year=2016&jrs.param$p_Month=2&jrs.param$p_Region=APAC

     It is the URL used to run the sample report Key Performance Indicators Report.cls to the XML format in JReport Server. Type the URL into the XML URI text box, and click the Load Tree button, the structure of the returned XML stream will be loaded in the Structure box (before doing so, make sure that JReport Server is started). Modify the column properties in the Columns box as required.

     The colon ':' and '@' symbols are used to identify JReport parameter names. If these symbols are used in your XML URI and you do not want JReport to parse them as parameters, you must add quotation marks to them. For example, when you browse to d:\test\employee.xml, you can quote it either as "d:\test\employee.xml" or d":"\test\employee.xml.

     Note that you should check the No Security Checking option on the JReport Server console > Administration > Configuration > Advanced page before parsing this URL. In addition, JReport parameters can be dynamically referenced in the URL for setting different values at runtime.

4. Modify the column properties in the Columns box.

   When importing the XML file, you have to define the types of some data in the Format column. For example, if it is Date type, such as 1978-03-12, in the corresponding Format column, type in yyyy-MM-dd. If the data is $12,345.32, in the corresponding Format column, type in $##,###.##. By default, the value of the Scale column is 0, therefore, for decimal type data, you will have to specify the scale value in its corresponding Scale column, that is, modify this value to the number of digits that you want to appear to the right of the decimal point, for example, if the data is 123.23, then in the Scale column, modify this value to 2. For the Currency and Array columns, check them if required.

5. Click OK to import the HDS into the catalog.

The XSD file used for HDS

When you import an XML format HDS with an XSD file, the XML file only provides the data to the JReport Designer reports, while the structure, data type, and so on of the data from the XML file is defined in the XSD file. That is, the structure of the HDS is determined by the XSD file. You should be aware of the following points about the XSD file in order to generate a correct report based on an XML format HDS with an XSD file.

Data type conversion

Before the data type defined in the XSD file can function with JReport Designer, it should first be converted into a corresponding data type when the XML format hierarchical data source is imported, following the rules in the conversion table below.

XSD structure supported by JReport

In JReport Designer, not all XSD structures can be supported in HDS. The following diagrams show the supported structures.

• The ComplexType

  

  The Element type in the diagram can be of simpleType, ref, or complexType (it is different from the ComplexType in the root of this diagram. It can be global complexType but cannot be the anonymous one. If you have defined a complexType named A, and in this complexType A redefined an element as complexType named B, then the elements belong to complexType B must be of the simpleType).

  The Attribute type in the diagram should be of the anonymous type or of the schema built-in type, such as xs:string.

• The SimpleType

  

  SimpleType here should be of the schema built-in type, such as xs:string. List type here cannot support some functions, such as minLength, and maxLength.

• The Element

  

  ComplexType here can include both global and anonymous complexType. The anonymous type means you do not give a name to the type, for example:

  <xs:element name="aa"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="Julie P. Adams"/> </xs:restriction> </xs:simpleType> </xs:element>

  From the code above, you can see that the simpleType in the element aa has no name specified.

Previous Page Next Page