Bio::Factory::DriverFactory(3pm) User Contributed Perl Documentation Bio::Factory::DriverFactory(3pm)
NAME
Bio::Factory::DriverFactory - Base class for factory classes loading drivers
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.
FEEDBACK
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
Support
Please direct usage questions or support issues to the mailing list:
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.
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://redmine.open-bio.org/projects/bioperl/
AUTHOR - Jason Stajich
Email Jason Stajich <jason@bioperl.org>
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
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).
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 :
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).
_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 :
perl v5.14.2 2012-03-02 Bio::Factory::DriverFactory(3pm)