Forest::Tree::Indexer - An abstract role for tree indexers


Forest documentation Contained in the Forest distribution.

Index


Code Index:

NAME

Top

Forest::Tree::Indexer - An abstract role for tree indexers

DESCRIPTION

Top

This is an abstract role for tree writers.

ATTRIBUTES

Top

tree
index

get_tree_at ($key)
clear_index
get_index_keys

REQUIRED METHODS

Top

build_index

METHODS

Top

get_root

BUGS

Top

All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.

AUTHOR

Top

Stevan Little <stevan.little@iinteractive.com>

COPYRIGHT AND LICENSE

Top


Forest documentation Contained in the Forest distribution.

package Forest::Tree::Indexer;
use Moose::Role;
use MooseX::AttributeHelpers;

our $VERSION   = '0.09';
our $AUTHORITY = 'cpan:STEVAN';

has 'tree' => (
    is  => 'rw',
    isa => 'Forest::Tree::Pure',
);

has 'index' => (
    metaclass => 'Collection::Hash',
    is        => 'rw',
    isa       => 'HashRef[Forest::Tree::Pure]',
    lazy      => 1,
    default   => sub { {} },
    provides  => {
        'get'    => 'get_tree_at',
        'exists' => 'has_tree_at',
        'clear'  => 'clear_index',
        'keys'   => 'get_index_keys',
    }
);

requires 'build_index';

sub get_root { (shift)->tree }

no Moose::Role; 1;

__END__