Bio::Event EventHandlerI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Event::EventHandlerI - An Event Handler Interface
Package variables
No package variables defined.
Included modules
Carp
Inherit
Bio::Root::RootI
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.
Methods
will_handleDescriptionCode
start_documentDescriptionCode
end_documentDescriptionCode
start_elementDescriptionCode
end_elementDescriptionCode
in_elementDescriptionCode
within_elementDescriptionCode
charactersDescriptionCode
Methods description
will_handlecode    nextTop
 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
start_documentcodeprevnextTop
 Title   : start_document
 Usage   : $eventgenerator->start_document();
 Function: Handle a start document event
 Returns : none
 Args    : none
end_documentcodeprevnextTop
 Title   : end_document
 Usage   : $eventgenerator->end_document();
 Function: Handle an end document event
 Returns : none
 Args    : none
start_elementcodeprevnextTop
 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_elementcodeprevnextTop
 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_elementcodeprevnextTop
 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_elementcodeprevnextTop
 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
characterscodeprevnextTop
 Title   : characters
 Usage   : $eventgenerator->characters($str)
 Function: Send a character events
 Returns : none
 Args    : string
Methods code
will_handledescriptionprevnextTop
sub will_handle {
   my ($self,$type) = @_;
   $self->throw_not_implemented();
}
start_documentdescriptionprevnextTop
sub start_document {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
end_documentdescriptionprevnextTop
sub end_document {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
start_elementdescriptionprevnextTop
sub start_element {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
end_elementdescriptionprevnextTop
sub end_element {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
in_elementdescriptionprevnextTop
sub in_element {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
within_elementdescriptionprevnextTop
sub within_element {
   my ($self,@args) = @_;
   $self->throw_not_implemented;
}
charactersdescriptionprevnextTop
sub characters {
   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
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:
  http://bugzilla.open-bio.org/
AUTHOR - Jason StajichTop
Email jason@bioperl.org
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
SAX methodsTop