1Tree::Simple::Visitor::UFsienrdBCyoNnotdreiVbaultueedT(r3Pe)eer:l:SDiomcpulmee:n:tVaitsiiotnor::FindByNodeValue(3)
2
3
4

NAME

6       Tree::Simple::Visitor::FindByNodeValue - A Visitor for finding an
7       element in a Tree::Simple hierarchy by node value
8

SYNOPSIS

10         use Tree::Simple::Visitor::FindByNodeValue;
11
12         # create a visitor object
13         my $visitor = Tree::Simple::Visitor::FindByNodeValue->new();
14
15         # set the search path for our tree
16         $visitor->searchForNodeValue("My Tree Node");
17
18         # pass the visitor to a tree
19         $tree->accept($visitor);
20
21         # fetch the result, which will
22         # be the Tree::Simple object that
23         # we have found, or undefined
24         my $result = $visitor->getResult() || die "No Tree found";
25

DESCRIPTION

27       Given a node value and Tree::Simple hierarchy, this Visitor will
28       attempt to find the node with the same node value.
29

METHODS

31       new There are no arguments to the constructor the object will be in its
32           default state. You can use the "setNodeFilter",
33           "setTraversalMethod", "includeTrunk" and "searchForNodeValue"
34           methods to customize its behavior.
35
36       includeTrunk ($boolean)
37           Based upon the value of $boolean, this will tell the visitor to
38           include the trunk of the tree in the search as well.
39
40       setTraversalMethod ($visitor)
41           By default we will use the Tree::Simple built in depth-first (pre-
42           order) traverse method. If however, you desire the tree to be
43           search in a different ordering, this can be accomplished using a
44           different traversal method, you can supply a $visitor object
45           implementing that traversal type to this method (See
46           Tree::Simple::Visitor::BreadthFirstTraversal,
47           Tree::Simple::Visitor::PreOrderTraversal and
48           Tree::Simple::Visitor::PostOrderTraversal).
49
50       searchForNodeValue ($node_value)
51           This is the node value we will attempt to find within the tree.
52
53       setNodeFilter ($filter_function)
54           This method accepts a CODE reference as its $filter_function
55           argument and throws an exception if it is not a code reference.
56           This code reference is used to further check the tree nodes as they
57           are searched and so can be used to customize search behavior. For
58           instance, you could to check against the node value as well as some
59           other criteria. The filter function should accept a single
60           argument, which is the current Tree::Simple object and return
61           either true (1) on success, or false (0) on failure.
62
63       visit ($tree)
64           This is the method that is used by the Tree::Simple "accept"
65           method. It can also be used on its own, it requires the $tree
66           argument to be a Tree::Simple object (or derived from a
67           Tree::Simple object), and will throw and exception otherwise.
68
69       getResult
70           This method will return the tree found with the specified node
71           value (set by the "searchForNodeValue" method) or "undef" if no
72           tree is found.
73

Repository

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

SUPPORT

78       Bugs should be reported via the CPAN bug tracker at
79
80       <https://github.com/ronsavage/Tree-Simple-VisitorFactory/issues>
81

CODE COVERAGE

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

SEE ALSO

87       These Visitor classes are all subclasses of Tree::Simple::Visitor,
88       which can be found in the Tree::Simple module, you should refer to that
89       module for more information.
90

AUTHOR

92       stevan little, <stevan@iinteractive.com>
93

95       Copyright 2004, 2005 by Infinity Interactive, Inc.
96
97       <http://www.iinteractive.com>
98
99       This library is free software; you can redistribute it and/or modify it
100       under the same terms as Perl itself.
101
102
103
104perl v5.38.0                      2023T-r0e7e-:2:1Simple::Visitor::FindByNodeValue(3)
Impressum