1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
#
# BioPerl module for Bio::Factory::DriverFactory
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Jason Stajich <jason@bioperl.org> and
# Hilmar Lapp <hlapp@gmx.net>
#
# Copyright Jason Stajich, Hilmar Lapp
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Factory::DriverFactory - Base class for factory classes loading drivers
=head1 SYNOPSIS
#this class is not instantiable
=head1 DESCRIPTION
This a base class for factory classes that load drivers. Normally, you don't
instantiate this class directly.
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this
and other Bioperl modules. Send your comments and suggestions preferably
to one of the Bioperl mailing lists.
Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
https://github.com/bioperl/bioperl-live/issues
=head1 AUTHOR - Jason Stajich
Email Jason Stajich E<lt>jason@bioperl.orgE<gt>
=head1 APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
=cut
#'
package Bio::Factory::DriverFactory;
use strict;
use File::Spec;
use vars qw(%DRIVERS);
use base qw(Bio::Root::Root);
BEGIN {
%DRIVERS = ();
}
sub new {
my ($class, @args) = @_;
my $self = $class->SUPER::new(@args);
return $self;
}
=head2 register_driver
Title : register_driver
Usage : $factory->register_driver("genscan", "Bio::Tools::Genscan");
Function: Registers a driver a factory class should be able to instantiate.
This method can be called both as an instance and as a class
method.
Returns :
Args : Key of the driver (string) and the module implementing the driver
(string).
=cut
sub register_driver {
my ($self, @args) = @_;
my %drivers = @args;
foreach my $drv (keys(%drivers)) {
# note that this doesn't care whether $self is the class or the object
$self->driver_table()->{$drv} = $drivers{$drv};
}
}
=head2 driver_table
Title : driver_table
Usage : $table = $factory->driver_table();
Function: Returns a reference to the hash table storing associations of
methods with drivers.
You use this table to look up registered methods (keys) and
drivers (values).
In this implementation the table is class-specific and therefore
shared by all instances. You can override this in a derived class,
but note that this method can be called both as an instance and a
class method.
This will be the table used by the object internally. You should
definitely know what you're doing if you modify the table's
contents. Modifications are shared by _all_ instances, those present
and those yet to be created.
Returns : A reference to a hash table.
Args :
=cut
sub driver_table {
my ($self, @args) = @_;
return \%DRIVERS;
}
=head2 get_driver
Title : get_driver
Usage : $module = $factory->get_driver("genscan");
Function: Returns the module implementing a driver registered under the
given key.
Example :
Returns : A string.
Args : Key of the driver (string).
=cut
sub get_driver {
my ($self, $key) = @_;
if(exists($self->driver_table()->{$key})) {
return $self->driver_table()->{$key};
}
return;
}
=head2 _load_module
Title : _load_module
Usage : $self->_load_module("Bio::Tools::Genscan");
Function: Loads up (like use) a module at run time on demand.
Example :
Returns : TRUE on success
Args :
=cut
sub _load_module {
my ($self, $name) = @_;
my ($module, $load, $m);
$module = "_<$name.pm";
return 1 if $main::{$module};
$load = "$name.pm";
$load = File::Spec->catfile((split(/::/,$load)));
eval {
require $load;
};
if ( $@ ) {
$self->throw("$load: $name cannot be found: ".$@);
}
return 1;
}
1;
|
