Ron Savage > Tree-Binary-1.06 > Tree::Binary::Visitor::Base

Download:
Tree-Binary-1.06.tgz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.06   Source  

NAME ^

Tree::Binary::Visitor::Base - A Visitor base class for Tree::Binary::Visitor::* objects

SYNOPSIS ^

  package MyTreeBinaryVisitor;
  
  use strict;
  use warnings;
  
  use Tree::Binary::Visitor::Base;
  
  our @ISA = qw(Tree::Binary::Visitor::Base); 
  
  sub visit {
      my ($self, $tree) = @_;
      # ... implement your visit method
  }
  
  1;

DESCRIPTION ^

This is a base class for Tree::Binary::Visitor objects. If you want to create your own visitor object, just subclass this and create a visit method.

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.

getNodeFilter

This method returns the CODE reference set with setNodeFilter argument.

clearNodeFilter

This method clears node filter field.

setNodeFilter ($filter_function)

This method accepts a CODE reference as its $filter_function argument. This code reference is used to filter the tree nodes as they are collected. This can be used to customize output, or to gather specific information from a more complex tree node. The filter function should accept a single argument, which is the current Tree::Binary object.

getResults

This method returns the accumulated results of the application of the node filter to the tree.

setResults

This method should not really be used outside of this class, as it just would not make any sense to. It is included in this class and in this documenation to facilitate subclassing of this class for your own needs. If you desire to clear the results, then you can simply call setResults with no argument.

visit ($tree)

This is an abstract method and if called will throw an exception. This is the only method required when creating your own custom Tree::Binary::Visitor object.

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 CODE COVERAGE section of Tree::Binary for details.

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.

syntax highlighting: