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://bioperl.org/wiki/Mailing_lists  - 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 the
  53 web:
  54
  55   http://bugzilla.open-bio.org/
  56
  57 =head1 AUTHOR
  58
  59 Steve Chervitz E<lt>sac@bioperl.orgE<gt>
  60
  61 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments.
  62
  63 =head1 COPYRIGHT
  64
  65 Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
  66
  67 =head1 DISCLAIMER
  68
  69 This software is provided "as is" without warranty of any kind.
  70
  71 =cut
  72
  73 =head1 APPENDIX
  74
  75 The rest of the documentation details each of the object methods.
  76
  77 =cut
  78
  79 # Let the code begin...
  80
  81 package Bio::Search::DatabaseI;
  82
  83 use strict;
  84
  85 use base qw(Bio::Root::RootI);
  86
  87
  88 =head2 name
  89
  90  Usage     : $name = $db->name();
  91  Purpose   : Get the name of the database searched.
  92  Returns   : String
  93  Argument  : n/a
  94
  95 =cut
  96
  97 sub name {
  98     my $self = shift;
  99     $self->throw_not_implemented;
 100 }
 101
 102 =head2 date
 103
 104  Usage     : $date = $db->date();
 105  Purpose   : Get the creation date of the queried database.
 106  Returns   : String
 107  Argument  : n/a
 108
 109 =cut
 110
 111 sub date {
 112     my $self = shift;
 113     $self->throw_not_implemented;
 114 }
 115
 116
 117 =head2 letters
 118
 119  Usage     : $num_letters = $db->letters();
 120  Purpose   : Get the number of letters in the queried database.
 121  Returns   : Integer
 122  Argument  : n/a
 123
 124 =cut
 125
 126 sub letters {
 127     my $self = shift;
 128     $self->throw_not_implemented;
 129 }
 130
 131
 132 =head2 entries
 133
 134  Usage     : $num_entries = $db->entries();
 135  Purpose   : Get the number of entries in the queried database.
 136  Returns   : Integer
 137  Argument  : n/a
 138
 139 =cut
 140
 141 sub entries {
 142     my $self = shift;
 143     $self->throw_not_implemented;
 144 }
 145
 146 1;