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 implementation, 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/wiki/Mailing_lists  - About the mailing lists

Support

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 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 the web:

https://github.com/bioperl/bioperl-live/issues

AUTHOR - Heikki Lehvaslaiho

Email: heikki-at-bioperl-dot-org

APPENDIX

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

each_DBLink

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