The schema configuration wizard.

In order to generate reports form your Java classes, ReportWeaver needs to know a little bit about these classes. The classes and their configuration, that is prseented for reprting is called the schema. The schema configuration wizard analzes your application classes and allows you to configure how they are presented to the user.

When you want to create a new template set, you need to specify the reporting schema. Therefore you first need the schema wizard.

The results of the wizard are stored in an XML file, which is called the schema file. Usually it describes the schema for many reports, not just one.

The schema wizard is started from the startup panel, by selecting Create a new Database Connection and Schema or by selecting Modify an existing Database Connection and Schema.

The wizard takes you through a number of panels which are:

  1. The schema file chooser. Here you specify where the schema shall be stored, or which schema file you want to edit.
  2. The connection page. Here you specify how ReportWeaver is connected to your application during development.
  3. The classpath page. Here you specify which jars or directories contain your application classes.
  4. The class configuration page. Here you specify which classes and which members shall be visible to the report designer.
  5. The root page. Here you specify the entry points into your data.
schemawizopen

The schema file selection page

  1. Select an existing schema file, or type in a new name.
  2. Press continue to get to the next panel.
  3. Once the schema file is open and parsed, you can save your modifications at any time.
  4. You can also save the modified schema in a different file.
connection

During development ReportWeaver needs to access the data in your application, so that you can test your reports. This achieved by implementing a call back class that provides the data to ReportWeaver when a report is run. The interface is quite simple and only requires 6 methods.This class implements the triggers, that supply reporting data to ReportWeaver. It must implement the interface com.qintsoft.joria.runtimeapi.DataAccessTrigger. The named class is instantiated when ReportWeaver is started. See the javadoc for details.

classpath
  1. The list of classpath entries, where the classes of your application come from, which shall be used for reporting. This classpath is added to the classpath that you specified in the installer or in the file classpath.cfg .
  2. Select add to pop a file chooser where you can select a jar file or a directory.
  3. Use the up button if you want to change the search order in the class path.
  4. Use the remove button to remove an entry from the list.
{short description of image}

Here you select which classes shall be available for report design. You can configure class views and collection views.

  1. The source pane shows the classes in your report class path. Please navigate through the package structure to the classes that you want to include.
  2. This table shows the list of classes that are included for reporting. A greyish class icon indictes, that this class has either no member, or member for which no type has been specified. The schema file must have an entry for every class that is referenced through a member.

    E.g. If a class Company references another class Address then there must be a class view for address.

    As an alternative you can also include all relevant members from the address class in the the Company class. How this is done is shown below in the section about member configuration.

  3. The bottom table shows the collections that you have configured. Since Java-collections are untyped, ReportWeaver requires you to specify the element type of the collections that you use.
    You can either create a view for a collection, or you can specify the element type in the member configuration.

    Note: Any multi-valued class is called a collection. ReportWeaver treats the following classes as collections:

  4. Press Add Class to add the selcted class to the class view table.

    Note: A class is added without any members. You need to configure it to add members to it.

  5. Adds a class and pops up the class configuration wizard which allow you to specify your members.
  6. Pops up the class configuration wizard to configure the selected class view.
  7. Removes the class view from the table.

    Note: Only remove the class view if it is not referenced by any member or collection.

  8. Adds a collection view. You can modify the collecion settings directly in the table.
  9. Removes the collection view from the table and schema.
  10. This column shows the name of the class view that will be shown in the report designer.
  11. This colums shows the java class name that the view is for.
  12. This shows the package name of the class.
  13. The default flag indicates whether this view shall be the defualt view for a Java class. The default view will be used if a member of that class is used.

    Note: You can specify several views for a class. This can be used to control how a class is accessible in different contexts.

  14. This colums shows the name of the collection view as it will appear in the report designer. Double click on a cell to change the name.
  15. This colums specifies which class view is the element type. Double click to get a drop down box, where you can select the class view.
  16. Indicaes that this is a particularly large collection. In this case ReportWeaver reduces the memory consumption used to process the collection. (At the cost of speed). Consider specifying collection as large if it has more that 10 000 elements.
roots

In this page you specify the roots of your application. A root is the first distinguished object