Composite pattern

<h2 id="overview">Overview</h2>

<p>The Composite<a class="footnote-ref" id="fnref:2" href="#fn:2"><sup>2</sup></a>
design pattern is one of the twenty-three well-known 
<i><a href="/facts/Design_Patterns/sYDxSGc9">GoF design patterns</a></i> 
that describe how to solve recurring design problems to design flexible and reusable object-oriented software, that is, objects that are easier to implement, change, test, and reuse.
</p>
<h3>Problems the Composite design pattern can solve</h3>
<ul><li>Represent a part-whole hierarchy so that clients can treat part and whole objects uniformly.</li>
<li>Represent a part-whole hierarchy as tree structure.</li></ul>
<p>When defining (1) Part objects and (2) Whole objects that act as containers for Part objects, clients must treat them separately, which complicates client code.<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a>
</p>
<h3>Solutions the Composite design pattern describes</h3>
<ul><li>Define a unified Component interface for part (Leaf) objects and whole (Composite) objects.</li>
<li>Individual Leaf objects implement the Component interface directly, and Composite objects forward requests to their child components.</li></ul>
<p>This enables clients to work through the Component interface to treat Leaf and Composite objects uniformly:
Leaf objects perform a request directly,
and Composite objects 
forward the request to their child components recursively downwards the tree structure.
This makes client classes easier to implement, change, test, and reuse.
</p><p>See also the UML class and object diagram below.
</p>
<h2 id="motivation">Motivation</h2>
<p>When dealing with Tree-structured data, programmers often have to discriminate between a leaf-node and a branch. This makes code more complex, and therefore, more error prone. The solution is an interface that allows treating complex and primitive objects uniformly. In <a href="/facts/Object-oriented_programming/TxNMEcao">object-oriented programming</a>, a composite is an object designed as a composition of one-or-more similar objects, all exhibiting similar functionality. This is known as a "<a href="/facts/Has-a/lyFhMcdw">has-a</a>" relationship between objects.<a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a> The key concept is that you can manipulate a single instance of the object just as you would manipulate a group of them. The operations you can perform on all the composite objects often have a <a href="/facts/Least_common_denominator/vdf2gKmo">least common denominator</a> relationship. For example, if defining a system to portray grouped shapes on a screen, it would be useful to define resizing a group of shapes to have the same effect (in some sense) as resizing a single shape.
</p>
<h2 id="when-to-use">When to use</h2>
<p>Composite should be used when clients ignore the difference between compositions of objects and individual objects.<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a>  If programmers find that they are using multiple objects in the same way, and often have nearly identical code to handle each of them, then composite is a good choice; it is less complex in this situation to treat primitives and composites as homogeneous.
</p>
<h2 id="structure">Structure</h2>
<h3>UML class and object diagram</h3>

<p>In the above <a href="/facts/Unified_Modeling_Language/3tlNS0tH">UML</a> <a href="/facts/Class_diagram/DNnkq7xh">class diagram</a>, the Client class doesn't refer to the Leaf and Composite classes directly (separately).
Instead, the Client refers to the common Component interface and can treat Leaf and Composite uniformly.

The Leaf class has no children and implements the Component interface directly.

The Composite class maintains a container of child
Component objects (children) and forwards requests
to these children (for each child in children: child.operation()).

</p><p>The object collaboration diagram 
shows the run-time interactions: In this example, the Client object sends a request to the top-level Composite object (of type Component) in the tree structure.
The request is forwarded to (performed on) all child Component objects 
(Leaf and Composite objects) downwards the tree structure.
</p>
Defining Child-Related Operations

<p>There are two design variants for defining and implementing child-related operations
like adding/removing a child component to/from the container (add(child)/remove(child)) and accessing a child component (getChild()):
</p>
<ul><li><i>Design for uniformity:</i> Child-related operations are defined in the Component interface. This enables clients to treat Leaf and Composite objects uniformly. But <a href="/facts/Type_safety/WxmEKq8R">type safety</a> is lost because clients can perform child-related operations on Leaf objects.</li>
<li><i>Design for type safety:</i> Child-related operations are defined only in the Composite class. Clients must treat Leaf and Composite objects differently. But type safety is gained because clients <i>cannot</i> perform child-related operations on Leaf objects.</li></ul>
<p>The Composite design pattern emphasizes <i>uniformity</i> over <i>type safety</i>.
</p>
<h3>UML class diagram</h3>

Component
<ul><li>is the abstraction for all components, including composite ones</li>
<li>declares the interface for objects in the composition</li>
<li>(optional) defines an interface for accessing a component's parent in the recursive structure, and implements it if that's appropriate</li></ul>
Leaf
<ul><li>represents leaf objects in the composition</li>
<li>implements all Component methods</li></ul>
Composite
<ul><li>represents a composite Component (component having children)</li>
<li>implements methods to manipulate children</li>
<li>implements all Component methods, generally by delegating them to its children</li></ul>

<h2 id="variation">Variation</h2>
<p>As it is described in <a href="/facts/Design_Patterns/sYDxSGc9">Design Patterns</a>, the pattern also involves including the child-manipulation methods in the main Component interface, not just the Composite subclass. More recent descriptions sometimes omit these methods.<a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a>
</p>
<h2 id="example">Example</h2>
<p>This C++14 implementation is based on the pre C++98 implementation in the book.
</p>
#include <iostream>
#include <string>
#include <list>
#include <memory>
#include <stdexcept>

typedef double Currency;

// declares the interface for objects in the composition.
class Equipment { // Component
public:
  // implements default behavior for the interface common to all classes, as appropriate.
  virtual const std::string& getName() {
    return name;
  }
  virtual void setName(const std::string& name_) {
    name = name_;
  }
  virtual Currency getNetPrice() {
    return netPrice;
  }
  virtual void setNetPrice(Currency netPrice_) {
    netPrice = netPrice_;
  }
  // declares an interface for accessing and managing its child components.
  virtual void add(std::shared_ptr<Equipment>) = 0;
  virtual void remove(std::shared_ptr<Equipment>) = 0;
  virtual ~Equipment() = default;
protected:
  Equipment() :name(""), netPrice(0) {}
  Equipment(const std::string& name_) :name(name_), netPrice(0) {}
private:
  std::string name;
  Currency netPrice;
};

// defines behavior for components having children.
class CompositeEquipment : public Equipment { // Composite
public:
  // implements child-related operations in the Component interface.
  virtual Currency getNetPrice() override {
    Currency total = Equipment::getNetPrice();
    for (const auto& i:equipment) {
      total += i->getNetPrice();
    }
    return total;
  }
  virtual void add(std::shared_ptr<Equipment> equipment_) override {
    equipment.push_front(equipment_.get());
  }
  virtual void remove(std::shared_ptr<Equipment> equipment_) override {
    equipment.remove(equipment_.get());
  }
protected:
  CompositeEquipment() :equipment() {}
  CompositeEquipment(const std::string& name_) :equipment() {
    setName(name_);
  }
private:
  // stores child components.
  std::list<Equipment*> equipment;
};

// represents leaf objects in the composition.
class FloppyDisk : public Equipment { // Leaf
public:
  FloppyDisk(const std::string& name_) {
    setName(name_);
  }
  // A leaf has no children.
  void add(std::shared_ptr<Equipment>) override {
    throw std::runtime_error("FloppyDisk::add");
  }
  void remove(std::shared_ptr<Equipment>) override {
    throw std::runtime_error("FloppyDisk::remove");
  }
};

class Chassis : public CompositeEquipment {
public:
  Chassis(const std::string& name_) {
    setName(name_);
  }
};

int main() {
  // The smart pointers prevent memory leaks.
  std::shared_ptr<FloppyDisk> fd1 = std::make_shared<FloppyDisk>("3.5in Floppy");
  fd1->setNetPrice(19.99);
  std::cout << fd1->getName() << ": netPrice=" << fd1->getNetPrice() << '\n';

std::shared_ptr<FloppyDisk> fd2 = std::make_shared<FloppyDisk>("5.25in Floppy");
  fd2->setNetPrice(29.99);
  std::cout << fd2->getName() << ": netPrice=" << fd2->getNetPrice() << '\n';

std::unique_ptr<Chassis> ch = std::make_unique<Chassis>("PC Chassis");
  ch->setNetPrice(39.99);
  ch->add(fd1);
  ch->add(fd2);
  std::cout << ch->getName() << ": netPrice=" << ch->getNetPrice() << '\n';

fd2->add(fd1);
}

<p>The program output is
</p>
3.5in Floppy: netPrice=19.99
5.25in Floppy: netPrice=29.99
PC Chassis: netPrice=89.97
terminate called after throwing an instance of 'std::runtime_error'
  what():  FloppyDisk::add

<h2 id="see-also">See also</h2>
<ul><li><a href="/facts/Perl_Design_Patterns_Book/nIAP5ngd">Perl Design Patterns Book</a></li>
<li><a href="/facts/Mixin/QHG68mgY">Mixin</a></li>
<li><a href="/facts/Law_of_Demeter/bYgvB4Te">Law of Demeter</a></li></ul>

<h2 id="external-links">External links</h2>

The Wikibook <i>Computer Science Design Patterns</i> has a page on the topic of: <i>Composite implementations in various languages</i>

<ul><li><a href="http://designpattern.co.il/Composite.html">Composite Pattern</a> implementation in Java</li>
<li>Composite pattern description from the Portland Pattern Repository</li>
<li><a href="https://web.archive.org/web/20151002170520/http://www.lepus.org.uk/ref/companion/Composite.xml">Composite pattern in UML and in LePUS3, a formal modelling language</a></li>
<li><a href="https://search.cpan.org/dist/Class-Delegation/lib/Class/Delegation.pm">Class::Delegation on CPAN</a></li>
<li><a href="http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/149878">"The End of Inheritance: Automatic Run-time Interface Building for Aggregated Objects"</a> by Paul Baranowski</li>
<li><a href="http://perfectjpattern.sourceforge.net/dp-composite.html">PerfectJPattern Open Source Project</a>, Provides componentized implementation of the Composite Pattern in Java</li>
<li><a href="https://web.archive.org/web/20090531030742/http://www.theresearchkitchen.com/blog/archives/57">[1]</a> A persistent Java-based implementation</li>
<li><a href="http://sourcemaking.com/design_patterns/composite">Composite Design Pattern</a></li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>Gamma, Erich; Richard Helm; Ralph Johnson; John M. Vlissides (1995). Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. pp. 395. ISBN 0-201-63361-2. <a href="0-201-63361-2" target="_blank">0-201-63361-2</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides (1994). Design Patterns: Elements of Reusable Object-Oriented Software. Addison Wesley. pp. 163ff. ISBN 0-201-63361-2.{{cite book}}:  CS1 maint: multiple names: authors list (link) <a href="0-201-63361-2" target="_blank">0-201-63361-2</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>"The Composite design pattern - Problem, Solution, and Applicability". w3sDesign.com. Retrieved 2017-08-12. <a href="http://w3sdesign.com/?gr=s03&ugr=proble" target="_blank">http://w3sdesign.com/?gr=s03&ugr=proble</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>Scott Walters (2004). Perl Design Patterns Book. Archived from the original on 2016-03-08. Retrieved 2010-01-18. <a href="https://web.archive.org/web/20160308182256/http://perldesignpatterns.com/?CompositePattern" target="_blank">https://web.archive.org/web/20160308182256/http://perldesignpatterns.com/?CompositePattern</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>Gamma, Erich; Richard Helm; Ralph Johnson; John M. Vlissides (1995). Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. pp. 395. ISBN 0-201-63361-2. <a href="0-201-63361-2" target="_blank">0-201-63361-2</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
<li id="fn:6"><p>Geary, David (13 September 2002). "A look at the Composite design pattern". Java Design Patterns. JavaWorld. Retrieved 2020-07-20. <a href="https://www.infoworld.com/article/2074564/a-look-at-the-composite-design-pattern.html" target="_blank">https://www.infoworld.com/article/2074564/a-look-at-the-composite-design-pattern.html</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li>
</ol>

Composite pattern open-in-new

Composite pattern