NAME

Bio::Phylo::PhyloWS::Resource - Represents a PhyloWS web resource

SYNOPSIS

 # no direct usage

DESCRIPTION

This class represents a resource on the web that implements the PhyloWS recommendations.

METHODS

CONSTRUCTOR

new()

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

MUTATORS

set_guid()

Sets invocant guid.

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

set_format()

Sets invocant's preferred serialization format.

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

ACCESSORS

get_guid()

Gets invocant's guid.

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

get_format()

Gets invocant's preferred serialization format

 Type    : Accessor
 Title   : get_format
 Usage   : my $format = $obj->get_format;
 Function: Returns the object's preferred serialization format
 Returns : A string
 Args    : None

get_full_url()

Gets invocant's full url (i.e. including query string)

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

TESTS

is_identifiable()

Tests if invocant has an xml id attribute

 Type    : Test
 Title   : is_identifiable
 Usage   : if ( $obj->is_identifiable ) {
              # do something
           }
 Function: Tests if invocant has an xml id attribute
 Returns : FALSE
 Args    : NONE

SERIALIZERS

to_xml()

Serializes resource to RSS1.0 XML representation

 Type    : Serializer
 Title   : to_xml()
 Usage   : print $obj->to_xml();
 Function: Serializes object to RSS1.0 XML string
 Returns : String 
 Args    : None
 Comments:

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 $