Bio/Search/DatabaseI.pm

   1 #-----------------------------------------------------------------
   2 # $Id$
   3 #
   4 # BioPerl module Bio::Search::DatabaseI
   5 #
   6 # Cared for by Steve Chervitz <sac@bioperl.org>
   7 #
   8 # You may distribute this module under the same terms as perl itself
   9 #-----------------------------------------------------------------
  10
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::Search::DatabaseI - Interface for a database used in a sequence search
  16
  17 =head1 SYNOPSIS
  18
  19 Bio::Search::DatabaseI objects should not be instantiated since this
  20 module defines a pure interface.
  21
  22 Given an object that implements the Bio::Search::DatabaseI  interface,
  23 you can do the following things with it:
  24
  25     $name = $db->name();
  26
  27     $date = $db->date();
  28
  29     $num_letters = $db->letters();
  30
  31     $num_entries = $db->entries();
  32
  33 =head1 DESCRIPTION
  34
  35 This module defines methods for an object that provides metadata
  36 information about a database used for sequence searching.
  37
  38 =head1 FEEDBACK
  39
  40 =head2 Mailing Lists
  41
  42 User feedback is an integral part of the evolution of this and other
  43 Bioperl modules.  Send your comments and suggestions preferably to one
  44 of the Bioperl mailing lists.  Your participation is much appreciated.
  45
  46     bioperl-l@bioperl.org                - General discussion
  47     http://bio.perl.org/MailList.html    - About the mailing lists
  48
  49 =head2 Reporting Bugs
  50
  51 Report bugs to the Bioperl bug tracking system to help us keep track
  52 the bugs and their resolution. Bug reports can be submitted via email
  53 or the web:
  54
  55     bioperl-bugs@bio.perl.org
  56     http://bugzilla.bioperl.org/
  57
  58 =head1 AUTHOR
  59
  60 Steve Chervitz E<lt>sac@bioperl.orgE<gt>
  61
  62 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments.
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
  67
  68 =head1 DISCLAIMER
  69
  70 This software is provided "as is" without warranty of any kind.
  71
  72 =cut
  73
  74 =head1 APPENDIX
  75
  76 The rest of the documentation details each of the object methods.
  77
  78 =cut
  79
  80 # Let the code begin...
  81
  82 package Bio::Search::DatabaseI;
  83
  84 use strict;
  85 use Bio::Root::RootI;
  86 use vars qw( @ISA );
  87
  88 @ISA = qw( Bio::Root::RootI);
  89
  90
  91 =head2 name
  92
  93  Usage     : $name = $db->name();
  94  Purpose   : Get the name of the database searched.
  95  Returns   : String
  96  Argument  : n/a
  97
  98 =cut
  99
 100 sub name {
 101     my $self = shift;
 102     $self->throw_not_implemented;
 103 }
 104
 105 =head2 date
 106
 107  Usage     : $date = $db->date();
 108  Purpose   : Get the creation date of the queried database.
 109  Returns   : String
 110  Argument  : n/a
 111
 112 =cut
 113
 114 sub date {
 115     my $self = shift;
 116     $self->throw_not_implemented;
 117 }
 118
 119
 120 =head2 letters
 121
 122  Usage     : $num_letters = $db->letters();
 123  Purpose   : Get the number of letters in the queried database.
 124  Returns   : Integer
 125  Argument  : n/a
 126
 127 =cut
 128
 129 sub letters {
 130     my $self = shift;
 131     $self->throw_not_implemented;
 132 }
 133
 134
 135 =head2 entries
 136
 137  Usage     : $num_entries = $db->entries();
 138  Purpose   : Get the number of entries in the queried database.
 139  Returns   : Integer
 140  Argument  : n/a
 141
 142 =cut
 143
 144 sub entries {
 145     my $self = shift;
 146     $self->throw_not_implemented;
 147 }
 148
 149 1;