lib/Bio/Search/StatisticsI.pm

   1 #
   2 #
   3 # BioPerl module for wrapping runtime parameters
   4 #
   5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   6 #
   7 # Cared for by Chad Matsalla (bioinformatics1 at dieselwurks dot com)
   8 #
   9 # Copyright Chad Matsalla
  10 #
  11 # You may distribute this module under the same terms as perl itself
  12
  13 # POD documentation - main docs before the code
  14
  15 =head1 NAME
  16
  17 Bio::Search::StatisticsI - A Base object for statistics
  18
  19 =head1 SYNOPSIS
  20
  21   # do not use this object directly, it provides the following methods
  22   # for its subclasses
  23
  24   my $void   = $obj->set_statistic("statistic_name","statistic_value");
  25   my $value  = $obj->get_statistic("statistic_name");
  26
  27 =head1 DESCRIPTION
  28
  29 This is a basic container to hold the statistics returned from a program.
  30
  31 =head1 FEEDBACK
  32
  33 =head2 Mailing Lists
  34
  35 User feedback is an integral part of the evolution of this and other
  36 Bioperl modules. Send your comments and suggestions preferably to
  37 the Bioperl mailing list.  Your participation is much appreciated.
  38
  39   bioperl-l@bioperl.org                  - General discussion
  40   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  41
  42 =head2 Support
  43
  44 Please direct usage questions or support issues to the mailing list:
  45
  46 I<bioperl-l@bioperl.org>
  47
  48 rather than to the module maintainer directly. Many experienced and
  49 reponsive experts will be able look at the problem and quickly
  50 address it. Please include a thorough description of the problem
  51 with code and data examples if at all possible.
  52
  53 =head2 Reporting Bugs
  54
  55 Report bugs to the Bioperl bug tracking system to help us keep track
  56 of the bugs and their resolution. Bug reports can be submitted via the
  57 web:
  58
  59   https://github.com/bioperl/bioperl-live/issues
  60
  61 =head1 AUTHOR - Chad Matsalla
  62
  63 Email bioinformatics1 at dieselwurks dot com
  64
  65 =head1 APPENDIX
  66
  67 The rest of the documentation details each of the object methods.
  68 Internal methods are usually preceded with a _
  69
  70 =cut
  71
  72
  73 # Let the code begin...
  74
  75
  76 package Bio::Search::StatisticsI;
  77 use strict;
  78
  79 # Object preamble - inherits from Bio::Root::Root
  80
  81
  82 use base qw(Bio::Root::RootI);
  83
  84
  85 =head2 get_statistic
  86
  87  Title   : get_statistic
  88  Usage   : $statistic_object->get_statistic($statistic_name);
  89  Function: Get the value of a statistic named $statistic_name
  90  Returns : A scalar that should be a string
  91  Args    : A scalar that should be a string
  92
  93 =cut
  94
  95 sub get_statistic {
  96    my ($self,$arg) = @_;
  97      $self->throw_not_implemented;
  98 }
  99
 100
 101 =head2 set_statistic
 102
 103  Title   : set_statistic
 104  Usage   : $statistic_object->set_statistic($statistic_name => $statistic_value);
 105  Function: Set the value of a statistic named $statistic_name to $statistic_value
 106  Returns : Void
 107  Args    : A hash containing name=>value pairs
 108
 109 =cut
 110
 111 sub set_statistic {
 112    my ($self,$name,$value) = @_;
 113      $self->throw_not_implemented;
 114 }
 115
 116
 117
 118 1;