Bio::Search GenericDatabase
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::Search::GenericDatabase - Generic implementation of Bio::Search::DatabaseI
Package variables
No package variables defined.
Included modules
Bio::Root::Root
Bio::Search::DatabaseI
Inherit
Bio::Root::Root Bio::Search::DatabaseI
Synopsis
    use Bio::Search::GenericDatabase;
$db = Bio::Search::GenericDatabase->new( -name => 'my Blast db', -date => '2001-03-13', -length => 2352511, -entries => 250000 ); $name = $db->name(); $date = $db->date(); $num_letters = $db->letters(); $num_entries = $db->entries();
Description
This module provides a basic implementation of Bio::Search::DatabaseI.
See documentation in that module for more information.
Methods
dateDescriptionCode
entriesDescriptionCode
lettersDescriptionCode
nameDescriptionCode
new
No description
Code
Methods description
datecode    nextTop
See Bio::Search::DatabaseI::date() for documentation
This implementation is a combined set/get accessor.
entriescodeprevnextTop
See Bio::Search::DatabaseI::entries() for documentation
This implementation is a combined set/get accessor.
letterscodeprevnextTop
See Bio::Search::DatabaseI::letters() for documentation
This implementation is a combined set/get accessor.
namecodeprevnextTop
See Bio::Search::DatabaseI::name() for documentation
This implementation is a combined set/get accessor.
Methods code
datedescriptionprevnextTop
sub date {
#-----------------------
my $self = shift; if(@_) { $self->{'_dbDate'} = shift; } $self->{'_dbDate'};
}
entriesdescriptionprevnextTop
sub entries {
#------------------
my $self = shift; if(@_) { $self->{'_dbEntries'} = shift; } $self->{'_dbEntries'}; } 1;
}
lettersdescriptionprevnextTop
sub letters {
#----------------------
my $self = shift; if(@_) { $self->{'_dbLetters'} = shift; } $self->{'_dbLetters'};
}
namedescriptionprevnextTop
sub name {
#---------------
my $self = shift; if(@_) { my $name = shift; $name =~ s/(^\s+|\s+$)//g; $self->{'_db'} = $name; } $self->{'_db'};
}
newdescriptionprevnextTop
sub new {
    my ($class, @args) = @_; 
    my $self = $class->SUPER::new(@args);
    my ($name, $date, $length, $ents) = 
        $self->_rearrange( [qw(NAME DATE LENGTH ENTRIES)], @args);

    $name    && $self->name($name);
    $date    && $self->date($date);
    $length  && $self->letters($length);
    $ents    && $self->entries($ents);

    return $self;
}
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.