GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIO::PHYLO::NEXML::DOM::DOCUMENT::LIBXML (3)

.ds Aq ’

NAME

Bio::Phylo::NeXML::DOM::Document::Libxml - XML DOM document mappings to the "XML::LibXML" package

CONTENTS

SYNOPSIS

Don’t use directly; use Bio::Phylo::NeXML::DOM->new( -format => ’libxml’ ) instead.

DESCRIPTION

This module provides mappings the methods specified in the Bio::Phylo::NeXML::DOM::Document abstract class to the XML::LibXML::Document package.

AUTHOR

Mark A. Jensen ( maj -at- fortinbras -dot- us )

    Constructor

new()


 Type    : Constructor
 Title   : new
 Usage   : $doc = Bio::Phylo::NeXML::DOM::Document->new(@args)
 Function: Create a Document object using the underlying package
 Returns : Document object or undef on fail
 Args    : Package-specific arguments



parse_document()


 Type    : Factory method
 Title   : parse_document
 Usage   : $doc = $dom->parse_document($text)
 Function: Create a new XML DOM document from XML text
 Returns : DOM document
 Args    : An XML String



    Document property accessors/mutators

set_encoding()


 Type    : Mutator
 Title   : set_encoding
 Usage   : $doc->set_encoding($enc)
 Function: Set encoding for document
 Returns : True on success
 Args    : Encoding descriptor as string



get_encoding()


 Type    : Accessor
 Title   : get_encoding
 Usage   : $doc->get_encoding()
 Function: Get encoding for document
 Returns : Encoding descriptor as string
 Args    : none



set_root()


 Type    : Mutator
 Title   : set_root
 Usage   : $doc->set_root($elt)
 Function: Set the documents root element
 Returns : True on success
 Args    : Element object



get_root()


 Type    : Accessor
 Title   : get_root
 Usage   : $doc->get_root()
 Function: Get the documents root element
 Returns : Element object or undef if DNE
 Args    : none



    Document element accessors

get_element_by_id()


 Type    : Accessor
 Title   : get_element_by_id
 Usage   : $doc->get_element_by_id($id)
 Function: Get element having id $id
 Returns : Element object or undef if DNE
 Args    : id designator as string



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
 Returns : Array of elements or undef if no match
 Args    : tag name as string



    Output methods

to_xml()


 Type    : Serializer
 Title   : to_xml
 Usage   : $doc->to_xml
 Function: Create XML string from document
 Returns : XML string
 Args    : Formatting arguments as allowed by underlying package



CITATION

If you use Bio::Phylo in published research, please cite it:

<B>Rutger A VosB>, <B>Jason CaravasB>, <B>Klaas HartmannB>, <B>Mark A JensenB> and <B>Chase MillerB>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. BMC Bioinformatics <B>12B>:63. <http://dx.doi.org/10.1186/1471-2105-12-63>

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 BIO::PHYLO::NEXML::DOM::DOCUMENT::LIBXML (3) 2014-02-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.