shirirules > WebService-GData-0.0501 > WebService::GData::Node

Download:
WebService-GData-0.0501.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0103   Source   Latest Release: WebService-GData-0.06

NAME ^

WebService::GData::Node - Abstract class representing an xml node/tag

SYNOPSIS ^

   #your package should use the abstract Node package.
   #it will automaticly inherit from it.
   
   #Author.pm files:
   use WebService::GData::Node::Author;
   use WebService::GData::Node;
   
   1;
   
   #Name.pm
   use WebService::GData::Node::Name;
   use WebService::GData::Node;  
   
   1; 
   
   #Category.pm
   package WebService::GData::Node::Category;
   use WebService::GData::Node;

   set_meta(
        attributes=>['scheme','yt:term','label'],#default to []
        is_parent => 0, #default 1
        namespace_prefix => 'k', #default to ''
        namespace_uri    =>'http://wwww.k.org/2010',#default to ''
        tag_name  => 'category' # default to the package file name with the first letter in lower case,
        extra_namespaces=>{'yt'=>'http://...'} #set namespace at the attribute level here
   );

   1;

    #user code:
        use WebService::GData::Node::Name();  #avoid to inherit from it by not importing
        use WebService::GData::Node::Author();
        use WebService::GData::Node::Category();
                
    my $author   = new WebService::GData::Node::Author();
    my $name     = new WebService::GData::Node::Name(text=>'john doe');
    my $category = new WebService::GData::Node::Category(scheme=>'author','yt:term'=>'Author');
    
    #or coming from a json feed:
    my $category = new WebService::GData::Node::Category({scheme=>'author','yt$term'=>'Author'});
    
    
    
    $author->child($name)->child($category);
    
    $name->text;#john doe
    $category->scheme;#author;
    $category->scheme('compositor');
    $category->term('Media');

DESCRIPTION ^

inherits from WebService::GData

This package is an abstract class representing the information required to serialize a node object into xml or any other appropriate format.

You should subclass and set the meta information via the set_meta function that will be installed in your package (see below for further explanation). You can instantiate this class if you want... it will not throw any error but you won't be able to do much.

A node is only the representation of one xml tag. Feed and Feed subclasses are the representation of an entire JSON response or offers a subset.

See also:

CONSTRUCTOR

new

Create an instance but you won't be able to do much as no meaningful meta data has been set. You should inherit from this class.

Parameters

args:Hash (optional) - all the xml attributes can be set here. text nodes requires the "text" key. or
args:HashRef (optional) - all the node attributes can be set here. text nodes requires the "text" key and the '$t' key is also supported as an alias for 'text' for compatibily with the GData JSON responses.

Returns

WebService::GData::Node

Example:

    use WebService::GData::Node;
        
    my $node   = new WebService::GData::Node(text=>'hi');
    
       $node->text();#hi;
       
   print WebService::GData::Serialize->to_xml($node);"<>hi<>"; #this is an abstract node!

AUTOLOAD

__set/__get

The attributes setter/getters and the text method are generated on the fly.

METHODS

child

Set an other node child of the instance. It returns the instance so you can chain the calls. You can not set the instance as a child of itself. The child method checks against the memory slot of the object and will return the instance without setting the object if it appears to be the same.

Parameters

node:WebService::GData::Node - a node instance inheriting from this class.

Returns

instance:WebService::GData::Node - you can chain the call

Example:

    my $author   = new WebService::GData::Node::Author();
    my $name     = new WebService::GData::Node::Name(text=>'john doe');
    my $category = new WebService::GData::Node::Category(scheme=>'author',term=>'Author');
    
    $author->child($name)->child($category);
    
    #the same object can not be a child of itself. which makes sense.
    #it just silently returns the instance.
    $author->child($author);

swap

This method will put a new instance instead of an existing child.

Parameters

oldchild::WebService::GData::Node|WebService::GData::Collection - the node to remove in the children collection
newchild::WebService::GData::Node|WebService::GData::Collection - the node to put instead

Returns

Cnone>

Example:

    my $author   = new WebService::GData::Node::Author();
    my $name     = new WebService::GData::Node::Name(text=>'john doe');
    my $category = new WebService::GData::Node::Category(scheme=>'author',term=>'Author');
    
    $author->child($name)->child($category);
    
    my $newname = new WebService::GData::Node::Name(text=>'billy doe');
    $author->swap($name,$newname);

STATIC GETTER METHODS

The following methods are installed by default in the package subclassing this class. You should set their value via the set_meta method (see below).

namespace_prefix

namespace_uri

node_name

attributes

is_parent

extra_namespaces

INHERITANCE

The package will push itself in the inheritance chain automaticly when you use it so it is not necessary to explicitly declare the inheritance. As a consequence though, every sub classes that are used will also automaticly set themself in the inheritance chain of the user. In order to avoid this behavior you should write:

    use WebService::GData::Node(); 

The following function will be accessible in the sub class.

set_meta

Set the meta data of the node.

Parameters

args::Hash
namespace_uri:Scalar - the namespace uri. Most of the time a web url ...
namespace_prefix:Scalar - the namespace name of the node, ie, yt:, media: ...
extra_namespaces:HashRef - Node only supports namespaces at the node level. You can add extra namespaces here if set at the attribute level. the key is the namespace_prefix and the value the namespace_uri.
node_name:Scalar - the name of the node it self, ie, category, author...
attributes:ArrayRef - a list of the node attributes, ie, src, scheme... Default: []
is_parent:Int - specify if the node can accept children, including text node. Default: 1 (true),0 if not.

Returns install the methods in the package.

none

Example:

   #Category.pm
   package WebService::GData::Node::Category;
   use WebService::GData::Node;

   set_meta(
        attributes=>['scheme','yt:term','label'],#default to []
        is_parent => 0, #default 1
        namespace_prefix => 'k', #default to ''
        tag_name  => 'category' # default to the package file name with the first letter in lower case
   );

   1;
   
   use WebService::GData::Node::Category();
   
   my $category = new WebService::GData::Node::Category('yt:term'=>'term');
      $category->yt_term('youtube term');

IMPLEMENTED NODES

Many core nodes have already be implemented. You can look at their source directly to see their meta information. Although you may use this class and subclasses to implement other tags, most of the time they will be wrapped in the Feed packages and the end user shall not interact directly with them.

For reference, below is a list of all the tags implemented so far with their meta information (when it overwrites the default settings).

    APP                         #app: namespace
        - Control
        - Draft
        - Edited
        
    Atom                        #atom: namespace
        - Author
        - Category              #attributes=>scheme term label
        - Content               #attributes=>src type
        - Entry                 #attributes => gd:etag
        - Feed                  #attributes => gd:etag
        - Generator             #attributes => version uri
        - Id
        - Link                  #attributes=>rel type href
        - Logo
        - Name
        - Summary
        - Title
        - Updated
        - Uri
        
    GD                           #gd: namespace
        - AditionalName          #attributes=> yomi
        - Agent
        - AttendeeStatus         #attributes=>value,is_parent=>0
        - attendeeType           #attributes=>value,is_parent=>0
        - City
        - Comments               #attributes=>rel
        - Country                #attributes=>code
        - Deleted                #is_parent=>0
        - Email                  #attributes=>address displayName label rel primary
        - EntryLink              #attributes=>href readOnly rel
        - EventStatus            #attributes=>value,is_parent=>0
        - ExtendedProperty       #attributes=>name value
        - FamilyName             #attributes=>yomi
        - FeedLink               #attributes=>rel href countHint,is_parent=>0
        - FormattedAddress
        - GivenName              #attributes=> yomi
        - Housename
        - Im                     #attributes=>address label rel protocol primary
        - Money                  #attributes=>amount currencyCode,is_parent=>0
        - Name
        - Neighborhood
        - Organization           #attributes=>label primary rel
        - OrgDepartment
        - OrgJobDescription
        - OrgName                #attributes=>yomi
        - OrgSymbol
        - OrgTitle
        - OriginalEvent          #attributes=>id href
        - PhoneNumber            #attributes=>label rel uri primary
        - Pobox
        - PostalAddress          #attributes=>label rel primary
        - Postcode
        - Rating                 #attributes=>min max numRaters average value rel,is_parent=>0
        - Recurrence
        - RecurrenceException    #attributes=>specialized
        - Region
        - Reminder               #attributes=>absoluteTime method days hours minutes,is_parent=>0
        - Resourceid
        - Street
        - StructuredPostalAddress #attributes=>rel mailClass usage label primary
        - Subregion
        - Transparency            #attributes=>value,is_parent=>0
        - Visibility              #attributes=>value,is_parent=>0
        - When                    #attributes=>endTime startTime valueString,is_parent=>0
        - Where                   #attributes=>label rel valueString
        - Who                     #attributes=>email rel valueString
       
    GeoRSS                      #georss: namespace
       - Where
       
    GML                         #gml: namespace
       - Point                  #tag_name=>'Point'
       - Pos
       
    Media                       #media: namespace
       - Category               #attributes=>scheme label
       - Content                #attributes=>url type medium isDefault expression duration,is_parent=>0
       - Credit                 #attributes=>role yt:type scheme
       - Description            #attributes=>type
       - Group
       - Keywords
       - Player                 #attributes=>url
       - Rating                 #attributes=>scheme country
       - Restriction            #attributes=>type relationship
       - Thumbnail              #attributes=>url height width time, is_parent=>0
       - Title                  #attributes=>type
       
    OpenSearch                  #openSearch: namespace
       - ItemsPerPage             
       - StartIndex                
       - TotalResults                 

CAVEATS

BUGS AND LIMITATIONS ^

If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!

AUTHOR ^

shiriru <shirirulestheworld[arobas]gmail.com>

LICENSE AND COPYRIGHT ^

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: