Visitor pattern in LLD - Architecture Diagram

System Overview - Visitor pattern

The Visitor pattern lets you add new operations to objects without changing their classes. It separates algorithms from the objects they work on, making it easier to add features without modifying existing code.

Key requirements include supporting multiple object types and allowing new operations to be added independently.

Architecture Diagram

  +---------+       +-------------+       +-------------+
  |  Client | ----> |  Object A   | <---- |  Visitor A   |
  +---------+       +-------------+       +-------------+
                         ^   ^
                         |   |
                  +-------------+       +-------------+
                  |  Object B   | <---- |  Visitor B   |
                  +-------------+       +-------------+

Components

Client

client

Starts the operation by accepting visitors on objects

Object A

element

An element that accepts visitors to perform operations

Object B

element

Another element type that accepts visitors

Visitor A

visitor

Defines an operation to perform on Object A

Visitor B

visitor

Defines an operation to perform on Object B

Request Flow - 4 Hops

Client → Object A

Object A → Visitor A

Client → Object B

Object B → Visitor B

Failure Scenario

Component Fails:Visitor A

Impact:Operations on Object A fail or produce incorrect results

Mitigation:Use default visitor implementations or fallback visitors to handle missing operations

Architecture Quiz - 3 Questions

Which component initiates the Visitor pattern operation?

A Client

B Visitor

C Object

D Database

Design Principle

The Visitor pattern separates operations from object structures, enabling new behaviors without modifying existing classes. This promotes open/closed principle and easier maintenance.

Practice

1. What is the main purpose of the Visitor pattern in system design?

easy

A. To separate operations from the objects on which they operate

B. To create multiple instances of a class

C. To restrict access to certain parts of an object

D. To simplify database queries

Solution

1. Step 1: Understand the Visitor pattern concept

   The Visitor pattern allows defining new operations on objects without changing their classes.

2. Step 2: Identify the main goal

   Its main goal is to separate the operation logic from the object structure to keep code flexible.

3. Final Answer:

   To separate operations from the objects on which they operate -> Option A

4. Quick Check:

   Visitor pattern = separates operations [OK]

Hint: Visitor pattern separates operations from objects [OK]

Common Mistakes:

• Confusing Visitor with Singleton pattern
• Thinking it creates object instances
• Assuming it controls access permissions

2. Which of the following is the correct method signature for a visitor interface method visiting an element called ElementA?

easy

A. void accept(ElementA element);

B. void acceptVisitor(ElementA visitor);

C. void visitElementA();

D. void visit(ElementA element);

Solution

1. Step 1: Recall Visitor interface method naming

   The visitor interface defines methods named visit with the element type as parameter.

2. Step 2: Match correct signature

   The correct signature is void visit(ElementA element); to visit ElementA.

3. Final Answer:

   void visit(ElementA element); -> Option D

4. Quick Check:

   Visitor method = visit(Element) [OK]

Hint: Visitor methods are named visit(Element) [OK]

Common Mistakes:

• Confusing accept and visit method names
• Using no parameters in visit method
• Swapping visitor and element in parameters

3. Given the following code snippet, what will be the output?

class ElementA {
  accept(visitor) {
    visitor.visit(this);
  }
}

class PrintVisitor {
  visit(element) {
    console.log('Visited element');
  }
}

const element = new ElementA();
const visitor = new PrintVisitor();
element.accept(visitor);

medium

A. Visited ElementA

B. Error: visit is not a function

C. Visited element

D. No output

Solution

1. Step 1: Trace accept method call

   The accept method calls visitor.visit(this), passing the element instance.

2. Step 2: Check visit method behavior

   The visit method logs 'Visited element' to the console.

3. Final Answer:

   Visited element -> Option C

4. Quick Check:

   Visitor.visit logs message [OK]

Hint: Visitor.visit prints message when accept calls it [OK]

Common Mistakes:

• Expecting element type name in output
• Thinking visit method is missing
• Assuming no output without explicit return

4. Identify the error in this Visitor pattern implementation:

class ElementB {
  accept(visitor) {
    visitor.accept(this);
  }
}

class ConcreteVisitor {
  visit(element) {
    console.log('Visiting element');
  }
}

medium

A. ElementB calls visitor.accept instead of visitor.visit

B. ConcreteVisitor should not have a visit method

C. accept method should return a value

D. ElementB should not have an accept method

Solution

1. Step 1: Check accept method call

   The accept method calls visitor.accept(this), but visitor has no accept method.

2. Step 2: Identify correct visitor method

   The visitor interface defines visit methods, so accept should call visitor.visit(this).

3. Final Answer:

   ElementB calls visitor.accept instead of visitor.visit -> Option A

4. Quick Check:

   accept calls visit, not accept [OK]

Hint: accept calls visitor.visit, not visitor.accept [OK]

Common Mistakes:

• Confusing method names accept and visit
• Expecting accept to return a value
• Removing accept method from element

5. You have a system with multiple element types and want to add a new operation without modifying existing element classes. How does the Visitor pattern help in this scenario?

hard

A. By using inheritance to extend element classes with new operations

B. By creating a new visitor class implementing the operation for all element types

C. By adding new methods to each element class directly

D. By storing operations inside element objects as data

Solution

1. Step 1: Understand the problem of adding new operations

   Modifying existing element classes is risky and breaks encapsulation.

2. Step 2: Apply Visitor pattern solution

   Create a new visitor class that implements the new operation for all element types, keeping element classes unchanged.

3. Final Answer:

   By creating a new visitor class implementing the operation for all element types -> Option B

4. Quick Check:

   Visitor adds operations via new visitor classes [OK]

Hint: Add new visitor class for new operations [OK]

Common Mistakes:

• Modifying element classes directly
• Using inheritance to add operations
• Embedding operations as data in elements