Bio::D...tainerI(3pm)

💖 Bio::DBLinkContainerI 💖

okay so bestie, welcome to the manual page for Bio::DBLinkContainerI — part of the User Contributed Perl Documentation over in Bioperl land. It's a 3pm page, which means it's Perl module docs, which means we're reading vibes and API contracts at the same time. iconic honestly ✨

---

🌸 NAME 🌸

Bio::DBLinkContainerI — the abstract interface for any object that wants to use database cross references. 🦋

Lowkey it's giving "rules of the club" energy: it tells you what you can call, not how it works under the hood.

---

✨ SYNOPSIS ✨

So here's the vibe — you're grabbing objects that contain database cross references, and you check first whether each one is even playing that game:

    # get an objects containing database cross reference

        foreach $obj ( @objs ) {
                if( $obj->isa('Bio::DBLinkContainerI') ) {
                        foreach $dblink ( $obj->each_DBLink() ) {
                                # do stuff
                        }
                }
        }

See that isa check? That's the vibe check fr fr. Only the objects that claim this interface get their each_DBLink() looped over. 💅

---

💜 DESCRIPTION 💜

This interface defines the functions you can expect from any object that wants to use database cross-references. Big important thing: this class does not actually provide any implementation. Like, at all. It just provides the definitions of what methods one can call. It's the blueprint, not the building. 🎀

The database cross-references themselves are implemented as Bio::Annotation::DBLink objects. So that's the little object you'll be holding when you call the method below. 🫶

---

🦋 FEEDBACK 🦋

💌 Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. No cap, your thoughts matter here. 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. Not me @-ing the maintainer in the group chat when the whole server exists. 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. Receipts, bestie — bring the receipts. 📎

🐛 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

It's giving "we see you, we fix it, we move on". 💅

---

👑 AUTHOR - Heikki Lehvaslaiho 👑

Email: heikki-at-bioperl-dot-org

Shoutout to the author, absolute main character energy. 🌟

---

📖 APPENDIX 📖

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ — so if you see an underscore, that's the secret menu, iykyk. 🙈

🍓 each_DBLink

 Title   : each_DBLink
 Usage   : foreach $ref ( $self->each_DBlink() )
 Function: gets an array of DBlink of objects
 Example :
 Returns : an array of Bio::Annotation::DBLink objects
 Args    : none

So: give it no args, get back an array of Bio::Annotation::DBLink objects, loop away. That's the whole thing and honestly? Slay. ✨ The Example slot is empty, so no extra crumbs there — don't come for me, I'm just the messenger. 😭

---

And that's the whole page, bestie! Mwah 💋 This little legend comes to you from perl v5.32.1, dated 2021-08-15, under the name Bio::D...tainerI(3pm) — yes the header truncates it like that, we don't question the vibes, we just cite them. Byeee 🎀💖✨