The rest of the documentation details each of the object methods. Internal methods are usually preceded
with a _
start_result
Title : start_result
Usage : $handler->start_result($data)
Function: Begins a result event cycle
Returns : none
Args : Type of Result
end_result
Title : end_result
Usage : $handler->end_result($data)
Function: Ends 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
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::EventHandlerImethodswill_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
SAXmethods
See Bio::Event::EventHandlerI for the additional SAX methods.
perl v5.32.1 2021-08-15 Bio::SearchIO::EventHandlerI(3pm)