UML: Creating Sequence Diagrams

In this tutorial, you learn how to use the UML features of the IDE to create a UML Sequence diagram. A Sequence diagram is a visual representation of the interaction between collaborating groups of objects in a system. Sequence diagrams consist of vertical lines called lifelines. Each Lifeline element represents the life of a given object. Lifelines are connected by horizontal lines denoting messages that pass from one object in the scenario to the next object in the scenario. .

Expected duration: 30 minutes

Contents

Using Sequence Diagrams Creating Sequence Diagrams Adding a Message to Self Element Using the Call Message Element Using the Auto-Expand Messages Option Using the Create Message Notation Adding Asynchronous Links Using the Combined Fragment Element Saving Your Diagram

Tutorial Requirements

Before you proceed, make sure you review the requirements in this section.

top

Using Sequence Diagrams

A Sequence diagram is a model that describes how groups of objects collaborate in some behavior over time. The Sequence diagram captures the behavior of a single use case and shows the objects and the messages that are passed between these objects in the timeframe of the specific use case. The Sequence diagram does not show relationships between objects.

The Sequence diagram may be used to:

• Describe the overall sequence of the flow of control when there are many short methods in different classes
• Show concurrent processes and activations
• Show time sequences that are not easily depicted in a Collaboration diagram
• Show general forms that do not deal with objects but with class interaction

top

Creating Sequence Diagrams

This tutorial uses the Class diagram that is created in the tutorial UML: Creating Class Diagrams and the Collaboration diagram that is created in the tutorial UML: Creating Collaboration Diagrams. You should complete these tutorials before proceeding with these steps.

This section contains the following procedures:

• To Generate a Sequence Diagram
• To Refine the Generated Diagram

top

top

Adding a Message to Self Element

A Message to Self diagram element represents a message intended for the calling object. The internal operation represented in this diagram is the validation of the cash on hand in the ATM object.

1. You may need to lengthen the Lifeline elements to ease the placement of the Message elements.
   To lengthen the Lifelines, follow these steps:
   
   1. Select the User Lifeline element.
   2. Click the blue box at the bottom center and drag the box downward to lengthen the Lifeline.
   3. Repeat steps a and b to lengthen the remaining Lifelines until your diagram resembles the following figure.
      

      

2. From the Basic section of the Modeling Palette, select the Message to Self icon .
3. Click the lower section of the extended ATM Lifeline element.
   The IDE places a Message to Self element on the Lifeline.
4. Right-click anywhere in the Diagram editor to deselect the Message to Self icon.
5. On the Message to Self element, click the lower message arrow.
   The properties for the message appear in the Properties window.
6. In the Properties window, in the Name field, type validateCashOnHandOperation and press Enter.
7. Right-click the upper message arrow on the Message to Self element and select Operations from the pop-up menu. The following figure indicates where to position the cursor. Note the double bar just above the top arrow.
   

   

8. Choose Operations > Add Operation from the pop-up menu.
   A one-line editor opens and displays the following information:
   

   visibility returnType name(parameter) {properties...}

9. Define your operations to be as follows
   

   public boolean getIsOperating()

   The upper portion of the message is labeled as shown in the following figure.
   

   

top

Using the Call Message Element

Because the validateCashOnHand operation is part of the ATM class, you need to place a message flow on the Lifeline to call that operation.

1. From the Basic section of the Modeling Palette, select the Synchronous Message icon
2. Click on the User Lifeline element, just below the getCashOnHand() message.
3. Click again on the ATM Lifeline element directly to the right of your first click.
   A message and a return message appear on the diagram as shown in the following figure.
   
   
   
   Note: If you do not want the return message to appear on the diagram, right-click in the white space of the Diagram editor. Deselect Show All Return Messages from the pop-up menu.
4. Right-click anywhere in the Diagram editor to deselect the Synchronous Message icon.
5. Right-click the message you just created and choose Operations > Add Operation from the pop-up menu.
6. Type validateCashOnHand and press Enter.
   The IDE labels the message on the diagram and adds the message as an operation in the ATM class in the Class diagram. In the Projects window, expand the ATM class node to verify that the list of operations resembles the following figure.
   

   

top

Using the Auto-Expand Messages Option

To help in the design process, the IDE has an option to auto-expand messages. With auto-expand selected, when a new message is placed on the diagram, the space expands to the width of the message.

1. In the gray header area above the lifelines elements, right-click in the area between the User and ATM element names to set the auto-expand option.
   A pop-up menu opens.
2. Select Set Width to Message Width.
   An indicator bar appears in the track between the two element names as shown in the following figure.
   

   

3. Repeat the steps to set the message width option between the ATM and Consortium elements and between the Consortium and Branch elements.

top

Using the Create Message Notation

The Create Message notation enables the creation of a Lifeline element or instance.

1. From the Basic section of the Modeling Palette, select the Create Message icon .
2. Click the lower portion of the Branch Lifeline.
   
3. Draw the link to the right of the Branch Lifeline and click again.
   A message and a lifeline are placed on the diagram as shown in the following figure.
   

   

4. Press the ESC key to deselect the icon.
5. Select the new Lifeline.
   The Properties window displays the properties for this Lifeline element.
6. In the Properties window, on the row labeled Representing Classifier, click the down arrow.
   A drop-down list appears.
7. Select CashierStation from the drop-down list and press Enter.
8. Click in the Diagram editor to see the labeled Lifeline element.
   
   Your diagram should resemble the following figure.
   

   

top

Adding Asynchronous Links

An asynchronous message element represents a message that does not block the calling object. This kind of message is capable of creating a new object, creating a new thread and communicating with an existing thread.

1. From the Basic section of the Modeling Palette, select the Asynchronous Message icon .
2. Draw a link between the Branch and CashierStation Lifelines by clicking the Branch Lifeline element, then click the CashierStation Lifeline element.
3. Press the ESC key to deselect the icon.
4. Right-click the new link and choose Operation > public int getStationID from the pop-up menu.
   This action adds the operation to this message as shown in the following figure.
   

   

top

Using the Combined Fragment Element

The combined fragment lets you express logical components, such as alternatives, options, exceptions, parallel merges, loops, negations, critical regions and assertions directly on your Sequence diagram. Combined fragments provide a means to define special conditions and subprocesses for any sections of any lifelines by specifying an area where the condition or subprocess applies.

1. From the Control section of the Modeling Palette, select the Combined Fragment icon .
2. To draw the Combined Fragment element so that it encapsulates the message, public void validateCashOnHand, click outside the blue dotted rectangle representing the message and click and drag the rectangle to surround the message.
   Be careful that you do not select any of the Lifeline elements when you click. Your Combined Fragment should look like the following figure.
   

   

3. Press the ESC key to deselect the icon.
4. Right-click the assert label in the Combined Fragment element and choose Interaction Operator > loop.
   
   Note: A loop Interaction Operator designates that the Combined Fragment represents a loop. Each time the loop repeats, the guard expression is evaluated. The guard expression can include a specific number of iterations of the loop.
5. Right-click the Combined Fragment label loop and choose Interaction Operand > Edit Interaction Constraint from the pop-up menu.
   The IDE displays an expression box in the target Combined Fragment element.
6. Double-click the word expression to make the expression box editable as shown in the following figure.
   

   

7. Type x < 10 and press Enter.
8. Click in the Diagram editor.
   Your expression is accepted and displayed in the box. Your diagram should resemble the following figure.
   

   

top

Saving Your Diagram

After you have completed your Sequence diagram, you can save it.

1. In the Diagram editor, right-click on the SequenceDiagram tab.
2. Select Save Document from the pop-up menu.
   The menu closes and the diagram is saved.
   
   Note: You are also prompted to save or discard your diagrams when you exit from the IDE.

top

Summary

In this tutorial, you learned to create a Sequence diagram using an existing Collaboration diagram. You learned how to perform the following tasks:

• Generate a Sequence diagram from an existing Collaboration diagram
• Add Messages to the diagram using icons from the Modeling Palette
• Add Links to the diagram
• Add a Combined Fragment element
• Save the diagram

top

Next Steps

• To send comments and suggestions, obtain support, and stay informed of the latest changes to the NetBeans IDE J2EE development features, join the [email protected] mailing list.

top

>> More NetBeans IDE Documentation