branch-1-6/Bio/Factory/AnalysisI.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Factory::AnalysisI
   4 #
   5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   6 #
   7 # Cared for by Martin Senger <martin.senger@gmail.com>
   8 # For copyright and disclaimer see below.
   9 #
  10
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::Factory::AnalysisI - An interface to analysis tool factory
  16
  17 =head1 SYNOPSIS
  18
  19 This is an interface module - you do not instantiate it.
  20 Use I<Bio::Tools::Run::AnalysisFactory> module:
  21
  22   use Bio::Tools::Run::AnalysisFactory;
  23   my $list = Bio::Tools::Run::AnalysisFactory->new->available_analyses;
  24
  25 =head1 DESCRIPTION
  26
  27 This interface contains all public methods for showing available
  28 analyses and for creating objects representing them.
  29
  30 =head1 FEEDBACK
  31
  32 =head2 Mailing Lists
  33
  34 User feedback is an integral part of the evolution of this and other
  35 Bioperl modules. Send your comments and suggestions preferably to
  36 the Bioperl mailing list.  Your participation is much appreciated.
  37
  38   bioperl-l@bioperl.org                  - General discussion
  39   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  40
  41 =head2 Support
  42
  43 Please direct usage questions or support issues to the mailing list:
  44
  45 I<bioperl-l@bioperl.org>
  46
  47 rather than to the module maintainer directly. Many experienced and
  48 reponsive experts will be able look at the problem and quickly
  49 address it. Please include a thorough description of the problem
  50 with code and data examples if at all possible.
  51
  52 =head2 Reporting Bugs
  53
  54 Report bugs to the Bioperl bug tracking system to help us keep track
  55 of the bugs and their resolution. Bug reports can be submitted via the
  56 web:
  57
  58   http://bugzilla.open-bio.org/
  59
  60 =head1 AUTHOR
  61
  62 Martin Senger (martin.senger@gmail.com)
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright (c) 2003, Martin Senger and EMBL-EBI.
  67 All Rights Reserved.
  68
  69 This module is free software; you can redistribute it and/or modify
  70 it under the same terms as Perl itself.
  71
  72 =head1 DISCLAIMER
  73
  74 This software is provided "as is" without warranty of any kind.
  75
  76 =head1 SEE ALSO
  77
  78 =over
  79
  80 =item *
  81
  82 http://www.ebi.ac.uk/Tools/webservices/soaplab/guide
  83
  84 =back
  85
  86 =head1 APPENDIX
  87
  88 This is actually the main documentation...
  89
  90 If you try to call any of these methods directly on this
  91 C<Bio::Factory::AnalysisI> object you will get a I<not implemented>
  92 error message. You need to call them on a
  93 C<Bio::Tools::Run::AnalysisFactory> object instead.
  94
  95 =cut
  96
  97
  98 # Let the code begin...
  99
 100 package Bio::Factory::AnalysisI;
 101 use strict;
 102
 103 use base qw(Bio::Root::RootI);
 104
 105
 106 # -----------------------------------------------------------------------------
 107
 108 =head2 available_categories
 109
 110  Usage   : $factory->available_categories;
 111  Returns : an array reference with the names of
 112            available categories
 113  Args    : none
 114
 115 The analysis tools may be grouped into categories by their functional
 116 similarity, or by the similar data types they deal with. This method
 117 shows all available such categories.
 118
 119 =cut
 120
 121 sub available_categories { shift->throw_not_implemented(); }
 122
 123 # -----------------------------------------------------------------------------
 124
 125 =head2 available_analyses
 126
 127  Usage   : $factory->available_analyses;
 128            $factory->available_analyses ($category);
 129  Returns : an array reference with the names of
 130            all available analyses, or the analyses
 131            available in the given '$category'
 132  Args    : none || category_name
 133
 134 Show available analyses. Their names usually consist of category
 135 analysis names, separated by C<::>.
 136
 137 =cut
 138
 139 sub available_analyses { shift->throw_not_implemented(); }
 140
 141 # -----------------------------------------------------------------------------
 142
 143 =head2 create_analysis
 144
 145  Usage   : $factory->create_analysis ($name);
 146  Returns : a Bio::Tools::Run::Analyis object
 147  Args    : analysis name
 148
 149 A real I<factory> method creating an analysis object. The created
 150 object gets all access and location information from the factory
 151 object.
 152
 153 =cut
 154
 155 sub create_analysis { shift->throw_not_implemented(); }
 156
 157 # -----------------------------------------------------------------------------
 158
 159
 160 1;
 161 __END__
 162