Bio::Search DatabaseI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Search::DatabaseI - Interface for a database used in a sequence search
Package variables
No package variables defined.
Inherit
Bio::Root::RootI
Synopsis
Bio::Search::DatabaseI objects should not be instantiated since this
module defines a pure interface.
Given an object that implements the Bio::Search::DatabaseI interface,
you can do the following things with it:
    $name = $db->name();
$date = $db->date(); $num_letters = $db->letters(); $num_entries = $db->entries();
Description
This module defines methods for an object that provides metadata
information about a database used for sequence searching.
Methods
nameDescriptionCode
dateDescriptionCode
lettersDescriptionCode
entriesDescriptionCode
Methods description
namecode    nextTop
 Usage     : $name = $db->name();
Purpose : Get the name of the database searched.
Returns : String
Argument : n/a
datecodeprevnextTop
 Usage     : $date = $db->date();
Purpose : Get the creation date of the queried database.
Returns : String
Argument : n/a
letterscodeprevnextTop
 Usage     : $num_letters = $db->letters();
Purpose : Get the number of letters in the queried database.
Returns : Integer
Argument : n/a
entriescodeprevnextTop
 Usage     : $num_entries = $db->entries();
Purpose : Get the number of entries in the queried database.
Returns : Integer
Argument : n/a
Methods code
namedescriptionprevnextTop
sub name {
    my $self = shift;
    $self->throw_not_implemented;
}
datedescriptionprevnextTop
sub date {
    my $self = shift;
    $self->throw_not_implemented;
}
lettersdescriptionprevnextTop
sub letters {
    my $self = shift;
    $self->throw_not_implemented;
}
entriesdescriptionprevnextTop
sub entries {
    my $self = shift;
    $self->throw_not_implemented;
}

1;
}
General documentation
FEEDBACKTop
Mailing Lists Top
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to one
of the Bioperl mailing lists. Your participation is much appreciated.
  bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support Top
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR Top
Steve Chervitz <sac@bioperl.org>
See the FEEDBACK section for where to send bug reports and comments.
COPYRIGHTTop
Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
DISCLAIMERTop
This software is provided "as is" without warranty of any kind.
APPENDIXTop
The rest of the documentation details each of the object methods.