File Coverage

Bio/Factory/MapFactoryI.pm
Criterion Covered Total %
statement 6 10 60.0
branch n/a
condition n/a
subroutine 2 4 50.0
pod 2 2 100.0
total 10 16 62.5


line stmt bran cond sub pod time code
1             #
2             # BioPerl module for Bio::Factory::MapFactoryI
3             #
4             # Please direct questions and support issues to
5             #
6             # Cared for by Jason Stajich
7             #
8             # Copyright Jason Stajich
9             #
10             # You may distribute this module under the same terms as perl itself
11              
12             # POD documentation - main docs before the code
13              
14             =head1 NAME
15              
16             Bio::Factory::MapFactoryI - A Factory for getting markers
17              
18             =head1 SYNOPSIS
19              
20             # get a Map Factory somehow likely from Bio::MapIO system
21              
22             while( my $map = $mapin->next_map ) {
23             print "map name is ", $map->name, " length is ",
24             $map->length, " ", $map->units, "\n";
25             $mapout->write_map($map);
26             }
27              
28             =head1 DESCRIPTION
29              
30             This interface describes the necessary minimum methods for getting
31             Maps from a data stream. It also supports writing Map data back to a
32             stream.
33              
34             =head1 FEEDBACK
35              
36             =head2 Mailing Lists
37              
38             User feedback is an integral part of the evolution of this and other
39             Bioperl modules. Send your comments and suggestions preferably to
40             the Bioperl mailing list. Your participation is much appreciated.
41              
42             bioperl-l@bioperl.org - General discussion
43             http://bioperl.org/wiki/Mailing_lists - About the mailing lists
44              
45             =head2 Support
46              
47             Please direct usage questions or support issues to the mailing list:
48              
49             I
50              
51             rather than to the module maintainer directly. Many experienced and
52             reponsive experts will be able look at the problem and quickly
53             address it. Please include a thorough description of the problem
54             with code and data examples if at all possible.
55              
56             =head2 Reporting Bugs
57              
58             Report bugs to the Bioperl bug tracking system to help us keep track
59             of the bugs and their resolution. Bug reports can be submitted via the
60             web:
61              
62             https://github.com/bioperl/bioperl-live/issues
63              
64             =head1 AUTHOR - Jason Stajich
65              
66             Email jason@bioperl.org
67              
68             =head1 APPENDIX
69              
70             The rest of the documentation details each of the object methods.
71             Internal methods are usually preceded with a _
72              
73             =cut
74              
75              
76             # Let the code begin...
77              
78              
79             package Bio::Factory::MapFactoryI;
80 2     2   19 use strict;
  2         5  
  2         74  
81              
82 2     2   13 use base qw(Bio::Root::RootI);
  2         5  
  2         294  
83              
84             =head2 next_map
85              
86             Title : next_map
87             Usage : my $map = $factory->next_map;
88             Function: Get a map from the factory
89             Returns : L
90             Args : none
91              
92             =cut
93              
94             sub next_map{
95 0     0 1   my ($self,@args) = @_;
96 0           $self->throw_not_implemented();
97             }
98              
99             =head2 write_map
100              
101             Title : write_map
102             Usage : $factory->write_map($map);
103             Function: Write a map out through the factory
104             Returns : none
105             Args : L
106              
107             =cut
108              
109             sub write_map{
110 0     0 1   my ($self,@args) = @_;
111 0           $self->throw_not_implemented();
112             }
113              
114             1;