local-lib5/man/man3/Tree::Simple::Visitor::FindByUID.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Tree::Simple::Visitor::FindByUID 3"
 132 .TH Tree::Simple::Visitor::FindByUID 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Tree::Simple::Visitor::FindByUID \- A Visitor for finding an element in a Tree::Simple hierarchy by UID
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use Tree::Simple::Visitor::FindByUID;
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \&  # create a visitor object
 143 \&  my $visitor = Tree::Simple::Visitor::FindByUID\->new();
 144 .Ve
 145 .PP
 146 .Vb 2
 147 \&  # set the search path for our tree
 148 \&  $visitor\->searchForUID("MyTreeUID");
 149 .Ve
 150 .PP
 151 .Vb 2
 152 \&  # pass the visitor to a tree
 153 \&  $tree\->accept($visitor);
 154 .Ve
 155 .PP
 156 .Vb 4
 157 \&  # fetch the result, which will
 158 \&  # be the Tree::Simple object that
 159 \&  # we have found, or undefined
 160 \&  my $result = $visitor\->getResult() || die "No Tree found";
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 Given a \s-1UID\s0 and Tree::Simple hierarchy, this Visitor will attempt to find the node with the same \s-1UID\s0.
 165 .SH "METHODS"
 166 .IX Header "METHODS"
 167 .IP "\fBnew\fR" 4
 168 .IX Item "new"
 169 There are no arguments to the constructor the object will be in its default state. You can use the \f(CW\*(C`setNodeFilter\*(C'\fR, \f(CW\*(C`setTraversalMethod\*(C'\fR, \f(CW\*(C`includeTrunk\*(C'\fR and \f(CW\*(C`searchForUID\*(C'\fR methods to customize its behavior.
 170 .IP "\fBincludeTrunk ($boolean)\fR" 4
 171 .IX Item "includeTrunk ($boolean)"
 172 Based upon the value of \f(CW$boolean\fR, this will tell the visitor to include the trunk of the tree in the search as well.
 173 .IP "\fBsetTraversalMethod ($visitor)\fR" 4
 174 .IX Item "setTraversalMethod ($visitor)"
 175 By default we will use Tree::Simple's built in depth-first (pre\-order) traverse method. If however, you desire the tree to be search in a different ordering, this can be accomplished using a different traversal method, you can supply a \f(CW$visitor\fR object implementing that traversal type to this method (See  \fBTree::Simple::Visitor::BreadthFirstTraversal\fR, \fBTree::Simple::Visitor::PreOrderTraversal\fR and \fBTree::Simple::Visitor::PostOrderTraversal\fR).
 176 .IP "\fBsearchForUID ($UID)\fR" 4
 177 .IX Item "searchForUID ($UID)"
 178 This is the \s-1UID\s0 we will attempt to find within the tree.
 179 .IP "\fBsetNodeFilter ($filter_function)\fR" 4
 180 .IX Item "setNodeFilter ($filter_function)"
 181 This method accepts a \s-1CODE\s0 reference as its \f(CW$filter_function\fR argument and throws an exception if it is not a code reference. This code reference is used to further check the tree nodes as they are searched and so can be used to customize search behavior. For instance, you could to check against the \s-1UID\s0 as well as some other criteria. The filter function should accept a single argument, which is the current Tree::Simple object and return either true (\f(CW1\fR) on success, or false (\f(CW0\fR) on failure.
 182 .IP "\fBvisit ($tree)\fR" 4
 183 .IX Item "visit ($tree)"
 184 This is the method that is used by Tree::Simple's \f(CW\*(C`accept\*(C'\fR method. It can also be used on its own, it requires the \f(CW$tree\fR argument to be a Tree::Simple object (or derived from a Tree::Simple object), and will throw and exception otherwise.
 185 .IP "\fBgetResult\fR" 4
 186 .IX Item "getResult"
 187 This method will return the tree found with the specified \s-1UID\s0 (set by the \f(CW\*(C`searchForUID\*(C'\fR method) or \f(CW\*(C`undef\*(C'\fR if no tree is found.
 188 .SH "BUGS"
 189 .IX Header "BUGS"
 190 None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
 191 .SH "CODE COVERAGE"
 192 .IX Header "CODE COVERAGE"
 193 See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
 194 .SH "SEE ALSO"
 195 .IX Header "SEE ALSO"
 196 These Visitor classes are all subclasses of \fBTree::Simple::Visitor\fR, which can be found in the \fBTree::Simple\fR module, you should refer to that module for more information.
 197 .SH "ACKNOWLEDGEMENTS"
 198 .IX Header "ACKNOWLEDGEMENTS"
 199 .IP "Thanks to Vitor Mori for the idea for this Visitor." 4
 200 .IX Item "Thanks to Vitor Mori for the idea for this Visitor."
 201 .SH "AUTHOR"
 202 .IX Header "AUTHOR"
 203 stevan little, <stevan@iinteractive.com>
 204 .SH "COPYRIGHT AND LICENSE"
 205 .IX Header "COPYRIGHT AND LICENSE"
 206 Copyright 2004, 2005 by Infinity Interactive, Inc.
 207 .PP
 208 <http://www.iinteractive.com>
 209 .PP
 210 This library is free software; you can redistribute it and/or modify
 211 it under the same terms as Perl itself.