branch-1-6/Bio/DBLinkContainerI.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::DBLinkContainerI
   4 #
   5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   6 #
   7 # Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
   8 #
   9 # Copyright Heikki Lehvaslaiho
  10 #
  11 # You may distribute this module under the same terms as perl itself
  12
  13 # POD documentation - main docs before the code
  14
  15 =head1 NAME
  16
  17 Bio::DBLinkContainerI - Abstract interface for any object wanting to use
  18                         database cross references
  19
  20 =head1 SYNOPSIS
  21
  22     # get an objects containing database cross reference
  23
  24         foreach $obj ( @objs ) {
  25                 if( $obj->isa('Bio::DBLinkContainerI') ) {
  26                         foreach $dblink ( $obj->each_DBLink() ) {
  27                                 # do stuff
  28                         }
  29                 }
  30         }
  31
  32 =head1 DESCRIPTION
  33
  34 This interface defines the functions one can expect for any object
  35 wanting to use database cross-references. This class does not actually
  36 provide any implemention, it just provides the definitions of what
  37 methods one can call.
  38
  39 The database cross-references are implemented as L<Bio::Annotation::DBLink>
  40 objects.
  41
  42 =head1 FEEDBACK
  43
  44 =head2 Mailing Lists
  45
  46 User feedback is an integral part of the evolution of this and other
  47 Bioperl modules. Send your comments and suggestions preferably to one
  48 of the Bioperl mailing lists.  Your participation is much appreciated.
  49
  50   bioperl-l@bioperl.org                  - General discussion
  51   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  52
  53 =head2 Support
  54
  55 Please direct usage questions or support issues to the mailing list:
  56
  57 I<bioperl-l@bioperl.org>
  58
  59 rather than to the module maintainer directly. Many experienced and
  60 reponsive experts will be able look at the problem and quickly
  61 address it. Please include a thorough description of the problem
  62 with code and data examples if at all possible.
  63
  64 =head2 Reporting Bugs
  65
  66 Report bugs to the Bioperl bug tracking system to help us keep track
  67 the bugs and their resolution.  Bug reports can be submitted via the
  68 web:
  69
  70   http://bugzilla.open-bio.org/
  71
  72 =head1 AUTHOR - Heikki Lehvaslaiho
  73
  74 Email:  heikki-at-bioperl-dot-org
  75
  76 =head1 APPENDIX
  77
  78 The rest of the documentation details each of the object
  79 methods. Internal methods are usually preceded with a _
  80
  81 =cut
  82
  83 # Let the code begin...
  84
  85 package Bio::DBLinkContainerI;
  86 use strict;
  87
  88 use Carp;
  89
  90 use base qw(Bio::Root::RootI);
  91
  92 =head2 each_DBLink
  93
  94  Title   : each_DBLink
  95  Usage   : foreach $ref ( $self->each_DBlink() )
  96  Function: gets an array of DBlink of objects
  97  Example :
  98  Returns : an array of Bio::Annotation::DBLink objects
  99  Args    : none
 100
 101
 102 =cut
 103
 104 sub each_DBLink{
 105    my ($self) = @_;
 106    my $class = ref($self) || $self;
 107    $self->throw("Class $class did not define method 'each_DBLink' for interface DBLinkContainerI");
 108 }
 109
 110 1;
 111