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