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

View of /FigKernelPackages/SAPserver.pm

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.13 - (download) (as text) (annotate)
Mon Aug 9 13:46:06 2010 UTC (9 years, 6 months ago) by parrello
Branch: MAIN
CVS Tags: rast_rel_2010_0928, rast_rel_2010_1206, rast_rel_2010_0827
Changes since 1.12: +3 -1 lines
Allow alternate forms of parameters to client-side modules.

#	This is a SAS Component.
# Copyright (c) 2003-2006 University of Chicago and Fellowship
# for Interpretations of Genomes. All Rights Reserved.
# This file is part of the SEED Toolkit.
# The SEED Toolkit is free software. You can redistribute
# it and/or modify it under the terms of the SEED Toolkit
# Public License.
# You should have received a copy of the SEED Toolkit Public License
# along with this program; if not write to the University of Chicago
# at info@ci.uchicago.edu or the Fellowship for Interpretation of
# Genomes at veronika@thefig.info or download a copy from
# http://www.theseed.org/LICENSE.TXT.

package SAPserver;

    use strict;
    use base qw(ClientThing);

=head1 Sapling Server Helper Object

=head2 Description

This module is used to call the sapling server, which is a general-purpose
server for extracting data from the Sapling database. Each Sapling server
function corresponds to a method of this object. In other words, all
L<SAP/Primary Methods> are also methods here.


=head3 new

    my $ss = SAPserver->new(%options);

Construct a new SAPserver object. The following options are supported.

=over 4

=item url

URL for the sapling server. This option may be used to redirect requests to a
test version of the server, or to an older server script.

=item singleton

If TRUE, results from methods will be returned in singleton mode. In singleton
mode, if a single result comes back, it will come back as a scalar rather than
as a hash value accessible via an incoming ID.



sub new {
    # Get the parameters.
    my ($class, @options) = @_;
    # Fix the option hash.
    my %options = ClientThing::FixOptions(@options);
    # Compute the URL.
    $options{url} = ClientThing::ComputeURL($options{url}, 'sap_server.cgi',
    # Construct the subclass.
    return $class->SUPER::new(SAP => %options);


MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3