Посетитель на R

Паттерны проектирования / Поведенческие паттерны

# Elements
setClass("Element", representation("VIRTUAL"))
setClass("Engine", contains = "Element")
setClass("Wheel", contains = "Element",
         slots = c(number = "numeric"))
setClass("Car", contains = "Element",
         slots = c(items = "list"))

# Visitors
setClass("Visitor", representation("VIRTUAL"))
setClass("TestVisitor", contains = "Visitor")
setClass("RepairVisitor", contains = "Visitor")

# The method is chosen by the classes of both
# arguments: no accept() in the elements
setGeneric("visit", function(v, e) {
  standardGeneric("visit")
})
# [1] "visit"

setMethod("visit", c("TestVisitor", "Engine"),
          function(v, e) cat("test engine\n"))
setMethod("visit", c("TestVisitor", "Wheel"),
          function(v, e) {
            cat("test wheel #", e@number, "\n",
                sep = "")
          })
setMethod("visit", c("TestVisitor", "Car"),
          function(v, e) cat("test car\n"))
setMethod("visit", c("RepairVisitor", "Engine"),
          function(v, e) cat("repair engine\n"))
setMethod("visit", c("RepairVisitor", "Wheel"),
          function(v, e) {
            cat("repair wheel #", e@number, "\n",
                sep = "")
          })
setMethod("visit", c("RepairVisitor", "Car"),
          function(v, e) cat("repair car\n"))

# The car walks its parts, then itself
visit_car <- function(car, v) {
  for (item in c(car@items, car)) visit(v, item)
}

# Client
wheels <- lapply(1:4, function(n) {
  new("Wheel", number = n)
})
engine <- new("Engine")
car <- new("Car", items = c(list(engine), wheels))
visit_car(car, new("TestVisitor"))
visit_car(car, new("RepairVisitor"))

Представляет операцию, которую надо выполнить над элементами объекта. Позволяет определить новую операцию, не меняя классы элементов, к которым он применяется.

Задача. Документ состоит из абзацев, картинок и таблиц. Программа должна выгружать его, считать в нём слова и проверять орфографию. Если каждую операцию добавлять методом в каждый вид части, классы частей растут с каждой новой операцией. К тому же код одной операции расползается по многим классам.

Идея. Каждая операция становится отдельным объектом - посетителем. У посетителя по методу на каждый вид элемента. У каждого элемента есть один метод, который принимает посетителя и вызывает его метод для своего вида. Так для каждой пары «элемент и операция» выполняется нужный код, без проверок типа. Чтобы добавить новую операцию, пишут нового посетителя, а классы элементов не меняются.

Как читать пример. Элементы бывают нескольких видов. Каждый конкретный посетитель - одна операция, с отдельным методом на каждый вид элемента. Клиентский код отдаёт посетителя элементам, и каждый элемент направляет его в метод для своего вида. В большинстве примеров один элемент содержит остальные и отдаёт посетителя каждой своей части. Затем два посетителя проходят по одним и тем же частям, каждый со своей операцией. В некоторых языках элементы - обычные данные с меткой типа, а посетитель - одна функция с вариантом для каждого вида.

Когда применять. Посетитель нужен, когда набор классов элементов устойчив, а новые операции над ними появляются часто. Если часто добавляются новые виды элементов, он не годится: каждый новый вид требует нового метода в каждом посетителе.

Частая ошибка. Проверять тип элемента условиями внутри одного общего метода посетителя. Тогда новый вид элемента пропускается без всякого предупреждения. У каждого вида должен быть свой метод.