.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Tree::Simple::Visitor::Sort 3pm"
.TH Tree::Simple::Visitor::Sort 3pm "2005-07-14" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Tree::Simple::Visitor::Sort \- A Visitor for sorting a Tree::Simple object heirarchy
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Tree::Simple::Visitor::Sort;
\&  
\&  # create a visitor object
\&  my $visitor = Tree::Simple::Visitor::Sort\->new();
\&  
\&  $tree\->accept($visitor);
\&  # the tree is now sorted ascii\-betically
\&
\&  # set the sort function to 
\&  # use a numeric comparison
\&  $visitor\->setSortFunction($visitor\->NUMERIC);
\&  
\&  $tree\->accept($visitor);
\&  # the tree is now sorted numerically  
\&  
\&  # set a custom sort function
\&  $visitor\->setSortFunction(sub {
\&        my ($left, $right) = @_;
\&        lc($left\->getNodeValue()\->{name}) cmp lc($right\->getNodeValue()\->{name});
\&  });
\&  
\&  $tree\->accept($visitor);
\&  # the tree\*(Aqs node are now sorted appropriately
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This implements a recursive multi-level sort of a Tree::Simple heirarchy. I think this deserves some more explaination, and the best way to do that is visually.
.PP
Given the tree:
.PP
.Vb 10
\&    1
\&        1.3
\&        1.2
\&            1.2.2
\&            1.2.1
\&        1.1
\&    4
\&        4.1
\&    2
\&        2.1
\&    3
\&        3.3
\&        3.2
\&        3.1
.Ve
.PP
A normal sort would produce the following tree:
.PP
.Vb 10
\&    1
\&        1.1
\&        1.2
\&            1.2.1
\&            1.2.2
\&        1.3
\&    2
\&        2.1
\&    3
\&        3.1
\&        3.2
\&        3.3
\&    4
\&        4.1
.Ve
.PP
A sort using the built-in \s-1REVERSE\s0 sort function would produce the following tree:
.PP
.Vb 10
\&    4
\&        4.1         
\&    3
\&        3.3
\&        3.2
\&        3.1
\&    2
\&        2.1
\&    1
\&        1.3
\&        1.2
\&            1.2.2
\&            1.2.1
\&        1.1
.Ve
.PP
As you can see, no node is moved up or down from it's current depth, but sorted with it's siblings. Flexible customized sorting is possible within this framework, however, this cannot be used for tree-balancing or anything as complex as that.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
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 and \f(CW\*(C`setSortFunction\*(C'\fR methods to customize its behavior.
.IP "\fBincludeTrunk ($boolean)\fR" 4
.IX Item "includeTrunk ($boolean)"
Based upon the value of \f(CW$boolean\fR, this will tell the visitor to include the trunk of the tree in the sort as well.
.IP "\fBsetNodeFilter ($filter_function)\fR" 4
.IX Item "setNodeFilter ($filter_function)"
This method accepts a \s-1CODE\s0 reference as it's \f(CW$filter_function\fR 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 sorted. This can be used to gather specific information from a more complex tree node. The filter function should accept a single argument, which is the current Tree::Simple object.
.IP "\fBsetSortFunction ($sort_function)\fR" 4
.IX Item "setSortFunction ($sort_function)"
This method accepts a \s-1CODE\s0 reference as it's \f(CW$sort_function\fR argument and throws an exception if it is not a code reference.  The \f(CW$sort_function\fR is used by perl's builtin \f(CW\*(C`sort\*(C'\fR routine to sort each level of the tree. The \f(CW$sort_function\fR is passed two Tree::Simple objects, and must return 1 (greater than), 0 (equal to) or \-1 (less than). The sort function will override and bypass any node filters which have been applied (see \f(CW\*(C`setNodeFilter\*(C'\fR method above), they cannot be used together.
.Sp
Several pre-built sort functions are provided. All of these functions assume that calling \f(CW\*(C`getNodeValue\*(C'\fR on the Tree::Simple object will return a suitable sortable value.
.RS 4
.IP "\s-1REVERSE\s0" 4
.IX Item "REVERSE"
This is the reverse of the normal sort using \f(CW\*(C`cmp\*(C'\fR.
.IP "\s-1NUMERIC\s0" 4
.IX Item "NUMERIC"
This uses the numeric comparison operator \f(CW\*(C`<=>\*(C'\fR to sort.
.IP "\s-1REVERSE_NUMERIC\s0" 4
.IX Item "REVERSE_NUMERIC"
The reverse of the above.
.IP "\s-1ALPHABETICAL\s0" 4
.IX Item "ALPHABETICAL"
This lowercases the node value before using \f(CW\*(C`cmp\*(C'\fR to sort. This results in a true alphabetical sorting.
.IP "\s-1REVERSE_ALPHABETICAL\s0" 4
.IX Item "REVERSE_ALPHABETICAL"
The reverse of the above.
.RE
.RS 4
.Sp
If you need to implement one of these sorting routines, but need special handling of your Tree::Simple objects (such as would be done with a node filter), I suggest you read the source code and copy and modify your own sort routine. If it is requested enough I will provide this feature in future versions, but for now I am not sure there is a large need.
.RE
.IP "\fBvisit ($tree)\fR" 4
.IX Item "visit ($tree)"
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.
.Sp
It should be noted that this is a \fIdestructive\fR action, since the sort happens \fIin place\fR and does not produce a copy of the tree.
.SH "BUGS"
.IX Header "BUGS"
None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
.SH "CODE COVERAGE"
.IX Header "CODE COVERAGE"
See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
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.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.IP "Thanks to Vitor Mori for the idea and much of the code for this Visitor." 4
.IX Item "Thanks to Vitor Mori for the idea and much of the code for this Visitor."
.SH "AUTHORS"
.IX Header "AUTHORS"
Vitor Mori, <vvvv767@hotmail.com>
.PP
stevan little, <stevan@iinteractive.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2004, 2005 by Vitor Mori & Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.