Bio::S...ndlerI(3pm)

💖 NAME 💖

Bio::SearchIO::EventHandlerI — an abstract Event Handler for Search Result parsing 🎀

So this is Bio::SearchIO::EventHandlerI(3pm), a piece of the User Contributed Perl Documentation, and bestie… it's an interface. That means it's the vibe, the blueprint, the concept, not the thing you actually run. 🦋

---

✨ SYNOPSIS ✨

Okay so real talk: do NOT use this object directly, it is an interface. It's giving "abstract base class" and it is not the moment for instantiation. 🙈

# do not use this object directly it is an interface # See
Bio::SearchIO::SearchResultEventBuilder for an implementation

    use Bio::SearchIO::SearchResultEventBuilder;
    my $handler = Bio::SearchIO::SearchResultEventBuilder->new();

See how we used Bio::SearchIO::SearchResultEventBuilder instead? That's the whole point, iykyk. 💅

---

🌸 DESCRIPTION 🌸

This interface lays out the basic methods you need to handle Events that get thrown while parsing a Search Result. We're talking FASTA, BLAST, or HMMer. It's the contract, the ground rules, the "here's what any handler has to be able to do" energy. 👑

---

📬 FEEDBACK 📬

💌 Mailing Lists 💌

User feedback is an integral part of the evolution of this and other Bioperl modules — literally, it's the glow-up fuel. Send your comments and suggestions preferably to the Bioperl mailing list. 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. Real talk: there are many experienced and reponsive experts who will be able look at the problem and quickly address it. If at all possible, please include a thorough description of the problem with code and data examples. The more deets, the better the fix. 🧚

🐛 Reporting Bugs 🐛

Report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution. Bug reports can be submitted via the web:

https://github.com/bioperl/bioperl-live/issues

---

👑 AUTHOR - Jason Stajich 👑

Email jason-at-bioperl.org — shoutout to the legend himself. ⭐

---

📖 APPENDIX 📖

The rest of the documentation goes into the details of each object method. Heads up: internal methods are usually preceded with a _. 🔍

start_result

• Title: start_result
• Usage: $handler->start_result($data)
• Function: Kicks off a result event cycle ✨
• Returns: none
• Args: Type of Result

end_result

• Title: end_result
• Usage: $handler->end_result($data)
• Function: Wraps up a result event cycle 🎀
• Returns: Bio::Search::Result::ResultI object
• Args: none

start_hsp

• Title: start_hsp
• Usage: $handler->start_hsp($data)
• Function: Start a HSP event cycle 💫
• Returns: none
• Args: type of element associated hashref

end_hsp

• Title: end_hsp
• Usage: $handler->end_hsp()
• Function: Ends a HSP event cycle 🌈
• Returns: Bio::Search::HSP::HSPI object
• Args: type of event and associated hashref

start_hit

• Title: start_hit
• Usage: $handler->start_hit()
• Function: Starts a Hit event cycle 🔥
• Returns: none
• Args: type of event and associated hashref

end_hit

• Title: end_hit
• Usage: $handler->end_hit()
• Function: Ends a Hit event cycle 🦋
• Returns: Bio::Search::Hit::HitI object
• Args: type of event and associated hashref

start_iteration

• Title: start_iteration
• Usage: $handler->start_iteration()
• Function: Starts an Iteration event cycle ⭐
• Returns: none
• Args: type of event and associated hashref

end_iteration

• Title: end_iteration
• Usage: $handler->end_iteration()
• Function: Ends an Iterationevent cycle (yes, we're keeping the typo, it's part of the lore) 💜
• Returns: Bio::Search::Iteration::IterationI object
• Args: type of event and associated hashref

register_factory

• Title: register_factory
• Usage: $handler->register_factory('TYPE',$factory);
• Function: Register a specific factory for a object type class 🏭
• Returns: none
• Args: string representing the class and Bio::Factory::ObjectFactoryI

See Bio::Factory::ObjectFactoryI for more information. 📚

factory

• Title: factory
• Usage: my $f = $handler->factory('TYPE');
• Function: Retrieves the associated factory for requested 'TYPE' 🔎
• Returns: a Bio::Factory::ObjectFactoryI
• Throws: Bio::Root::BadParameter if none registered for the supplied type
• Args: name of factory class to retrieve

See Bio::Factory::ObjectFactoryI for more information. 📚

---

🎧 Bio::Event::EventHandlerI methods 🎧

will_handle

• Title: will_handle
• Usage: if( $handler->will_handle($event_type) ) { ... }
• Function: Tests if this event builder knows how to process a specific event 🤔
• Returns: boolean
• Args: event type name

---

🎷 SAX methods 🎷

See Bio::Event::EventHandlerI for the additional SAX methods. That's where the rest of the sauce lives. 💅

---

okay bestie that's the whole page, no cap. This was Bio::SearchIO::EventHandlerI(3pm) from perl v5.32.1, dated 2021-08-15, filed under User Contributed Perl Documentation. Go forth and implement the interface, you absolute main character. 🌟💖🦋