[Bio] / FigKernelPackages / SUPserver.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/SUPserver.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (view) (download) (as text)

1 : parrello 1.1 #
2 :     # This is a SAS Component.
3 :     #
4 :     # Copyright (c) 2003-2006 University of Chicago and Fellowship
5 :     # for Interpretations of Genomes. All Rights Reserved.
6 :     #
7 :     # This file is part of the SEED Toolkit.
8 :     #
9 :     # The SEED Toolkit is free software. You can redistribute
10 :     # it and/or modify it under the terms of the SEED Toolkit
11 :     # Public License.
12 :     #
13 :     # You should have received a copy of the SEED Toolkit Public License
14 :     # along with this program; if not write to the University of Chicago
15 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
16 :     # Genomes at veronika@thefig.info or download a copy from
17 :     # http://www.theseed.org/LICENSE.TXT.
18 :     #
19 :    
20 :     package SUPserver;
21 :    
22 :     use strict;
23 :     use base qw(ClientThing);
24 :    
25 :     =head1 Sapling Update Server Helper Object
26 :    
27 :     =head2 Description
28 :    
29 :     This module is used to call the sapling update server, which is a
30 :     server for updating data in the Sapling database. Each Sapling Update
31 :     Server function corresponds to a method of this object. In other words,
32 :     all L<SUP/Primary Methods> are also methods here.
33 :    
34 :     =cut
35 :    
36 :     =head3 new
37 :    
38 :     my $ss = SUPserver->new(%options);
39 :    
40 :     Construct a new SUPserver object. The following options are supported.
41 :    
42 :     =over 4
43 :    
44 :     =item url
45 :    
46 :     URL for the sapling update server. This option may be used to redirect requests
47 :     to a test version of the server, or to an older server script.
48 :    
49 :     =item singleton
50 :    
51 :     If TRUE, results from methods will be returned in singleton mode. In singleton
52 :     mode, if a single result comes back, it will come back as a scalar rather than
53 :     as a hash value accessible via an incoming ID.
54 :    
55 :     =item dbName
56 :    
57 :     Name of the database to use, if it is to be different from the default.
58 :    
59 :     =back
60 :    
61 :     =cut
62 :    
63 :     sub new {
64 :     # Get the parameters.
65 :     my ($class, @options) = @_;
66 :     # Fix the option hash.
67 :     my %options = ClientThing::FixOptions(@options);
68 :     # Compute the URL.
69 :     $options{url} = ClientThing::ComputeURL($options{url}, 'sup_server.cgi',
70 :     'sapupdate');
71 :     # Construct the subclass.
72 :     return $class->SUPER::new(SUP => %options);
73 :     }
74 :    
75 :    
76 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3