Home > Articles > Programming > Windows Programming

This chapter is from the book

This chapter is from the book

UML Class Diagrams

The standard UML diagram, or notation, for a class is a rectangle that's divided into three compartments. Starting at the top of the class diagram, the first compartment contains name of the class. The second compartment contains attributes of the class. (You'll also hear the attributes of a class referred to as the properties or variables of the class.) The third compartment contains class methods. The methods of the class tell us what the class can do.

Figure 3.2 shows a class diagram with the class name Vehicle in the first compartment. The standard naming convention for class names is to begin the class name with an uppercase letter. If the class name contains more than one word, each word in the class name is in uppercase. For example, class names that follow this naming convention would include Vehicle, PassengerCar, and IncomeStatement. There are no spaces between the words in a class name.

Figure 3.2Figure 3.2 A sample UML class diagram for a class named Vehicle.

Class Properties (Attributes)

In our example, compartment two has six Integer attributes. In a more complete example, there could be dozens of attributes for a class. Visual Basic .NET tends to refer to these attributes as the properties of the class. Each property can assume different values. Collectively, the current values of the properties describe the state of a class object. For example, if the CurrentGear value is 4 and CurrentSpeed is 55, it seems reasonable to assume that the Vehicle object is going forward at 55 miles per hour. Therefore, the state of the object is such that it is moving forward at 55 mph. If we can draw an English analogy, the properties of an object are like the nouns of a sentence.

Plus Signs and Minus Signs

You'll notice that each entry in the second compartment has a minus sign in front of it. In the third compartment, some entries have plus signs, whereas others have minus signs. The plus sign (+) signifies that the item on that line is available outside the class. Stated in a different way, the plus signs means that we can use these items to affect the state of the class object. The plus signs, therefore, denote Public elements of the class.

If an entry is prefixed with a minus sign (-), it means that the item is available for use only within the class itself. The item is not visible or accessible outside of the class. The minus signs, therefore, mark the Private elements of a class.

As a general rule, making an item Private is a good thing and is consistent with our goal of hiding data whenever possible. This is an integral part of the idea of encapsulation that we discussed in Chapter 2. By encapsulating the data, we minimize the chance of inadvertently changing the data in some part of the program outside of the class. This makes finding program errors much easier.

The plus and minus signs, therefore, denote the access specifiers for each element in a class. (There is a third access specifier named Protected that's denoted by the sharp symbol, #. We won't discuss this access specifier until Chapter 16, "Class Properties.") You can think of the plus signs as defining the way you interact with class objects, whereas the minus signs tells you what's available only to the class itself. (We'll delve into these program elements in Chapter 15, "Encapsulation.")

Class Methods (Operations)

Compartment three lists the operations that are available in the class. Although UML notation calls the items in compartment three operations, when using Visual Basic .NET, the tendency is to refer to these operations as methods. Methods tell the programmer how they must interact with the class. If you look at the names of the items in compartment three, each seems to imply an action of some sort. If properties are the nouns of a sentence, methods are the verbs.

You'll often hear other programmers refer to the methods as the procedures of a class. Even though there's nothing seriously wrong with this term, you should remember that procedures can exist outside of a class. However, methods are almost always tied to a particular class object.

Class Methods with Arguments

Sometimes a method needs outside information to perform its task. For example, in Figure 3.1, we see the following line:

+SetSpeed(DesiredSpeed:Integer):Integer

The plus sign says that SetSpeed() is a Public method, so it can be used in conjunction with a class object. Between the parentheses, we see that a data value is passed to the SetSpeed() method of the Vehicle class. This data value is given the name DesiredSpeed and it is an Integer data type. (You'll learn more about data types in the next chapter. For now, just think of DesiredSpeed as a number.)

After the closing parentheses, we see a colon (:) followed by the word Integer. This means that SetSpeed() will return an integer value to the part of the program that wanted to use the SetSpeed() method. Although we can't be sure at this point, the return value is probably used to indicate whether or not we were able to set the speed. After all, things can go wrong. For example, SetSpeed() probably doesn't work too well if the Vehicle object isn't running. Likewise, setting the speed to 150 is probably not wise if the current gear is Reverse.

Now look at the two lines:

-IncreaseSpeed(DesiredSpeed:Integer):Integer
-DecreaseSpeed(DesiredSpeed:Integer):Integer

These look very similar in terms of their purpose and use. In fact, such similarities should tip you off that it might be possible to simplify things. Could we replace these two methods with the following method

-ChangeSpeed(DesiredSpeed:Integer):Integer

with the understanding that if DesiredSpeed is positive, it represents the amount we want to raise the speed whereas a negative number is the amount we want to decrease the speed? For example, consider what the following code might do:

Dim MyVehicle as New Vehicle
Dim ObjectSpeed as integer

' Some code that does something...

ObjectSpeed = MyVehicle.GetSpeed()
ObjectSpeed = MyVehicle.ChangeSpeed(-ObjectSpeed)

First we create a Vehicle object named MyVehicle. Then we call the GetSpeed() method for the MyVehicle object. Notice how a dot (called the dot operator) separates the object name from the method name. All Visual Basic .NET objects use this syntax format.

Let's assume that the vehicle is presently traveling at 55 mph. The value of ObjectSpeed is assigned the value of 55. If we then pass the negative value of the current speed (that is, -55) to the ChangeSpeed() method, we can cause the car to stop.

I realize that there are a lot of syntax details that you don't understand about this example right now. Not to worry. We'll cover all of those details in subsequent chapters. For now, however, I just want you to get an idea of what a UML class diagram is and the type of information it conveys.

Why are some of the methods marked with minus signs? Obviously this means they are Private methods and not available outside of the class. Such methods are helper methods that are used internally by the class itself to accomplish its tasks. For example, the method OkToShiftGears() might check the CurrentGear and CurrentSpeed values to see if it's safe to shift gears. If the CurrentSpeed is 55, it might not be a good idea to shift into Reverse right now. Therefore, the ChangeGear() method might call OkToShiftGears() to help it decide whether it's safe to change gears.

The idea behind a UML class diagram is that is gives you a quick, concise overview of what the class does and how you as a programmer are expected to interact with it. If you think of a class as a black box, the minus signs indicate things inside the black box you shouldn't mess around with as a user of the class. The plus signs indicate the means you must use to interact with the properties and methods of the class. In other words, the Public items of a class define the interface for the class object and how you must interact with it.

Programmer's Tip

Always keep in mind that it's the Public methods that dictate how programmers must use your class. As long as you don't change how these methods are used, your interface with those programmers doesn't change. This lends consistency to your class.

On the other hand, you can change the Private methods to your heart's content and never need to worry about getting the programmers ticked off at you because you've changed the way they work. After all, they never see or use the Private methods anyway. This usually means keeping the Public methods as simple as possible and using the Private methods to manage the details of the task at hand.

We'll revisit UML class diagrams again in later chapters. For now, just review the material in this section to become comfortable with the nature of information UML class diagrams provide.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020