Bio::Phylo::PhyloWS - Base class for phylogenetic web services


NAME

Bio::Phylo::PhyloWS - Base class for phylogenetic web services


SYNOPSIS

 # no direct usage, used by child classes


DESCRIPTION

This is the base class for clients and service that implement the PhyloWS (http://evoinfo.nescent.org/PhyloWS) recommendations. This base class isn't used directly, it contains useful methods that are inherited by its children.


METHODS

CONSTRUCTOR

new()

The Bio::Phylo::PhyloWS constructor is rarely used directly. Rather, many other objects in Bio::Phylo::PhyloWS internally go up the inheritance tree to this constructor. The arguments shown here can therefore also be passed to any of the child classes' constructors, which will pass them on up the inheritance tree. Generally, constructors in Bio::Phylo::PhyloWS subclasses can process as arguments all methods that have set_* in their names. The arguments are named for the methods, but "set_" has been replaced with a dash "-", e.g. the method "set_name" becomes the argument "-name" in the constructor.

 Type    : Constructor
 Title   : new
 Usage   : my $phylows = Bio::Phylo::PhyloWS->new( -url => $url );
 Function: Instantiates Bio::Phylo::PhyloWS object
 Returns : a Bio::Phylo::PhyloWS object 
 Args    : Required: -url => $url
           Optional: any number of setters. For example,
                   Bio::Phylo::PhyloWS->new( -name => $name )
                   will call set_name( $name ) internally

MUTATORS

set_url()

Sets invocant url.

 Type    : Mutator
 Title   : set_url
 Usage   : $obj->set_url($url);
 Function: Assigns an object's url.
 Returns : Modified object.
 Args    : Argument must be a string.

ACCESSORS

get_url()

Gets invocant's url.

 Type    : Accessor
 Title   : get_url
 Usage   : my $url = $obj->get_url;
 Function: Returns the object's url.
 Returns : A string
 Args    : None


SEE ALSO

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


REVISION

 $Id: Phylo.pm 1045 2009-05-28 22:48:16Z rvos $
 Bio::Phylo::PhyloWS - Base class for phylogenetic web services