UML Course

Class diagram

Go back

A class diagram is used to represent classes and objects, in object-oriented languages. The database diagram is also quite similar to the class diagram, so you will see this one a lot.

class

A Class is an abstract representation of a concept, like a person here. We have what we call

  • field / attributes (age, name, ...)
  • operations (age)

When we are giving values to our attributes, we are creating an instance of the class called an object (Gamma here).

Notes

  • The class' name must starts with an uppercase, using CamelCase syntax (upperCamelCase)
  • The object's name is underlined, you can think of this name as the variable name storing this object

Attributes

Attributes got

  • a visibility
    • public (+, read/write for all classes, default mode)
    • private (-, read/write only for the class's methods)
    • package (~, read/write for all classes inside the class's folder)
    • protected (#, same as package, but read/write for all classes inheriting our class)
  • a name
  • a type
  • a default value (optional)

Notes

  • if an attribute has a / before its visibility, this is a derived attribute, meaning that its value is calculated using other attributes.
  • an attribute underlined is static, meaning that the attribute is shared by all instances, and it belongs to the class
  • a constant is usually static, I'm doing that by adding a {final} after the type (=OCL syntax)

final attribute UML

  • composite attributes are attributes made of more attributes. I have only seen that used in JavaScript, since you can create an object that does not have a class

composite attribute UML


Operations

An operation is the UML name for a method/function. You will have

  • a visibility
  • a function name (usually in lowerCamelCase)
  • some arguments
    • separated by a comma
    • name:type
  • a return type (none isn't the same as void, like a Java constructor isn't returning void but "nothing")

Ex: + getName() : String is a public ("+") operation named "getName" taking no arguments ("()") and returning a String (": String").

Notes

  • If your method is creating/destroying objects, then you should add <<constructor>>/<<create>>, and <<destroy>> after the visibility
  • an operation underlined is static (ex: you don't new an object to call an operation, you can call it on the class, like Math.round)

Associations and multiplicity

Now that you can write a class, we will look at the relationships between classes, represented by what we call associations/relationships. An association is a representation of a link between two classes. We usually write a multiplicity "n..m" characterizing how many instances of the classes are linked with how many of the other classes. We are also adding a name to remember what kind of link it is.

multiplicity

  • Multiplicity
  • association classes
  • an association from A to A is called self-association (association réflexive)
  • you can add a direction
  • adding a name on the association is optional
  • you can have multiples associations between 2 classes

And sometimes you may declare an attribute having the type of another class inside your diagram. Some programmers are adding the attribute on the association rather than inside the class, but not everyone does this.


Advanced associations

You are going to use the generalization a lot to factorize your code logic, aggregation/compositions are used a lot, but they aren't really useful.


Associations constraints

  • dynamic: you write a note on the association, explaining the constraints (ex: you can't call buy before order)

The following constraints, are applied on every association linked to a line ------. We are adding the constraint on top of the line, which could be a constraint of

  • inclusion {IN}, {SUBSET}, {I}: if one association exist, then all of them exist too
  • exclusion {X}: if one association exist, then only one exist
  • equality/simultaneity {=}, {AND}, {S}: all associations must exist
  • total/coverage/inclusive {T}, {OR}: at least 1 association exist
  • partition/exclusive {XT}, {P}, {+}: only 1 association exist

For the constraint of inclusion, we are not drawing a line, but an arrow from the association X to the association Y. It means that X can only exist if Y exists.


Packages

You can group classes by packages (=folders) to make something cleaner. Usually, a package name is a path, starting from the project folder. We are using . as the folder separator. You will usually see names like net.sourceforge.plantuml for the net/sourceforge/plantuml/ folder.

packages in UML