—
—
—
—
—
—
—
—
—
—

              
# $Id: Sample.pm,v 1.3.4.1 2006/10/02 23:10:17 sendu Exp $
#
# BioPerl module for Bio::Expression::Sample
#
# Cared for by Allen Day <allenday@ucla.edu>
#
# Copyright Allen Day
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
HideShow 42 lines of Pod
=head1 NAME
Bio::Expression::Sample - DESCRIPTION of Object
=head1 SYNOPSIS
Give standard usage here
=head1 DESCRIPTION
Describe the object here
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list.  Your participation is much appreciated.
  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
the web:
  http://bugzilla.open-bio.org/
=head1 AUTHOR - Allen Day
Email allenday@ucla.edu
=head1 APPENDIX
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::Expression::Sample;
use strict;
use base qw(Bio::Root::Root);
HideShow 10 lines of Pod
=head2 new()
 Usage   : my $obj = new Bio::Expression::Sample();
 Function: Builds a new Bio::Expression::Sample object 
 Returns : an instance of Bio::Expression::Sample
 Args    :
=cut
sub new {
  my($class,@args) = @_;
  my $self = $class->SUPER::new(@args);
  $self->_initialize(@args);
  return $self;
}
HideShow 9 lines of Pod
=head2 _initialize()
 Usage   : $obj->_initialize(%arg);
 Function: Internal method to initialize a new Bio::Expression::Sample object
 Returns : true on success
 Args    : passed through to new()
=cut
sub _initialize {
  my($self,%arg) = @_;
  foreach my $arg (keys %arg){
    my $marg = $arg;
    $marg =~ s/^-//;
    $self->$marg($arg{$arg}) if $self->can($marg);
  }
  return 1;
}
HideShow 11 lines of Pod
=head2 accession()
 Usage   : $obj->accession($newval)
 Function: 
 Example : 
 Returns : value of accession (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub accession {
  my($self,$val) = @_;
  $self->{'accession'} = $val if defined($val);
  return $self->{'accession'};
}
HideShow 11 lines of Pod
=head2 dataset()
 Usage   : $obj->dataset($newval)
 Function: 
 Example : 
 Returns : value of dataset (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub dataset {
  my($self,$val) = @_;
  $self->{'dataset'} = $val if defined($val);
  return $self->{'dataset'};
}
HideShow 11 lines of Pod
=head2 db()
 Usage   : $obj->db($newval)
 Function: 
 Example : 
 Returns : value of db (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub db {
  my($self,$val) = @_;
  $self->{'db'} = $val if defined($val);
  return $self->{'db'};
}
HideShow 11 lines of Pod
=head2 name()
 Usage   : $obj->name($newval)
 Function: 
 Example : 
 Returns : value of name (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub name {
  my($self,$val) = @_;
  $self->_load();
  $self->{'name'} = $val if defined($val);
  return $self->{'name'};
}
HideShow 11 lines of Pod
=head2 source_name()
 Usage   : $obj->source_name($newval)
 Function: 
 Example : 
 Returns : value of source_name (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub source_name {
  my($self,$val) = @_;
  $self->_load();
  $self->{'source_name'} = $val if defined($val);
  return $self->{'source_name'};
}
HideShow 11 lines of Pod
=head2 description()
 Usage   : $obj->description($newval)
 Function: 
 Example : 
 Returns : value of description (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub description {
  my($self,$val) = @_;
  $self->_load();
  $self->{'description'} = $val if defined($val);
  return $self->{'description'};
}
HideShow 11 lines of Pod
=head2 treatment_description()
 Usage   : $obj->treatment_description($newval)
 Function: 
 Example : 
 Returns : value of treatment_description (a scalar)
 Args    : on set, new value (a scalar or undef, optional)
=cut
sub treatment_description {
  my($self,$val) = @_;
  $self->_load();
  $self->{'treatment_description'} = $val if defined($val);
  return $self->{'treatment_description'};
}
sub _load {
  my $self = shift;
  if ( $self->{'_load'} ) {
    return 1;
  }
  $self->{'_load'}++;
  $self->db->fill_sample( $self );
  return $self->{'_load'};
}
1;