File Coverage

blib/lib/DBM/Deep/Iterator/File/Index.pm
Criterion Covered Total %
statement 19 19 100.0
branch 2 2 100.0
condition n/a
subroutine 6 6 100.0
pod 3 3 100.0
total 30 30 100.0


line stmt bran cond sub pod time code
1             package DBM::Deep::Iterator::File::Index;
2              
3 23     23   415 use 5.008_004;
  23         80  
4              
5 23     23   135 use strict;
  23         45  
  23         701  
6 23     23   138 use warnings FATAL => 'all';
  23         46  
  23         5180  
7              
8             =head1 NAME
9              
10             DBM::Deep::Iterator::Index - mediate between DBM::Deep::Iterator and DBM::Deep::Engine::Sector::Index
11              
12             =head1 PURPOSE
13              
14             This is an internal-use-only object for L. It acts as the mediator
15             between the L object and a L
16             sector.
17              
18             =head1 OVERVIEW
19              
20             This object, despite the implied class hierarchy, does B inherit from
21             L. Instead, it delegates to it, essentially acting as a
22             facade over it. L will instantiate one of
23             these objects as needed to handle an Index sector.
24              
25             =head1 METHODS
26              
27             =head2 new(\%params)
28              
29             The constructor takes a hashref of params and blesses it into the invoking class. The
30             hashref is assumed to have the following elements:
31              
32             =over 4
33              
34             =item * iterator (of type L
35              
36             =item * sector (of type L
37              
38             =back
39              
40             =cut
41              
42             sub new {
43 15     15 1 36 my $self = bless $_[1] => $_[0];
44 15         45 $self->{curr_index} = 0;
45 15         68 return $self;
46             }
47              
48             =head2 at_end()
49              
50             This takes no arguments.
51              
52             This returns true/false indicating whether this sector has any more elements that can be
53             iterated over.
54              
55             =cut
56              
57             sub at_end {
58 4080     4080 1 6268 my $self = shift;
59 4080         11463 return $self->{curr_index} >= $self->{iterator}{engine}->hash_chars;
60             }
61              
62             =head2 get_next_iterator()
63              
64             This takes no arguments.
65              
66             This returns an iterator (built by L) based
67             on the sector pointed to by the next occupied location in this index.
68              
69             If the sector is exhausted, it returns nothing.
70              
71             =cut
72              
73             sub get_next_iterator {
74 210     210 1 341 my $self = shift;
75              
76 210         301 my $loc;
77 210         438 while ( !$loc ) {
78 3855 100       8634 return if $self->at_end;
79 3840         11520 $loc = $self->{sector}->get_entry( $self->{curr_index}++ );
80             }
81              
82 195         689 return $self->{iterator}->get_sector_iterator( $loc );
83             }
84              
85             1;
86             __END__