/ 
Bio-Phylo-0.18
/ Bio::Phylo::PhyloWS::Service::Tolweb

NAME

Bio::Phylo::PhyloWS::Service::Tolweb - PhyloWS service wrapper for Tree of Life

SYNOPSIS

# inside a CGI script:
use CGI;
use Bio::Phylo::PhyloWS::Service::Tolweb;

my $cgi = CGI->new;
my $service = Bio::Phylo::PhyloWS::Service::Tolweb->new( '-url' => $url );
$service->handle_request($cgi);

DESCRIPTION

This is an example implementation of a PhyloWS service. The service wraps around the tree of life XML service and returns project objects that include the focal node (identified by its PhyloWS ID) and the nearest child and parent nodes that have web pages.

METHODS

ACCESSORS

get_record()

Gets a tolweb record by its id

Type    : Accessor
Title   : get_record
Usage   : my $record = $obj->get_record( -guid => $guid );
Function: Gets a tolweb record by its id
Returns : Bio::Phylo::Project
Args    : Required: -guid => $guid
Comments: The guid is of the form 'tree/Tolweb:\d+'
get_redirect()

Gets a redirect URL if relevant

Type    : Accessor
Title   : get_redirect
Usage   : my $url = $obj->get_redirect;
Function: Gets a redirect URL if relevant
Returns : String
Args    : $cgi
Comments: This method is called by handle_request so that
          services can 303 redirect a record lookup to 
          another URL. By default, this method returns 
          undef (i.e. no redirect), but if this implementation
          is called to handle a request that specifies 
          'format=html' the request is forwarded to the
          appropriate page on the http://tolweb.org website
get_supported_formats()

Gets an array ref of supported formats

Type    : Accessor
Title   : get_supported_formats
Usage   : my @formats = @{ $obj->get_supported_formats };
Function: Gets an array ref of supported formats
Returns : [ qw(nexml nexus newick html) ]
Args    : NONE

SEE ALSO

Also see the manual: Bio::Phylo::Manual and http://rutgervos.blogspot.com

REVISION

$Id: Phylo.pm 1045 2009-05-28 22:48:16Z rvos $