Bio DBLinkContainerI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::DBLinkContainerI - Abstract interface for any object wanting to use
database cross references
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Carp
Inherit
Bio::Root::RootI
Synopsis
    # get an objects containing database cross reference
foreach $obj ( @objs ) { if( $obj->isa('Bio::DBLinkContainerI') ) { foreach $dblink ( $obj->each_DBLink() ) { # do stuff } } }
Description
This interface defines the functions one can expect for any object
wanting to use database cross-references. This class does not actually
provide any implemention, it just provides the definitions of what
methods one can call.
The database cross-references are implemented as Bio::Annotation::DBLink
objects.
Methods
each_DBLinkDescriptionCode
Methods description
each_DBLinkcode    nextTop
 Title   : each_DBLink
Usage : foreach $ref ( $self->each_DBlink() )
Function: gets an array of DBlink of objects
Example :
Returns : an array of Bio::Annotation::DBLink objects
Args : none
Methods code
each_DBLinkdescriptionprevnextTop
sub each_DBLink {
   my ($self) = @_;
   my $class = ref($self) || $self;
   $self->throw("Class $class did not define method 'each_DBLink' for interface DBLinkContainerI");
}

1;
}
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 one
of the Bioperl mailing lists. Your participation is much appreciated.
  bioperl-l@bioperl.org              - General discussion
http://bioperl.org/MailList.shtml - About the mailing lists
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via email
or the web:
  bioperl-bugs@bio.perl.org
http://bugzilla.bioperl.org/
AUTHOR - Heikki LehvaslaihoTop
Email: heikki@ebi.ac.uk
Address:
     EMBL Outstation, European Bioinformatics Institute
Wellcome Trust Genome Campus, Hinxton
Cambs. CB10 1SD, United Kingdom
APPENDIXTop
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _