Bio/Tools/EUtilities/History.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Tools::EUtilities::History
   4 #
   5 # Cared for by Chris Fields
   6 #
   7 # Copyright Chris Fields
   8 #
   9 # You may distribute this module under the same terms as perl itself
  10 #
  11 # POD documentation - main docs before the code
  12 #
  13 # Part of the EUtilities BioPerl package
  14
  15 =head1 NAME
  16
  17 Bio::Tools::EUtilities::History - simple HistoryI implementation for holding
  18 NCBI search history.
  19
  20 =head1 SYNOPSIS
  21
  22   #### should not create instance directly; Bio::Tools::EUtilities does this ####
  23
  24   my $hist = Bio::Tools::EUtilities->new(-eutil => 'epost',
  25                                          -file => 'epost.xml');
  26
  27   if ($hist->has_History) {
  28       # do something here
  29   }
  30
  31   ($webenv, $querykey) = $hist->get_history;
  32
  33   $webenv = $hist->get_webenv;
  34
  35   $query_key = $hist->get_query_key;
  36
  37 =head1 DESCRIPTION
  38
  39 This class is the simplest Bio::Tools::EUtilities::HistoryI implementation and
  40 is primarily used for epost. This class adds methods to objects for dealing with
  41 NCBI history data (WebEnv and query_key). These can be used as parameters for
  42 futher queries against data sets stored on the NCBI server, much like NCBI's
  43 Entrez search history.
  44
  45 NOTE: I plan on testing how long this data is stored remotely. I believe NCBI
  46 deletes remote data after 24 hours.
  47
  48 =head1 FEEDBACK
  49
  50 =head2 Mailing Lists
  51
  52 User feedback is an integral part of the evolution of this and other Bioperl
  53 modules. Send your comments and suggestions preferably to one of the Bioperl
  54 mailing lists. Your participation is much appreciated.
  55
  56   bioperl-l@lists.open-bio.org               - General discussion
  57   http://www.bioperl.org/wiki/Mailing_lists  - About the mailing lists
  58
  59 =head2 Reporting Bugs
  60
  61 Report bugs to the Bioperl bug tracking system to help us keep track the bugs
  62 and their resolution. Bug reports can be submitted via the web.
  63
  64   http://bugzilla.open-bio.org/
  65
  66 =head1 AUTHOR
  67
  68 Email cjfields at uiuc dot edu
  69
  70 =head1 APPENDIX
  71
  72 The rest of the documentation details each of the object methods. Internal
  73 methods are usually preceded with a _
  74
  75 =cut
  76
  77 # Let the code begin...
  78
  79 package Bio::Tools::EUtilities::History;
  80 use strict;
  81 use warnings;
  82 #use URI::Escape qw(uri_unescape);
  83
  84 use base qw(Bio::Tools::EUtilities);
  85
  86 =head1 Bio::Tools::EUtilities::History relevant methods
  87
  88 These are inherited through the Bio::Tools::EUtilities interface
  89 Bio::Tools::EUtilities::HistoryI
  90
  91 =head2 history
  92
  93  Title    : history
  94  Usage    : my ($webenv, $qk) = $hist->history
  95  Function : Get/Set two-element list of webenv() and query_key()
  96  Returns  : array
  97  Args     : two-element list of webenv, querykey
  98
  99 =cut
 100
 101 =head2 get_webenv
 102
 103  Title    : get_webenv
 104  Usage    : my $webenv = $hist->get_webenv
 105  Function : returns web environment key needed to retrieve results from
 106             NCBI server
 107  Returns  : string (encoded key)
 108  Args     : none
 109
 110 =cut
 111
 112 =head2 get_query_key
 113
 114  Title    : get_query_key
 115  Usage    : my $qk = $hist->get_query_key
 116  Function : returns query key (integer) for the history number for this session
 117  Returns  : integer
 118  Args     : none
 119
 120 =cut
 121
 122 =head2 has_History
 123
 124  Title    : has_History
 125  Usage    : if ($hist->has_History) {...}
 126  Function : returns TRUE if full history (webenv, query_key) is present
 127  Returns  : BOOLEAN, value eval'ing to TRUE or FALUE
 128  Args     : none
 129
 130 =cut
 131
 132 # private method
 133
 134 sub _add_data {
 135     my ($self, $simple) = @_;
 136     map { $self->{'_'.lc $_} = $simple->{$_} } keys %$simple;
 137 }
 138
 139 1;
 140 __END__