Bio::Event::EventHandlUser3Contributed Perl DocumeBio::Event::EventHandlerI(3) NAME Bio::Event::EventHandlerI - An Event Handler Interface SYNOPSIS # do not use this module directly # See Bio::SearchIO::SearchResultEventHandler for an example of # implementation. DESCRIPTION This interface describes the basic methods required for EventHandlers. These are essentially SAX methods. 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 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. 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 of the bugs and their resolution. Bug reports can be submitted via the web: http://bugzilla.open-bio.org/ AUTHOR - Jason Stajich Email jason@bioperl.org APPENDIX The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ 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 start_document Title : start_document Usage : $eventgenerator->start_document(); Function: Handle a start document event Returns : none Args : none end_document Title : end_document Usage : $eventgenerator->end_document(); Function: Handle an end document event Returns : none Args : none start_element Title : start_element Usage : $eventgenerator->start_element Function: Handles a start element event Returns : none Args : hashref with at least 2 keys 'Data' and 'Name' end_element Title : start_element Usage : $eventgenerator->end_element Function: Handles an end element event Returns : none Args : hashref with at least 2 keys 'Data' and 'Name' in_element Title : in_element Usage : if( $eventgenerator->in_element($element) ) {} Function: Test if we are in a particular element This is different than 'within' because 'in' tests only if one has reached a specific element. Returns : boolean Args : string element name within_element Title : within_element Usage : if( $eventgenerator->within_element($element) ) {} Function: Test if we are within a particular element This is different than 'in' because within can be tested for a whole block. Returns : boolean Args : string element name characters Title : characters Usage : $eventgenerator->characters($str) Function: Send a character events Returns : none Args : string perl v5.14.1 2011-07-22 Bio::Event::EventHandlerI(3)[top]
Vote for polarhome |