Visual Paradigm logo
Jump to Menu

Builder Pattern Tutorial

This tutorial is aimed to guide the definition and application of Gang of Four (GoF) builder design pattern. By reading this tutorial, you will know how to develop a model for the builder pattern, and how to apply it in practice.

Compatible edition(s): Enterprise, Professional, Standard

  • September 28, 2009
  • Views: 38,602
  • PDF

Modeling Design Pattern with Class Diagram

  1. Create a new project Design Patterns.
  2. Create a class diagram Builder.
    new class diagram
  3. Select Class from diagram toolbar. Click on the diagram to create a class. Name it as Director.
    create director class
  4. Right-click on Director and select Add > Operation from the popup menu.
    new oper
  5. Name it as Construct().
    new construct oper
  6. Move the cursor over Director, make use of resource icon Aggregation > Class to create an associated class Builder.
    create builder class
  7. Set the Builder abstract by right clicking on Builder and selecting Model Element Properties > Abstract from the popup menu.
    set builder abstract
  8. Create an operation BuildPart() in Builder.
    add oper to builder
  9. Set BuildPart() abstract by right clicking on it and selecting Model Element Properties > Abstract from the popup menu.
    set oper abstract
  10. Move the cursor over Builder, make use of resource icon Generalization > Class to create a subclass ConcreteBuilder.
    create concrete builder
  11. Inherit operations from Builder by right clicking on ConcreteBuilder and selecting Related Elements > Realize all Interfaces from the popup menu.
    realize
  12. Add an operation GetResult() to ConcreteBuilder. Up to now, the diagram should look like this:
    get result added to concrete builder
  13. Move the cursor over ConcreteBuilder, make use of resource icon Dependency > Class to create a depending class Product.
    created product
  14. In practice, there can be multiple concrete builder classes. To represent this, we need to assign a special stereotype to the ConcreteBuilder class. Right-click on ConcreteBuilder and select Stereotypes > Stereotypes... from the popup menu.
    stereotype concrete builder
  15. Select PTN Cloneable, click > to assign it to the Selected Stereotype list. Click OK to confirm.
    stereotype assigned
  16. In practice, there may be multiple to operations in the Builder class for creating parts. To represent this, we need to assign a special stereotype to the Builder class. Right-click on Builder and select Stereotypes > Stereotypes... from the popup menu.
    stereotype builder
  17. Assign stereotype PTN Members Creatable to the class. Click OK to confirm.
    stereotype assigned
  18. For the association end of the association between the Director and Builder classes, there is a role named Builder. Double click on the Director end and enter Builder as name. The diagram should now become:
    class diagram done

Defining Pattern

  1. Select all classes on the class diagram.
    select all classes
  2. Right-click on the selection and select Define Design Pattern... from the popup menu.
    define design pattern
  3. In the Define Design Pattern dialog box, specify the pattern name Builder. Keep the file name as is. Click OK to proceed.
    define dp

Applying Design Pattern on Class Diagram

In this section, we are going to apply the builder pattern in modeling a report printing system that offers printing PDF, RTF, and HTML report one after the other, with same content in them.

  1. Create a new project Report Printer.
  2. Create a class diagram Report Printer.
  3. Right-click on the class diagram and select Utilities > Apply Design Pattern... from the popup menu.
    apply design pattern
  4. In the Design Pattern dialog box, select Builder from the list of patterns.
    select builder pattern
  5. Click on Director in the preview.
    select director
  6. Rename Director to ReportPrinter at the bottom pane.
    name director
  7. Rename the operation Construct to printReport.
    name oper
  8. Rename the class Builder to Printer.
    rename builder
  9. Rename the operation BuildPart to PrintHeader.
    print header
  10. We need three operations in the Printer class for printing header, content and footer. Press the + button, and select New Operation... to add more operations.
    new oper
  11. In the Operation Specification, name the operation printContent. Check Abstract at the bottom of dialog box. Click OK to confirm.
    name oper
  12. Repeat steps 10 and 11 to create the printFooter method.
    opers added
  13. Now, clone the ConcreteBuilder class to make it have 3 subclasses as printers for PDF, RTF and HTML reports. Select ConcreteBuilder in preview pane first.
    select concrete builder
  14. Click on the + button and select Clone.
    select clone
  15. Select 2 as the number of classes to clone.
    select clone count
  16. Rename the classes and operations as shown below:
    rename class and opers
  17. Click OK to confirm the changes and apply the pattern on diagram.
  18. Tidy up the diagram to make it looks like below:
    diagram neat
  19. Inherits the operations from the Printer class to the concrete printer classes. Right-click on PDFPrinter class and select Related Elements > Realize all Interfaces from the popup menu.
    inherit opers
  20. Do the same for classes HTMLPrinter and RTFPrinter.
  21. Rename the role Builder to Printer. The result should look like this:
    result
Resources
  1. Builder.pat
  2. Design Patterns.vpp
Related Links
Readers of this tutorial also read
Testimonals

I am extremely pleased in both its ease of use as well as its breadth of features. Of particular value to me is the Textual Analysis tool.

Prof. William Burrows

University of Washington, Seattle

Turn every software project into a successful one.

Try Visual Paradigm Free

We use cookies to offer you a better experience. By visiting our website, you agree to the use of cookies as described in our Cookie Policy.

OK