branch-1-6/Bio/Search/DatabaseI.pm

   1 #-----------------------------------------------------------------
   2 # $Id$
   3 #
   4 # BioPerl module Bio::Search::DatabaseI
   5 #
   6 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   7 #
   8 # Cared for by Steve Chervitz <sac@bioperl.org>
   9 #
  10 # You may distribute this module under the same terms as perl itself
  11 #-----------------------------------------------------------------
  12
  13 # POD documentation - main docs before the code
  14
  15 =head1 NAME
  16
  17 Bio::Search::DatabaseI - Interface for a database used in a sequence search
  18
  19 =head1 SYNOPSIS
  20
  21 Bio::Search::DatabaseI objects should not be instantiated since this
  22 module defines a pure interface.
  23
  24 Given an object that implements the Bio::Search::DatabaseI  interface,
  25 you can do the following things with it:
  26
  27     $name = $db->name();
  28
  29     $date = $db->date();
  30
  31     $num_letters = $db->letters();
  32
  33     $num_entries = $db->entries();
  34
  35 =head1 DESCRIPTION
  36
  37 This module defines methods for an object that provides metadata
  38 information about a database used for sequence searching.
  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 Support
  52
  53 Please direct usage questions or support issues to the mailing list:
  54
  55 I<bioperl-l@bioperl.org>
  56
  57 rather than to the module maintainer directly. Many experienced and
  58 reponsive experts will be able look at the problem and quickly
  59 address it. Please include a thorough description of the problem
  60 with code and data examples if at all possible.
  61
  62 =head2 Reporting Bugs
  63
  64 Report bugs to the Bioperl bug tracking system to help us keep track
  65 the bugs and their resolution. Bug reports can be submitted via the
  66 web:
  67
  68   http://bugzilla.open-bio.org/
  69
  70 =head1 AUTHOR
  71
  72 Steve Chervitz E<lt>sac@bioperl.orgE<gt>
  73
  74 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments.
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
  79
  80 =head1 DISCLAIMER
  81
  82 This software is provided "as is" without warranty of any kind.
  83
  84 =cut
  85
  86 =head1 APPENDIX
  87
  88 The rest of the documentation details each of the object methods.
  89
  90 =cut
  91
  92 # Let the code begin...
  93
  94 package Bio::Search::DatabaseI;
  95
  96 use strict;
  97
  98 use base qw(Bio::Root::RootI);
  99
 100
 101 =head2 name
 102
 103  Usage     : $name = $db->name();
 104  Purpose   : Get the name of the database searched.
 105  Returns   : String
 106  Argument  : n/a
 107
 108 =cut
 109
 110 sub name {
 111     my $self = shift;
 112     $self->throw_not_implemented;
 113 }
 114
 115 =head2 date
 116
 117  Usage     : $date = $db->date();
 118  Purpose   : Get the creation date of the queried database.
 119  Returns   : String
 120  Argument  : n/a
 121
 122 =cut
 123
 124 sub date {
 125     my $self = shift;
 126     $self->throw_not_implemented;
 127 }
 128
 129
 130 =head2 letters
 131
 132  Usage     : $num_letters = $db->letters();
 133  Purpose   : Get the number of letters in the queried database.
 134  Returns   : Integer
 135  Argument  : n/a
 136
 137 =cut
 138
 139 sub letters {
 140     my $self = shift;
 141     $self->throw_not_implemented;
 142 }
 143
 144
 145 =head2 entries
 146
 147  Usage     : $num_entries = $db->entries();
 148  Purpose   : Get the number of entries in the queried database.
 149  Returns   : Integer
 150  Argument  : n/a
 151
 152 =cut
 153
 154 sub entries {
 155     my $self = shift;
 156     $self->throw_not_implemented;
 157 }
 158
 159 1;