Data Dictionary Overview
The next few screens describe the funtions of the Data Dictionary Program. They are also part of the DataDictionary Help file.
Overview -
In order to document a SQL database you need to store information about the various tables and the columns in each table. Usually the column names, data types, and default values are not enough to really describe how a column is used. Over time columns are added and other columns are no longer used. Creating a paper document that contains this information is often a "paper tiger." It sits on a shelf and is out-of-date the minute it is finished. JGuiGen uses a SQL table to doucment databases. The table is called data_dict and it is called the "Data Dictionary." This table is automatically filled with information useing calls tothe SQL database's metatdata system. This automatically records added columns, deleted columns and columns that have changes size, shape or data date. You then use JGuiGen to add information to the data dictionary. This additional information describes the columns, how they get they data and any notes you think would be helpful in the future. In addition the data dictionary description is used to supply tooltips of the generated applications and drives the application generatation when it comes to deciding how to edit the various columns.
In order to run the data dictionary program you must have a SQL database and an account that has access to that database. You will need to add a table called data_dict to your database. There is an XML file that contains information that the Data Dictionary program needs to open the SQL database. You will edit the XML file to make it match your database. You will also edit the list of tables in the file to match the tables you wish to document and work with. Once this is correct the Data Dictionary system has the five basic steps described in Trying JGuiGen section above
Briefly the steps are as follows:
1. Modify your data base as described in the readme.html file.
2. Edit the JGuiGenINI.xml file to tell the system what kind of data base you using, what tables you are interested in, and the user name and password needed to access the database.
3. Run JGuiGen and Create Data Dict - this option fills the data dictionary table that you just inserted into your data base with meta data about the tables you are interested in.
4. Edit the Data Dict table. You can tell the system to ignore selected columns, what kind of visual control to use when editing a column, what to use for tooltips in your application, what are required columns, etc.
5. Add any information to the Codes Bank that JGuiGen will need for creating visual components such a comboboxes and radio buttons.
6. Generate the Abstract Table Model class
6. In the Generate menu option click the Order button and sort the columns into an order that makes sense for and edit screen.
7. Generate the Application.
8. Use the Internationalization (I18N) menu option to write out the property bundles needed for the application to run.
9. Modify the rowlayout manager in the ???BuildLayout.java file to give your application a better look and feel
10. Modify the prompts as needed and regenerate the properties bundles.