LAB-8110 NetBeans Enterprise Pack: Advanced UML Modeling

Creating a UML Java-Platform Model Project

1. Choose File from the menu bar and then select New Project. The New Project dialog box appears.
2. Under Choose Project pane, select UML under Categories and select Java-Platform Model under Projects.
   




3. Click Next.
4. Under Name and Location pane,
   
   • For the Project Name field, enter ContactLibrary_UML.
   • For the Project Location field, click Browse to navigate, select the <lab_root>\nbeuml2 directory and click Open.
     

   
   

5. Click Finish.
   

   The New Wizard dialog box appears.
   

6. For the Diagram Type field, select Use Case Diagram.
7. For the Diagram Name field, enter ContactUseCaseDiagram.




8. Click OK.
   

   The ContactLibrary_UML project appears in the Projects window.





Click to Enlarge

Developing a Use Case Model

1. Activate ContactUseCaseDiagram diagram by click on diagram's tab or by double click in project tree.
2. Open UML Palette (if closed) with main menu Window > Palette.
3. Add Actor to the diagram.
   • Select Actor in palette.
   • Click left mouse button in free space of diagram area.
     You'll get new Actor element in your model.
4. Name it ContactManager.
   • Select the element on the diagram (if not selected).
   • Type name of element and press Enter.

   
   Click to Enlarge

5. Add Package to the diagram.
6. Name it contactAssistant.

7. Enlarge the Package to a hold a couple of Use Cases.




8. Add UseCase to the Package.
9. Name it Manage Contacts.

10. Draw Association link from ContactManager actor to Manage Contacts use case.
    • Select Association link in palette.
    • Click on Actor element.
    • Click on Use Case element.

    
    Click to Enlarge

11. Add UseCase to the Package.
12. Name it Add Contact.

13. Draw Include link from Manage Contacts use case to Add Contact use case.

    
    Click to Enlarge

14. Add UseCase to the Package.
15. Name it Add Personal Information.

16. Draw Include link from Add Contact use case to Personal Information use case.

17. Add UseCase to the Package.
18. Name it Add First Name.

19. Add UseCase to the Package.
20. Name it Add Last Name.

21. Draw Include link from Add Personal Information use case to Add First Name use case.

22. Draw Include link from Add Personal Information use case to Add Last Name use case.

    
    Click to Enlarge

23. Insert Add Birth Date Extension Point to Add Personal Information use case.
    • Invoke Context menu on the use case.

    
    

    • Click on Insert Extension Point menu item.
      Text field was added to use case.
    • Type Extension Point name.
    • Press Enter.

    
    

24. Add UseCase to the Package.
25. Name it Add EMail Address.

26. Draw Include link from Add Contact use case to Add EMail Addres use case.

27. Insert Add Address Extension Point to Add Contact use case.
28. Insert Add Organization Extension Point to Add Contact use case.
29. Insert Update Contact Extension Point to Manage Contacts use case.
30. Insert Remove Contact Extension Point to Manage Contacts use case.


Click to Enlarge

Developing a Class Hierarchy

1. Create ContactClassDiagram under UML Project Model tree.
   • In the Projects window, expand the ContactLibrary_UML node.
   • Invoke Context menu on the Model node.
   • Click on Add Diagram menu item.
     The New Wizard dialog box appears.
   • For the Diagram Type field, select Class Diagram.
   • For the Diagram Name field, enter ContactClassDiagram.

   
   

   • Click OK.
     
2. Activate ContactClassDiagram diagram by click on diagram's tab or by double click in project tree.
3. Open UML Palette (if closed) with main menu Window > Palette.


Click to Enlarge

4. Add Package to the diagram.
   • Select Package in palette.
   • Click left mouse button in free space of diagram area.
     You'll get new package element in your model.
5. Name it contact.
   • Select the element on the diagram (if not selected).
   • Type name of element and press Enter.

   
   Click to Enlarge

6. Add Class to the diagram.
7. Name it Contact.

   
   Click to Enlarge

8. Add Class to the diagram.
9. Name it ContactList.

10. Add Class to the diagram.
11. Name it PersonalIdentity.

12. Add Class to the diagram.
13. Name it EMailAddress.

    
    

14. Draw Nested link from Contact class to contact package.
    • Select Nested link in palette.
    • Click on Class element.
    • Click on Package element.
      Now class is located in package.

    
    Click to Enlarge

15. Draw Nested link from ContactList class to contact package.
16. Draw Nested link from PersonalIdentity class to contact package.
17. Draw Nested link from EMailAddress class to contact package.

Defining Application Classes

1. Insert String firstName attribute to PersonalIdentity class.
   • Invoke Context menu on Attributes title within the class.

   
   

   • Click on Insert Attribute menu item.
     Attribute with default name was added to class.
   • Delete default name (with backspace) and delete default attribute type (int)
   • Type attribute type.
   • Type attribute name.

   
   

   • Press Enter.

   
   

2. Insert String lastName attribute to PersonalIdentity class.




3. Insert String address attribute to EMailAddress class.




4. Insert boolean hasPersonalIdentity attribute to Contact class.
5. Set default value of hasPersonalIdentity attribute to false in Contact class.
   • Double-click the attribute.
   • Go to the end of text field.
   • Press = and type default value.
   • Press Enter.




6. Insert PersonalIdentity personalIdentity attribute to Contact class.
7. Insert ArrayList<EMailAddress> eMailAddressList attribute to Contact class.
8. Set default value of eMailAddressList attribute to new ArrayList<EMailAddress>() in Contact class.




9. Insert boolean addEMailAddress(EMailAddress eMailAddress) operation to Contact class.
   • Invoke Context menu on Operation title within the class.

   
   

   • Click on Insert Operation menu item.
     Operation with default name was added to class.
   • Delete default name (with backspace) and delete default attribute type (int)
   • Type operation type.
   • Type operation name.
   • Type operation arguments.

   
   

   • Press Enter.

   
   

10. Insert boolean removeEMailAddress(EMailAddress eMailAddress) operation to Contact class.
11. Insert EMailAddress removeEMailAddress(int index) operation to Contact class.
12. Insert EMailAddress setEMailAddress(int index, EMailAddress eMailAddress) operation to Contact class.




13. Insert ArrayList<Contact> contactList attribute to ContactList class.
14. Set default value of ArrayList<Contact> contactList attribute to new ArrayList<Contact>() in ContactList class.
15. Insert boolean addContact(Contact contact) operation to ContactList class.
16. Insert boolean removeContact(Contact contact) operation to ContactList class.
17. Insert Contact removeContact(int index) operation to ContactList class.
18. Insert Contact setContact(int index, Contact contact) operation to ContactList class.



The Class diagram should be like this:


Click to Enlarge

Generating Java Source Code

1. Create empty ContactLibrary_JAVA Java Application.

   • Choose File from the menu bar and then select New Project.
     The New Project dialog box appears.
   • Under Choose Project pane, select General under Categories and select Java Application under Projects. Click Next.

   
   

   • For the Project Name field, enter ContactLibrary_JAVA.
   • For the Project Location field, click Browse to navigate, select the <lab_root>\nbeuml2 directory and click Open.
   • Uncheck Create Main Class checkbox

   
   

   • Click Finish.
     

   
   

2. Associate ContactLibrary_UML project with ContactLibrary_JAVA project.

   • In the Projects window, select the ContactLibrary_UML node and invoke Context menu.
   • Click on Properties menu item.
     The Project Properties - ContactLibrary_UML dialog box appears.
   • Select Modeling under Categories
   • Check Generate Code checkbox
   • For the Java Project list, select ContactLibrary_JAVA.

   
   

   • Click OK.
3. Generate Java Source Code

   • In the Projects window, select the ContactLibrary_UML node and invoke Context menu.

   
   

   • Click on Generate Code menu item.
     The Code Generation dialog box appears.

   
   

   • Click Done.
     contact package appears in ContactLibrary_JAVA Java Application
     Contact, ContactList, PersonalIdentity, EMailAddress classes appear under contact package in ContactLibrary_JAVA Java Application

   
   

Filling up Bodies of Generated Operations

1. Activate ContactClassDiagram diagram by click on diagram's tab or by double click in project tree.
2. Go to source of the EMailAddress class element.

   • Invoke Context menu within the class element.

   
   

   • Click on Navigate To Source menu item.
     You'll see the source code for class element.

   
   

   
   The following methods were generated for the EMailAddress class

   • Constructor.
   • get/set methods for address attribute.

   
   

3. Go to source of the PersonalIdentity class element.
   The following methods were generated for the PersonalIdentity class

   • Constructor.
   • get/set methods for firstName attribute.
   • get/set methods for lastName attribute.
4. Go to source of the Contact class element.
   The following methods were generated with default bodies

   • boolean addEMailAddress(EMailAddress eMailAddress).
   • boolean removeEMailAddress(EMailAddress eMailAddress).
   • EMailAddress removeEMailAddress(int index).
   • EMailAddress setEMailAddress(int index, EMailAddress eMailAddress).
5. Change body of boolean addEMailAddress(EMailAddress eMailAddress) operation for Contact class to

           return this.eMailAddressList.add(eMailAddress);
          

   
   

6. Change body of boolean removeEMailAddress(EMailAddress eMailAddress) operation for Contact class to

           return this.eMailAddressList.remove(eMailAddress);
          

7. Change body of EMailAddress removeEMailAddress(int index) operation for Contact class to

           return this.eMailAddressList.remove(index);
          

8. Change body of EMailAddress setEMailAddress(int index, EMailAddress eMailAddress) operation for Contact class to

           return this.eMailAddressList.set(index, eMailAddress);
          

   
   

9. Press <Alt+Shift+F> to fix all class's imports




10. Go to source of the ContactList class element.
11. Change body of boolean addContact(Contact contact) operation for ContactList class to

            return this.contactList.add(contact);
           

12. Change body of boolean removeContact(Contact contact) operation for ContactList class to

            return this.contactList.remove(contact);
           

13. Change body of Contact removeContact(int index) operation for ContactList class to

            return this.contactList.remove(index);
           

14. Change body of Contact setContact(int index, Contact contact) operation for ContactList class to

            return this.contactList.set(index, contact);
           

    
    

15. Press <Alt+Shift+F> to fix all class's imports.




16. Build ContactLibrary_JAVA application

    • In the Projects window, select the ContactLibrary_JAVA node and invoke Context menu.
    • Click on Build Project menu item.

    
    

    • Correct errors if build was failed

    
    

Run The Developed Application

1. Add contactView package into ContactLibrary_JAVA application.
2. Get ContactEditor JFrame (java and form files) from <lab_root>\nbeuml2\AppCreate\ContactLibrary\src\contactView directory and copy them to contactView package of ContactLibrary_JAVA application (<lab_root>\nbeuml2\ContactLibrary_JAVA\src\contactView).

   • ContactEditor.java
   • ContactEditor.form

   
   

3. Run ContactLibrary_JAVA application

   • In the Projects window, select the ContactLibrary_JAVA node and invoke Context menu.

   
   

   • Click on Run Project menu item.
     The Run Project dialog box appears.
   • Select contactView.ContactEditor under Select the main class.

   
   

   • Click OK.
     The Contact Editor window appears.

   
   

4. There are two contacts in the Contact List on the Contact Editor window

   • Gail Gardner, Gail.Gardner@sun.com.
   • Tom Davis, Tom.Davis@sun.com.
5. Add Mike Wazowski, Mike.Wazowski@monster.com contact to Contact list

   • For the First Name field, enter Mike.
   • For the Last Name field, enter Wazowski.
   • For the EMail Address field, enter Mike.Wazowski@monster.com .

   
   

   • Click Add.
     Mike Wazowski, Mike.Wazowski@monster.com contact is added to Contact list.

   
   

6. Close Contact Editor window.

Summary

In this exercise, you learned how to create new Java application using UML Modeling.
You learned how to perform the following tasks:

Desing and analyze application using Use Case Diagram

Develop Class hierarchy of Java application on Class Diagram

Filling Java classes with attributes and operations on UML diagram

Generating Java source code for Application developed on diagram

Step 1: Open Existing Java project with existing sources

Note: Close all projects from from previous exercises.

1. Choose File from the menu bar and then select Open Project.
2. Browse to the <lab_root>/nbeuml2/AppMaintain directory and select ContactLibrary2 project. Click Open Project Folder.
   

   
   Click to Enlarge

3. New ContactLibrary2 project node will appear in Projects tab.

Step 2: Run project to find a mistake

1. Right-click on the java Project node and select 'Run Project' from Context menu.
2. In opened 'Run Project' dialog window select 'contactView.ContactEditor' main class
   

   

   Press OK.
3. Output window shows compilation and running status.
   

   

4. Contact Editor form is started.
5. Double-Click on 'First Name' of existing 'Tom Davis' contact item to edit it.
   Table cell becomes editable.
   Type new Name 'Bob'.
   Change Email to 'Bob.Davis@sun.com'.
   

   

   Click 'Update' button.
   
6. Close Contact Editor window.
   Look at output window.
   Editor application will print out updated Contact information.
   Actually you can see that 'Tom Davis' record wasn't updated.
   

   

7. This means there is an error in updating mechanism.
   We should review application, find a mistale and fix it.
   
8. Now you can close 'Output - ContactLibrary2 (run)' window.

Step 3: Create a UML project by reverse engineering

1. Invoke 'File | New Project' command from the menu bar. The New Project dialog box appears.
2. Under Choose Project pane, select UML under Categories and select Java-Platform Model by Reverse-Engineering a Java Project under Projects. Click Next.
   
   
   

   
   Click to Enlarge

   Note: You can create uml project from your sources another way by selecting Java-Platform Model project with turning on Generate Source on next wizard step
3. Under Name and Location pane,
   

   • For the Project Name field, enter ContactLibrary2UML .
   • For the Project Location field, click Browse to navigate to and select the AppMaintain folder and click Open.
     
   • Choose ContactLibrary2 project in Java Project combobox.
     

   
   Click to Enlarge

   Note: You have to select java project to proceed with Java-Platform Model by Reverse-Engineering a Java Project project creation. You can choose only from already opened java projects.
   
   
4. When the reverse engineering is done, click Done. The ContactLibrary2UML project appears in the Projects window.
   
   

   

   
   

Step 4: Generate Class Diagram for Project

1. In the Projects tab window, under the ContactLibrary2UML node, expand the Model node.
   Expand the contact and contactView package nodes.
2. Select the contact and contactView packages and all class nodes under them.
   You may click on contact folder and then, holding Shift key, click on ContactEditor to select all element between them.
3. Right-click the selected elements and choose Create Diagram From Selected Elements from the contextual menu.
4. In the Diagram Type list, select Class Diagram.
   Type ContactClassDiagram in the Diagram Name field,
   leave ContactLibrary2UML in the Namespace field
   and click OK.
   

   

5. This action does the following:
   

   • Creates a ContactClassDiagram node under the Model node
   • Displays the new diagram in the Diagram editor
   • Opens the Modeling Palette

   
   Click to Enlarge

Step 5: Change diagram view

1. Double-click the BankClassDiagram tab at the top of the Diagram editor.
   Note: To reverse this action double-click the BankClassDiagram tab again.
2. Select 'Zoom with marquee' button on diagram toolbar.
3. Click on empty diagram area near the top left corner of ContactEditor symbol on diagram and do not release the mouse button.
   Holding mouse button move pointer to select the whole ContactEditor symbol. Release button.
   

   
   

4. You will see selected area enlarged to the whole visible diagram area.
   
   

   
   Click to Enlarge

Step 6: Review project structure on Class Diagram

1. Look at ContactEditor class symbol on diagram.
2. There is 'updateButtonActionPerformed(ActionEvent)' operation which name
   (according to widespread naming approach) shows that it is invoked from 'update' button event listener.
3. And method 'setContact(int, Vector)' which performs actual data updating

   

4. setContact() is probably invoked from updateButtonActionPerformed().

Step 7: Generate a Sequence Diagram for an Operation

1. Let's analyze updateButtonActionPerformed() method.
   Right-click on 'private void updateButtonActionPerformed(ActionEvent)' operation area
   and invoke 'Reverse Engineer Operation' command.
   

   

2. The New Wizard dialog for creating a new diagram appears.
   

   

3. In the Diagram Type list, select Sequence Diagram.
   
4. In the Diagram Name field, type ContactEditorSD.
   
5. Accept the default value in the Namespace field and click OK. A sequence diagram appears in the Diagram Editor.
6. Expand the Diagram editor and manipulate the zoom level so that you can easily examine the new sequence diagram.
   

   
   Click to Enlarge

Step 8: Review update operation on Sequence diagram

1. We can see Objects created and used in updateButtonActionPerformed method.
   

   
   Click to Enlarge

2. We can see combined fragments like 'if', loops etc.
   

   

3. And We can analyze messages invocation sequence.
   
4. For updateButtonActionPerformed we see method getSelectedRow() that selects updated row .
   

   

5. Then requests new values using getValueAt(int, Integer) method.
   

   

6. Adds them into Vector.
   

   

7. And then should invoke setContact(int, Vector) method to perform update.
   But it doesn't!
8. We have localized a mistake.

Step 9: Fix problem

1. Switch to class diagram
2. Open context menu for updateButtonActionPerformed method of ContactEditor class element
   and invoke 'Navigate to source' command.

   

3. Add 'this.setContact(rowIndex, rowData);' invocation as the last line of 'if' clause.

   
   Click to Enlarge

Step 10: Run project to check

1. Run ContactLibrary2 project again to check if updating works now.
   
2. Change First Name and Email Address to 'Bob' and 'Bob.Davis@sun.com' again.
   Press Update button.

   

3. Close application window and check in output that contact data was updated.
   

   

Summary

In this exercise, you learned how to reverse engineer and analyze a Java application.
You learned how to perform the following tasks:

Create Reverse-Engineered UML Project

Generate a class diagram from the imported application

Generate a sequence diagram for an operation

Analyze generated sequence diagram