.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::SearchIO::EventHandlerI 3pm"
.TH Bio::SearchIO::EventHandlerI 3pm "2020-10-28" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bio::SearchIO::EventHandlerI \- An abstract Event Handler for Search Result parsing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
# do not use this object directly it is an interface
# See Bio::SearchIO::SearchResultEventBuilder for an implementation
.PP
.Vb 2
\&    use Bio::SearchIO::SearchResultEventBuilder;
\&    my $handler = Bio::SearchIO::SearchResultEventBuilder\->new();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This interface describes the basic methods needed to handle Events
thrown from parsing a Search Result such as \s-1FASTA, BLAST,\s0 or HMMer.
.SH "FEEDBACK"
.IX Header "FEEDBACK"
.SS "Mailing Lists"
.IX Subsection "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.
.PP
.Vb 2
\&  bioperl\-l@bioperl.org                  \- General discussion
\&  http://bioperl.org/wiki/Mailing_lists  \- About the mailing lists
.Ve
.SS "Support"
.IX Subsection "Support"
Please direct usage questions or support issues to the mailing list:
.PP
\&\fIbioperl\-l@bioperl.org\fR
.PP
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.
.SS "Reporting Bugs"
.IX Subsection "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:
.PP
.Vb 1
\&  https://github.com/bioperl/bioperl\-live/issues
.Ve
.SH "AUTHOR \- Jason Stajich"
.IX Header "AUTHOR - Jason Stajich"
Email jason\-at\-bioperl.org
.SH "APPENDIX"
.IX Header "APPENDIX"
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
.SS "start_result"
.IX Subsection "start_result"
.Vb 5
\& Title   : start_result
\& Usage   : $handler\->start_result($data)
\& Function: Begins a result event cycle
\& Returns : none 
\& Args    : Type of Result
.Ve
.SS "end_result"
.IX Subsection "end_result"
.Vb 5
\& Title   : end_result
\& Usage   : $handler\->end_result($data)
\& Function: Ends a result event cycle
\& Returns : Bio::Search::Result::ResultI object
\& Args    : none
.Ve
.SS "start_hsp"
.IX Subsection "start_hsp"
.Vb 6
\& Title   : start_hsp
\& Usage   : $handler\->start_hsp($data)
\& Function: Start a HSP event cycle
\& Returns : none
\& Args    : type of element
\&           associated hashref
.Ve
.SS "end_hsp"
.IX Subsection "end_hsp"
.Vb 5
\& 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
.Ve
.SS "start_hit"
.IX Subsection "start_hit"
.Vb 5
\& Title   : start_hit
\& Usage   : $handler\->start_hit()
\& Function: Starts a Hit event cycle
\& Returns : none
\& Args    : type of event and associated hashref
.Ve
.SS "end_hit"
.IX Subsection "end_hit"
.Vb 5
\& 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
.Ve
.SS "start_iteration"
.IX Subsection "start_iteration"
.Vb 5
\& Title   : start_iteration
\& Usage   : $handler\->start_iteration()
\& Function: Starts an Iteration event cycle
\& Returns : none
\& Args    : type of event and associated hashref
.Ve
.SS "end_iteration"
.IX Subsection "end_iteration"
.Vb 5
\& 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
.Ve
.SS "register_factory"
.IX Subsection "register_factory"
.Vb 6
\& Title   : register_factory
\& Usage   : $handler\->register_factory(\*(AqTYPE\*(Aq,$factory);
\& Function: Register a specific factory for a object type class
\& Returns : none
\& Args    : string representing the class and
\&           Bio::Factory::ObjectFactoryI
.Ve
.PP
See Bio::Factory::ObjectFactoryI for more information
.SS "factory"
.IX Subsection "factory"
.Vb 6
\& Title   : factory
\& Usage   : my $f = $handler\->factory(\*(AqTYPE\*(Aq);
\& Function: Retrieves the associated factory for requested \*(AqTYPE\*(Aq
\& Returns : a Bio::Factory::ObjectFactoryI
\& Throws  : Bio::Root::BadParameter if none registered for the supplied type
\& Args    : name of factory class to retrieve
.Ve
.PP
See Bio::Factory::ObjectFactoryI for more information
.SS "Bio::Event::EventHandlerI methods"
.IX Subsection "Bio::Event::EventHandlerI methods"
.SS "will_handle"
.IX Subsection "will_handle"
.Vb 5
\& 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
.Ve
.SS "\s-1SAX\s0 methods"
.IX Subsection "SAX methods"
See Bio::Event::EventHandlerI for the additional \s-1SAX\s0 methods.