| Bio::Phylo::Util::DOM::Element::twig - XML DOM mappings to the |
Bio::Phylo::Util::DOM::Element::twig - XML DOM mappings to the
XML::Twig package
Don't use directly; use Bio::Phylo::Util::DOM->new( -format => 'twig' ) instead.
This module provides mappings the methods specified in the the Bio::Phylo::Util::DOM::ElementI manpage interface.
Mark A. Jensen ( maj -at- fortinbras -dot- us )
new()
Type : Constructor
Title : new
Usage : $elt = Bio::Phylo::Util::DOM::Element->new($tag, $attr)
Function: Create a new XML DOM element
Returns : DOM element object
Args : Optional:
$tag - tag name as string
$attr - hashref of attributes/values
get_tagname()
Type : Accessor Title : get_tagname Usage : $elt->get_tagname() Function: Get tag name Returns : Tag name as scalar string Args : none
set_tagname()
Type : Mutator Title : set_tagname Usage : $elt->set_tagname( $tagname ) Function: Set tagname Returns : True on success Args : Tag name as scalar string
get_attributes()
Type : Accessor Title : get_attributes Usage : $elt->get_attributes( @attribute_names ) Function: Get attribute values Returns : Array of attribute values Args : [an array of] attribute name[s] as string[s]
set_attributes()
Type : Mutator Title : set_attributes Usage : $elt->set_attributes( @attribute_assoc_array ) Function: Set attribute values Returns : True on success Args : An associative array of form ( $name => $value, ... )
clear_attributes()
Type : Mutator Title : clear_attributes Usage : $elt->clear_attributes( @attribute_names ) Function: Remove attributes from element Returns : Hash of removed attributes/values Args : Array of attribute names
Type : Title : Usage : Function: Returns : Args :
set_text()
Type : Mutator Title : set_text Usage : $elt->set_text($text_content) Function: Add a #TEXT node to the element Returns : True on success Args : scalar string
get_text()
Type : Accessor Title : get_text Usage : $elt->get_text() Function: Retrieve direct #TEXT descendants as (concatenated) string Returns : scalar string (the text content) Args : none
clear_text()
Type : Mutator Title : clear_text Usage : $elt->clear_text() Function: Remove direct #TEXT descendant nodes from element Returns : True on success; false if no #TEXT nodes removed Args : none
get_parent()
Type : Accessor Title : get_parent Usage : $elt->get_parent() Function: Get parent DOM node of invocant Returns : Element object or undef if invocant is root Args : none
get_children()
Type : Accessor Title : get_children Usage : $elt->get_children() Function: Get child nodes of invocant Returns : Array of Elements Args : none
get_first_child()
Type : Accessor Title : get_first_child Usage : $elt->get_first_child() Function: Get first child (as defined by underlying package) of invocant Returns : Element object or undef if invocant is childless Args : none
get_last_child()
Type : Accessor Title : get_last_child Usage : $elt->get_last_child() Function: Get last child (as defined by underlying package) of invocant Returns : Element object or undef if invocant is childless Args : none
get_next_sibling()
Type : Accessor Title : get_next_sibling Usage : $elt->get_next_sibling() Function: Gets next sibling (as defined by underlying package) of invocant Returns : Element object or undef if invocant is the rightmost element Args : none
get_prev_sibling()
Type : Accessor Title : get_prev_sibling Usage : $elt->get_prev_sibling() Function: Get previous sibling (as defined by underlying package) of invocant Returns : Element object or undef if invocant is leftmost element Args : none
get_elements_by_tagname()
Type : Accessor
Title : get_elements_by_tagname
Usage : $elt->get_elements_by_tagname($tagname)
Function: Get array of elements having given tag name from invocant's
descendants
Returns : Array of elements or undef if no match
Args : tag name as string
set_child()
Type : Mutator Title : set_child Usage : $elt->set_child($child) Function: Add child element object to invocant's descendants Returns : the element object added Args : Element object
prune_child()
Type : Mutator
Title : prune_child
Usage : $elt->prune_child($child)
Function: Remove the subtree rooted by $child from among the invocant's
descendants
Returns : $child or undef if $child is not among the children of invocant
Args : Element object
to_xml_string()
Type : Serializer Title : to_xml_string Usage : $elt->to_xml_string Function: Create XML string from subtree rooted by invocant Returns : XML string Args : Formatting arguments as allowed by underlying package
| Bio::Phylo::Util::DOM::Element::twig - XML DOM mappings to the |