Bio/DBLinkContainerI.pm

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