Bio::Factory
DriverFactory
Toolbar
Summary
Bio::Factory::DriverFactory - Base class for factory classes loading drivers
Package variables
No package variables defined.
Included modules
Inherit
Synopsis
#this class is not instantiable
Description
This a base class for factory classes that load drivers. Normally, you don't
instantiate this class directly.
Methods
Methods description
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 : |
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 : |
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). |
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). |
Methods code
sub _load_module
{ my ($self, $name) = @_;
my ($module, $load, $m);
$module = "_<$name.pm";
return 1 if $main::{$module};
$load = "$name.pm";
my $io = new Bio::Root::IO();
$load = $io->catfile((split(/::/,$load)));
eval {
require $load;
};
if ( $@ ) {
$self->throw("$load: $name cannot be found: ".$@);
}
return 1;
}
1; } |
sub driver_table
{ my ($self, @args) = @_;
return\% DRIVERS; } |
sub get_driver
{ my ($self, $key) = @_;
if(exists($self->driver_table()->{$key})) {
return $self->driver_table()->{$key};
}
return undef; } |
sub new
{ my ($class, @args) = @_;
my $self = $class->SUPER::new(@args);
return $self; } |
sub register_driver
{ my ($self, @args) = @_;
my %drivers = @args;
foreach my $drv (keys(%drivers)) {
$self->driver_table()->{$drv} = $drivers{$drv};
} } |
General documentation
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://bio.perl.org/MailList.html - About the mailing lists
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via email
or the web:
bioperl-bugs@bio.perl.org
http://bugzilla.bioperl.org/
AUTHOR - Jason Stajich | Top |
Email Jason Stajich <jason@bioperl.org>
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _