GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TREE::SIMPLE::VISITOR::TONESTEDHASH (3)

.ds Aq ’

NAME

Tree::Simple::Visitor::ToNestedHash - A Visitor for creating nested hash trees from Tree::Simple objects.

CONTENTS

SYNOPSIS



  use Tree::Simple::Visitor::ToNestedHash;

  my $visitor = Tree::Simple::Visitor::ToNestedHash->new();

  # given this Tree::Simple tree
  my $tree = Tree::Simple->new("Root")
                ->addChildren(
                    Tree::Simple->new("Child1")
                        ->addChildren(
                            Tree::Simple->new("GrandChild1"),
                            Tree::Simple->new("GrandChild2")
                        ),
                    Tree::Simple->new("Child2"),
                );

  $tree->accept($visitor);

  my $array_tree = $visitor->getResults();

  # this then creates the equivalent nested array tree:
  # {
  # Root => {
  #         Child1 => {
  #                 GrandChild1 => {},
  #                 GrandChild2 => {}
  #                 },
  #         Child2 => {}
  #         }
  # }



DESCRIPTION

Given a tree constructed from a Tree::Simple hierarchy, this Visitor will create the equivalent tree of nested hashes.

METHODS

<B>newB> There are no arguments to the constructor the object will be in its default state. You can use the setNodeFilter and includTrunk methods to customize its behavior.
<B>includTrunk ($boolean)B> Setting the $boolean value to true (1) will cause the node value of the tree’s root to be included in the nested hash output, setting it to false will do the opposite.
<B>setNodeFilter ($filter_function)B> 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 placed into the hash tree. The $filter_function is passed a Tree::Simple object, and is expected to return the value desired for inclusion into the hash tree.
<B>visit ($tree)B> This is the method that is used by Tree::Simple’s 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.
<B>getResultsB> This method will return the hash tree constructed.

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.

CODE COVERAGE

See the <B>CODE COVERAGEB> section in Tree::Simple::VisitorFactory for more information.

SEE ALSO

These Visitor classes are all subclasses of <B>Tree::Simple::VisitorB>, which can be found in the <B>Tree::SimpleB> module, you should refer to that module for more information.

AUTHOR

stevan little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Copyright 2004, 2005 by Infinity Interactive, Inc.

<http://www.iinteractive.com>

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TREE::SIMPLE::VISITOR::TONESTEDHASH (3) 2013-10-31

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.