User Interface

Introduction

The user interface of the wizard is divided into two parts. The tree view on the left hand side, and the "tab" on the right.

The tab on the right contains information regarding the currently selected node in the tree on the left.

As you "drill down" the tree, the wizard automatically introspects the relevant parts of the database. In this way the information is displayed quickly, and is always up to date. Should you have changed part of the database, you can drill down to it and update the wizard's project file accordingly. This is now described in more detail.


Save, Reset, Synchronize, Delete Buttons

Most tabs have a set of buttons at the bottom. There now follows a description of these.

SAVE If any field values have been changed on the tab, the save button should be pressed to save these changes to the project file.
RESET Pressing the reset button causes the wizard to reload the project file values, so undoing any changes that might have been done.
SYNCHRONIZE The synchronize button is only enabled when the wizard is connected to the database, and the object exists in the database.

Pressing this button forces the project file to update itself to the latest information gathered from the database. See the "Updated Objects" section on this page, for a description of this.

DELETE The delete button is only enabled if there is no connection to the database, or if the object has been dropped from the database. Pressing this button removes the object from the project file.

Deleted Objects

When database objects are dropped or changed, the wizard does not automatically delete objects in the project file. This is to prevent any corresponding java class descriptions from being deleted. 

When the wizard detects that an object has been deleted, the tree displays the icon with a small red marker. The screenshot above shows just such an object. Note that the delete button is enabled, this allows you to delete the object from the project file.

Some deleted objects, such as table columns or stored procedure parameters may affect the classes associated with the table or stored procedure. In the example in the previous screenshot, a columns is about to be deleted. Once deleted, all classes associated with the table should be reviewed.


Updated Objects

Should some database object have been updated, this is not changed in the project file automatically. This allows the user to review the changes which have been made, and so be aware of any repercussions this could have on the application being developed. Changed objects have a little blue marker in the database treeview.

The attributes which have changed can be viewed on the object's tab view. Below is a screenshot of an example where the Scale is no longer the same as the database's value.

 

In order to make the project file reflect the new scale value, the Synchronize button should be pressed. This action updates the wizard's data to reflect the current database values.

In the example in the previous screenshot, a columns is about to be synchronized. Once synchronized, all classes associated with the table should be reviewed.


Code Generation Considerations

Whenever a database object is deleted, added or changed. The each one of classes associated with the object should be reviewed to ensure that the data types are correct, and also to review which columns are involved in the generated classes.

The wizard provides the ability to detect and report changes which could affect the classes. The following link explains the code verification option of the wizard.


Icons Used In The Wizard

The table below shows each icon used in the database tree of the wizard.

Represents the database
A Schema, some databases do not support schemas
A Catalog, some databases do not support catalogs.
Tables
Views
Stored procedures
System tables
A table
A view
A stored procedure
A system table
A set of columns, this may be present in tables, views, stored procedures and system tables.
A column, this may be present in tables, views, stored procedures and system tables.
A primary key column
A primary and foreign key column
A foreign key column
Stored procedure parameters
An output stored procedure parameter
An input stored procedure parameter
An input and output stored procedure parameter
A stored procedure return value
A stored procedure parameter flagged to be ignored
Java classes
A java class
Bean Managed Persistence EJB's
Bean Managed Persistence EJB

Copyright © 2002 J3 Limited, all rights reserved.