NAME

Tree::Simple::Visitor::VariableDepthClone - A Visitor for cloning parts of Tree::Simple hierarchy

SYNOPSIS

  use Tree::Simple::Visitor::VariableDepthClone;

  # create an visitor
  my $visitor = Tree::Simple::Visitor::VariableDepthClone->new();

  $visitor->setCloneDepth(3);

  # pass our visitor to the tree
  $tree->accept($visitor);

  my $partial_tree = $visitor->getClone();

DESCRIPTION

This visitor will clone

METHODS

new: There are no arguments to the constructor the object will be in its default state. You can use the "setNodeFilter" method to customize its behavior.
includeTrunk ($boolean): Based upon the value of $boolean, this will tell the visitor to include the trunk of the tree in the traversal as well. This basically means it will clone the root node as well.
setCloneDepth ($number)
setNodeFilter ($filter_function): This method accepts a CODE reference as its $filter_function argument and throws an exception if it is not a code reference. This code reference is used to filter the tree nodes as they are cloned.
visit ($tree): This is the method that is used by the Tree::Simple "accept" method. It can also be used on its own, it requires the $tree argument to be a Tree::Simple object (or derived from a Tree::Simple object), and will throw and exception otherwise.
getClone: This method returns the cloned partial tree.

Repository

<https://github.com/ronsavage/Tree-Simple-VisitorFactory>

SUPPORT

Bugs should be reported via the CPAN bug tracker at

<https://github.com/ronsavage/Tree-Simple-VisitorFactory/issues>

CODE COVERAGE

See the CODE COVERAGE section in Tree::Simple::VisitorFactory for more information.

AUTHOR

stevan little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.