/ 
bioperl-1.2.3
/ Bio::DBLinkContainerI

NAME

Bio::DBLinkContainerI - Abstract interface for any object wanting to use database cross references

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.

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 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 Bugs

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 Lehvaslaiho

Email: heikki@ebi.ac.uk Address:

EMBL Outstation, European Bioinformatics Institute
Wellcome Trust Genome Campus, Hinxton
Cambs. CB10 1SD, United Kingdom

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

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