Bio::DB::GFF Featname
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::DB::GFF::Featname -- The name of a feature
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Inherit
Bio::Root::RootI
Synopsis
  use Bio::DB::GFF;

  my $db      = Bio::DB::GFF->new( -adaptor => 'dbi:mysql',
                                   -dsn     => 'dbi:mysql:elegans42');

  my $feature = Bio::DB::GFF::Featname->new(Locus => 'unc-19');
  my $segment = $db->segment($feature);
Description
Bio::DB::GFF::Featname is the name of a feature. It contains two
fields: name and class. It is typically used by the Bio::DB::GFF
module to denote a group, and is accepted by
Bio::DB::Relsegment->new() and Bio::DB::GFF->segment() as a
replacement for the -name and -class arguments.
Methods
asStringDescriptionCode
classDescriptionCode
cloneDescriptionCode
idDescriptionCode
nameDescriptionCode
newDescriptionCode
Methods description
asStringcode    nextTop
 Title   : asString
 Usage   : $string = $name->asString
 Function: same as name()
 Returns : a string
 Args    : none
 Status  : Public
This method is used to overload the "" operator. It is equivalent to
calling name().
classcodeprevnextTop
 Title   : class
 Usage   : $class = $name->class
 Function: return the name of the Featname
 Returns : a string
 Args    : none
 Status  : Public
clonecodeprevnextTop
 Title   : clone
 Usage   : $new_clone = $type->clone;
 Function: clone this object
 Returns : a new Bio::DB::GFF::Featname object
 Args    : none
 Status  : Public
This method creates an exact copy of the object.
idcodeprevnextTop
 Title   : id
 Usage   : $id = $name->id
 Function: return a unique ID for the combination of class and name
 Returns : a string
 Args    : none
 Status  : Public
This method returns a unique combination of the name and class in the
form "class:name". Coincidentally, this is the same format used
by AceDB.
namecodeprevnextTop
 Title   : name
 Usage   : $name = $name->name
 Function: return the name of the Featname
 Returns : a string
 Args    : none
 Status  : Public
newcodeprevnextTop
 Title   : new
 Usage   : $name = Bio::DB::GFF::Featname->new($class,$name)
 Function: create a new Bio::DB::GFF::Featname object
 Returns : a new Bio::DB::GFF::Featname object
 Args    : class and ID
 Status  : Public
Methods code
asStringdescriptionprevnextTop
sub asString {
 shift->name
}
classdescriptionprevnextTop
sub class {
 shift->[0]
}
clonedescriptionprevnextTop
sub clone {
  my $self = shift;
  return bless [@$self],ref $self;
}
iddescriptionprevnextTop
sub id {
  my $self = shift;
  return join ':',@$self;
}
namedescriptionprevnextTop
sub name {
 shift->[1]
}
newdescriptionprevnextTop
sub new {
  # use a blessed array for speed
  my $pack = shift;
  bless [@_],$pack;  # class,name
}
General documentation
BUGSTop
This module is still under development.
SEE ALSOTop
bioperl, Bio::DB::GFF, Bio::DB::RelSegment
AUTHORTop
Lincoln Stein <lstein@cshl.org>.
Copyright (c) 2001 Cold Spring Harbor Laboratory.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.