- Visitor pattern
LePUS3 ( [http://lepus.org.uk/ref/legend/legend.xml legend] ) ]
object-oriented programmingand software engineering, the visitor design pattern is a way of separating an algorithmfrom an object structure upon which it operates. A practical result of this separation is the ability to add new operations to existing object structures without modifying those structures. Thus, using the visitor pattern helps conformance with the open/closed principle.
In essence, the visitor allows one to add new
virtual functions to a family of classes without modifying the classes themselves; instead, one creates a visitor class that implements all of the appropriate specializations of the virtual function. The visitor takes the instance reference as input, and implements the goal through double dispatch.
While powerful, the visitor pattern does have limitations as compared with conventional
virtual functions. It is not possible to create visitors for objects without adding a small callback method inside each class and the callback method in each of the classes is not inheritable to the level of the new subclass.
The idea is to use a structure of element classes, each of which has an
accept()method that takes a
visitorobject as an argument.
Visitoris an interface that has a
visit()method for each element class. The
accept()method of an element class calls back the
visit()method for its class. Separate concrete
visitorclasses can then be written that perform some particular operations, by implementing these operations in their respective
One of these
visit()methods of a concrete
visitorcan be thought of as a method not of a single class, but rather a method of a pair of classes: the concrete visitor and the particular element class. Thus the visitor pattern simulates
double dispatchin a conventional single-dispatch object-orientedlanguage such as Java, Smalltalk, and C++. For an explanation of how double dispatch differs from function overloading, see Double dispatch is more than function overloading in the double dispatch article. In the Java language, two techniques have been documented which use reflection to simplify the mechanics of double dispatch simulation in the visitor pattern: [http://www.cs.ucla.edu/~palsberg/paper/compsac98.pdf getting rid of accept() methods] (the Walkabout variation), and [http://www.javaworld.com/javaworld/javatips/jw-javatip98.html getting rid of extra visit() methods] .
The visitor pattern also specifies how iteration occurs over the object structure. In the simplest version, where each algorithm needs to iterate in the same way, the
accept()method of a container element, in addition to calling back the
visit()method of the
visitor, also passes the
visitorobject to the
accept()method of all its constituent child elements.
Because the Visitor object has one principal function (manifested in a plurality of specialized methods) and that function is called
visit(), the Visitor can be readily identified as a potential
function objector functor. Likewise, the
accept()function can be identified as a function applicator, a mapper, which knows how to traverse a particular type of object and apply a function to its elements. Lisp's object system with its multiple dispatch does not replace the Visitor pattern, but merely provides a more concise implementation of it in which the pattern all but disappears.
Example in Java
The following example is an example in the Java programming language:
Example in C++
The following example is an example in the C++ programming language:
Aside from potentially improving
separation of concerns, the visitor pattern has an additional advantage over simply calling a polymorphic method: a visitor object can have state. This is extremely useful in many cases where the action performed on the object depends on previous such actions.
An example of this is a pretty-printer in a
programming languageimplementation (such as a compileror interpreter). Such a pretty-printer object (implemented as a visitor, in this example), will visit nodes in a data structure that represents a parsed and processed program. The pretty-printer will then generate a textual representation of the program tree. In order to make the representation human readable, the pretty-printer should properly indent program statements and expressions. The "current indentation level" can then be tracked by the visitor as its state, correctly applying encapsulation, whereas in a simple polymorphic method invocation, the indentation level would have to be exposed as a parameter and the caller would rely on the method implementation to use and propagate this parameter correctly.
Hierarchical visitor pattern
* [http://objectmentor.com/resources/articles/visitor.pdf The Visitor Family of Design Patterns] by Robert C. Martin - a rough chapter from "
The Principles, Patterns, and Practices of Agile Software Development", Robert C. Martin, Prentice Hall
* [http://www.lepus.org.uk/ref/companion/Visitor.xml Visitor pattern in UML and in LePUS3] (a Design Description Language)
*Article " [http://se.ethz.ch/~meyer/publications/computer/visitor.pdf Componentization: the Visitor Example] by
Bertrand Meyerand Karine Arnout, "Computer" (IEEE), vol. 39, no. 7, July 2006, pages 23-30.
*Article " [http://www.onjava.com/pub/a/onjava/2005/06/01/searchvisitor.html Domain Searching Using Visitors] " by
*Article " [http://codeproject.com/cpp/ConditionInterpreter.asp Parsing Conditions using Interpreter and Visitor Pattern] "
*Article [http://www.cs.bham.ac.uk/~hxt/research/mfps-visitors.pdf A Type-theoretic Reconstruction of the Visitor Pattern]
*Article " [http://citeseer.ist.psu.edu/palsberg97essence.html The Essence of the Visitor Pattern] " by
Jens Palsbergand C. Barry Jay. 1997 IEEE-CS COMPSAC paper showing that accept() methods are unnecessary when reflection is available; introduces term 'Walkabout' for the technique.
*Article " [http://www.polyglotinc.com/articles.html#reflectVisitor Eliminate accept() methods from your Visitor pattern] " by Bruce Wallace
*Article " [http://www.artima.com/cppsource/cooperative_visitor.html Cooperative Visitor: A Template Technique for Visitor Creation] " by
Anand Shankar Krishnamoorthi
* [http://goblin.colourcountry.net/apt1002/Visitor%20patterns Visitor Patterns] as a universal model of terminating computation.
* [http://www.oodesign.com/oo_design_patterns/behavioral_patterns/visitor_pattern.html Visitor Pattern] using reflection(java).
* [http://perfectjpattern.sourceforge.net/dp-visitor.html PerfectJPattern Open Source Project] , Provides a context-free and type-safe implementation of the Visitor Pattern in Java based on Delegates.
Wikimedia Foundation. 2010.