Bio::F...Factory(3pm)

💖 Bio::F...Factory(3pm) 💖

okay bestie, welcome to the Bio::F...Factory page — that's the manual for this module, and yes the name is literally abbreviated like that in the header, we don't make the rules, we just vibe with them 🫶

---

✨ NAME ✨

Bio::Factory::DriverFactory — the base class for factory classes that load drivers. it's giving "template", it's giving "blueprint", it's giving you don't use me directly, bestie 💅

---

🌸 SYNOPSIS 🌸

#this class is not instantiable

periodt. that's the whole synopsis. it's short, it's iconic, it said what it said 🎀

---

🦋 DESCRIPTION 🦋

so this is a base class for factory classes that load drivers. that's the whole job description. normally you do not instantiate this class directly — it's the ancestor, the parent friend, the one who stays home while the subclasses go out and do stuff ✨

---

🌈 FEEDBACK 🌈

💌 Mailing Lists

user feedback is an integral part of the evolution of this and other Bioperl modules, fr fr. 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 and 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 — the more deets, the faster the slay 🔥

🐛 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

no cap, they do want your bug reports. that's the whole point of the tracking system, bestie 💀✨

---

👑 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 _ (iykyk, the underscore is the "don't touch me" signal 🙈)

---

🌟 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).

so it registers a driver that a factory class should be able to instantiate. it can be called both as an instance and as a class method — flexible queen 💅. it takes the key of the driver (a string) and the module implementing the driver (also a string). no returns, it just does the thing 🎀

---

🌸 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    :

returns a reference to the hash table storing associations of methods with drivers. you use this table to look up registered methods (the keys) and drivers (the 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 as a class method.

this will be the table used by the object internally.

⚠️ bestie listen: 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. that's not a vibe check, that's a warning. one wrong edit and everybody feels it 💀

returns: a reference to a hash table. args: (nothing, it's chill) 🍓

---

✨ 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).

hands you back the module implementing a driver registered under the given key. returns a string, takes the key of the driver (a string). simple, clean, slay 💅

---

🧚 _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    :

loads up (like use) a module at run time on demand — the "we'll deal with it when we get there" method, main character energy fr fr ✨ returns TRUE on success. args: none. also note the leading _, so you know it's an internal method 🙈

---

and that's the whole page bestie, you ate it, you understood it, iconic behavior 💖

sign-off time: this was perl v5.32.1, dated 2021-08-15, from the User Contributed Perl Documentation — go forth and register those drivers responsibly 🎀💜