Bio::SearchIO EventHandlerI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::SearchIO::EventHandlerI - An abstract Event Handler for Search Result parsing
Package variables
No package variables defined.
Included modules
Carp
Inherit
Bio::Event::EventHandlerI
Synopsis
# 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();
Description
This interface describes the basic methods needed to handle Events
thrown from parsing a Search Result such as FASTA, BLAST, or HMMer.
Methods
start_resultDescriptionCode
end_resultDescriptionCode
start_hspDescriptionCode
end_hspDescriptionCode
start_hitDescriptionCode
end_hitDescriptionCode
start_iterationDescriptionCode
end_iterationDescriptionCode
register_factoryDescriptionCode
factoryDescriptionCode
Methods description
start_resultcode    nextTop
 Title   : start_result
 Usage   : $handler->start_result($data)
 Function: Begins a result event cycle
 Returns : none 
 Args    : Type of Result
end_resultcodeprevnextTop
 Title   : end_result
 Usage   : $handler->end_result($data)
 Function: Ends a result event cycle
 Returns : Bio::Search::Result::ResultI object
 Args    : none
start_hspcodeprevnextTop
 Title   : start_hsp
 Usage   : $handler->start_hsp($data)
 Function: Start a HSP event cycle
 Returns : none
 Args    : type of element
           associated hashref
end_hspcodeprevnextTop
 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_hitcodeprevnextTop
 Title   : start_hit
 Usage   : $handler->start_hit()
 Function: Starts a Hit event cycle
 Returns : none
 Args    : type of event and associated hashref
end_hitcodeprevnextTop
 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_iterationcodeprevnextTop
 Title   : start_iteration
 Usage   : $handler->start_iteration()
 Function: Starts an Iteration event cycle
 Returns : none
 Args    : type of event and associated hashref
end_iterationcodeprevnextTop
 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_factorycodeprevnextTop
 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
factorycodeprevnextTop
 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
Methods code
start_resultdescriptionprevnextTop
sub start_result {
    my ($self) = @_;
    $self->throw_not_implemented();
}
end_resultdescriptionprevnextTop
sub end_result {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
start_hspdescriptionprevnextTop
sub start_hsp {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
end_hspdescriptionprevnextTop
sub end_hsp {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
start_hitdescriptionprevnextTop
sub start_hit {
   my ($self,@args) = @_;
   $self->throw_not_implemented
}
end_hitdescriptionprevnextTop
sub end_hit {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
start_iterationdescriptionprevnextTop
sub start_iteration {
   my ($self,@args) = @_;
   $self->throw_not_implemented
}
end_iterationdescriptionprevnextTop
sub end_iteration {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
register_factorydescriptionprevnextTop
sub register_factory {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
factorydescriptionprevnextTop
sub factory {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
General documentation
FEEDBACKTop
Mailing ListsTop
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 Top
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 BugsTop
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:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Jason StajichTop
Email jason-at-bioperl.org
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Bio::Event::EventHandlerI methodsTop
will_handleTop
 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 methodsTop
See Bio::Event::EventHandlerI for the additional SAX methods.