Chapter 16 - Using ORM Wizard - Visual Paradigm

16 

Using ORM Wizard

SDE-VS User’s Guide (Part 2, for ORM) Chapter 16 – Using ORM Wizard 

Chapter 16 - Using ORM Wizard 

An ORM Wizard is provided to you to generate persistent code and/or database either from database, class diagram or entity 

relationship diagrams. This chapter shows you how to activate the ORM Wizard and generate code and/or database by one of 

the three options provided by wizard. 

In this chapter: 

16-2 

• Introduction 

• Generating Code from Database 

• Generating Code and Database from ERD 

• Generating Code and Database from Class Diagram 

Introduction 

Mapping objects to relational database is a complicated and error pound task in the development. Acting as a bridge between 

object model, data model and relational database, the mappings between these models are automated. Apart from these 

mappings, the mapping between object models and persistent code is also supported. Hence, the persistent code can thus map 

to the relational database. 

The synchronization between persistent code, object model, data model and relational is supported, which reduces the 

development time for handling these tedious programming jobs between them. Moreover, your document will always keep upto-date. 

To support synchronization in-between persistent code and relational database, you are allowed to generate database 

and persistent code for your development project. 

An ORM Wizard for the generation of persistent code and database. The wizard provides you with three options: 

1. Generate Code from Database. 

2. Generate Code and Database from Entity Relationship Diagram (ERD). 

3. Generate Code and Database from Class Diagram. 

To activate the Wizard: 

1. On the menu, click Modeling > ORM > Wizards.... 

Figure 16.1 - To open the ORM Wizard


2. A Wizard Welcome Page will be shown, select Language of the code to be generated from the drop-down menu, 

either Java or C#. 

Figure 16.2 - Select the programming language 

3. Select one of the wizard options, and then click Next to proceed. 

Figure 16.3 - Select the generation options 

16-3


Generating Code from Database 


Figure 16.4 - The flow of generate code 

Upon selecting the option for Generate Code from Database, the wizard helps you generate persistent code from database 

tables according to the requirements you specified throughout the wizard. 

Follow the steps of the Generate Code From Database wizard: 

1. Database Configuration 

• For Java Language selected 

Figure 16.5 - Database configuration for Java 

You are asked to define the database configuration. Refer to the descriptions in the Getting Started with 

Object-Relational Mapping chapter for information chapter for information on how to configure the database 

Database Configuration for Java Project section.


• For C# Language selected 

2. Selecting Tables 

Figure 16.6 - Database Configuration for C# 


Object-Relational Mapping chapter for information on how to configure the database in the Database 

Configuration for .Net Project section. 

Figure 16.7 - Select the Tables for generate code 




The database is connected based on your options in the previous database configuration option pane and all database 

tables are reversed. You are asked to select the database tables which you want to generate persistent class to 

manipulate those tables. By default, all the database tables are selected for the generation of code shown in the list of 

Selected Tables. You can deselect the table by using the list of buttons between the list of Available Tables and 

Selected Tables. 

• Add Selected 

Add the selected table from Available Tables to Selected Tables. 

• Remove Selected 

Remove the selected table from Selected Tables to Available Tables. 

• Add All 

Add all tables from Available Tables to Selected Tables. 

• Remove All 

Remove all tables from Selected Tables to Available Tables. 

3. Class Details Configuration 

Figure 16.8 - Configure the Class mapping 

After selecting tables, you will be directed to a Class Details Configuration pane. You are asked to define the Class 

Detail for generating code. The persistent classes will be generated based on the information defined here. You can 

edit the class details by double-clicking the field.


• Package 

Enter the package name. A package will be created to store the generated persistent code. If the package 

name was not defined, you will be prompted by a dialog box warning you the classes will be generated in 

default package. 

Figure 16.9 - Confirm generate class in default package message 

• Class 

You can edit the class name which will be used as the name of the generated persistent code for a 

corresponding table. 

• Associations 

Figure 16.10 - Class mapping 

You can edit the role name for a reference in the class. 

Figure 16.11 - Association mapping 

You can deselect navigable for an association such that the reference for the target role will not be created. 

• Attributes 

Figure 16.12 - Set the navigable 

You can edit the attribute name representing the column of the table. 

Figure 16.13 - Attributes mapping 




• Custom Code Style 

Click button, Custom Code Style Setting dialog box will be displayed. You can modify 

the prefix or suffix of the Class, Attribute and Role Name. 

Figure 16.14 – Custom Code Style Setting dialog 

For the Type, select the type of Class detail, either Class, Attribute or Role Name (PK) that you want to 

apply code style. 

For the Prefix/Suffix, select either Prefix or Suffix to be added or removed. 

For the Add/Remove option, select the option for the action of code style to be applied. 

For the Textbox, enter the word for either prefix or suffix. 

For the Scope, select the scope of the code style to be applied to, either All or Selected. 

Table shows the result of applying Code Style. 

Code Style Before Applying After Applying 

Add Prefix (E.g. pre_) Item pre_Item 

Remove Prefix (E.g. pre_) pre_Item Item 

Add Suffix (E.g. _suf) Item Item_suf 

Remove (E.g. _suf) Item_suf Item 

4. Generate Code 


Table 16.1 

Figure 16.15 - Generate code setting for Java 

You are asked to specify the code details. For information, refer to the description of Configuring Code 

Generation Setting for Java section in the Implementation chapter.



Figure 16.16 - Generate code setting for C# 


Generation Setting for C# section in the Implementation chapter. 

5. Click Finish, the Generate ORM Code/Database dialog box appears showing the progress of code generation. Click 

Close when the generation is complete. 

Figure 16.17 - Generate ORM Code/Database dialog 

A class diagram and an entity relationship diagram will be generated automatically and added to your project. The 

generated persistent code and required resources will be generated to the specified output path. 



Generating Code and Database From ERD 

Figure 16.18 - Generating Code and Database From ERD 

Upon selecting the option for Generate Code and Database from ERD, the wizard helps you generate persistent code and 

database from ERD with respect to the requirements you specified throughout the wizard. 

Take the following ERD as an example: 

Figure 16.19 - Entities Relationship Diagram 

Follow the steps of the Generate Code and Database From ERD wizard: 


1. Class Details Configuration 

Figure 16.20 - Class Detail Configuration


You are asked to define the Class Details for generating code. The persistent classes will be generated based on the 

information defined here. You can edit the class details by double-clicking the field. 

• Package 




Figure 16.21 - Confirm generate code in default package message 

• Class 

You can edit the class name which will be used as the name of the generated persistent code for a 

corresponding table. 

• Associations 

Figure 16.22 - Mapping classes 

You can edit the role name for a reference in the class. 

Figure 16.23 - Mapping associations 

You can deselect navigable for an association such that the reference for the target role will not be created. 

• Attributes 

Figure 16.24 - Set the navigable 

You can edit the attribute name representing the column of the table. 

Figure 16.25 - Mapping attributes 






the prefix or suffix of the Class, Attribute and Role Name. 

Figure 16.26 - Custom Code Style Setting dialog 

For the Type, select the type of Class detail, either Class, Attribute or Role Name (PK) that you want to 

apply code style. 














Figure 16.27 - Database Configuration for Java




Configuration for Java Project section 


Figure 16.28 - Database configuration for C# 






Figure 16.29 - Generate Code Configure for Java 


Generation Setting for Java section in the Implementation chapter. 





Figure 16.29 - Generate Code configure for C# 



4. Click Finish, the Generate ORM Code/Database dialog box appears showing the progress of code generation. Click 

Close when the generation is complete. 


A class diagram will be generated automatically and added to your project. The generated persistent code and required 

resources will be generated to the specified output path and the generated database will be set up to the specified 

database configuration.


Generating Code and Database from Class Diagram 

Figure 16.31 - Generating Code and Database from Class Diagram 

Upon selecting the option for Generate Code from Class Diagram, the wizard helps you generate persistent code and database 

from class diagram with respect to the requirements you specified throughout the wizard. 

Take the following class diagram as an example: 

Figure 16.32 - Class Diagram 

Follow the steps of the Generate Code and Database from Class Diagram wizard: 

1. Selecting Classes 

Figure 16.33 - Select Persistable Classes 



16-16 

You are asked to select the classes on the class diagram which you want to generate persistent class to manipulate 

persistent data. By default, all the classes stereotyped as ORM-Persistable on the class diagram are selected for the 

generation of code and database shown in the list of Persistable Classes. You can deselect the persistable classes by 

using the list of buttons between the list of Non Persistable Classes and Persistable Classes. 

• Add Selected 

Add the selected class from Non Persistable Classes to Persistable Classes. 

• Remove Selected 

Remove the selected class from Persistable Classes to Non Persistable Classes. 

• Add All 

Add all classes from Non Persistable Classes to Persistable Classes. 

• Remove All 

Remove all classes from Persistable Classes to Non Persistable Classes. 

2. Select Primary Key 

For the classes shown in the list of Persistable Classes, they will be stereotyped as ORM- 

Persistable on the class diagram after the wizard is finished. Meanwhile, for the classes shown 

in the list of Non Persistable Classes, they will not be stereotyped on the class diagram after 

the wizard is finished. 

Figure 16.34 - Select primary key for each table 

You are asked to select the primary key for each class being mapped to data model and relational database. You can 

either select an attribute as the primary key or let SDE-VS generate the primary key automatically by using the dropdown 

menu. For more information, refer to the description of Mapping Primary key in the section of Mapping an 

Object Model to a Data Model in the Object Model chapter.


3. Table Details Configuration 

Figure 16.35 - Table details configuration 

You are asked to define the Table Details for generating database and code. The database and persistent classes will 

be generated based on the information defined here. You can edit the table details by double-clicking the field. 

• Package 




Figure 16.36 - Confirm generate classes in default package message 

• Table 

You can edit the table name which will be used as the name of the generated database table. 

• Columns 

You can edit the column name represented by the class. 

Figure 16.37 - Columns mapping 






the prefix or suffix of the Table, Column, Primary Key and Foreign Key. 

Figure 16.38 - Custom Code Style Setting dialog 

For the Type, select the type of Table detail, either Table, Column, Primary Key or Foreign Key that you 

want to apply code style. 














Figure 16.39 - Database configuration for Java




Configuration for Java Project section 


Figure 16.40 - Database Configuration for C# 






Figure 16.41 - Generate code configuration for Java 


Generation Setting for Java section in the Implementation chapter. 





Figure 16.42 - Generate code configuration for C# 



Wizard for Generate Code and Database from Class Diagram option provides an option of 

generating code to you. By default, the Generate Code option is selected. If you do not want to 

generate code from class diagram, please deselect the Generate Code option. In this case, only 

database will be generated while persistent code will not be generated. 

Click Finish, the Generate ORM Code/Database dialog box appears showing the progress of code 

generation. Click Close when the generation is complete. 


An entity relationship diagram will be generated automatically and added to your project. The generated persistent 

code and required resources will be generated to the specified output path and the generated database will be set up to 

the specified database configuration.

Chapter 16 - Using ORM Wizard - Visual Paradigm

Create successful ePaper yourself

Delete template?

Save as template?