Bio::Search DatabaseI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::Search::DatabaseI - Interface for a database used in a sequence search
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
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
dateDescriptionCode
entriesDescriptionCode
lettersDescriptionCode
nameDescriptionCode
Methods description
datecode    nextTop
 Usage     : $date = $db->date();
 Purpose   : Get the creation date of the queried database.
 Returns   : String
 Argument  : n/a
entriescodeprevnextTop
 Usage     : $num_entries = $db->entries();
 Purpose   : Get the number of entries in the queried database.
 Returns   : Integer
 Argument  : n/a
letterscodeprevnextTop
 Usage     : $num_letters = $db->letters();
 Purpose   : Get the number of letters in the queried database.
 Returns   : Integer
 Argument  : n/a
namecodeprevnextTop
 Usage     : $name = $db->name();
 Purpose   : Get the name of the database searched.
 Returns   : String
 Argument  : n/a
Methods code
datedescriptionprevnextTop
sub date {
    my $self = shift;
    $self->throw_not_implemented;
}
entriesdescriptionprevnextTop
sub entries {
    my $self = shift;
    $self->throw_not_implemented;
}

1;
}
lettersdescriptionprevnextTop
sub letters {
    my $self = shift;
    $self->throw_not_implemented;
}
namedescriptionprevnextTop
sub name {
    my $self = shift;
    $self->throw_not_implemented;
}
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://bio.perl.org/MailList.html    - About the mailing lists
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 email
or the web:
    bioperl-bugs@bio.perl.org                   
    http://bugzilla.bioperl.org/
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.