This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

XPath::NodeSet(3)                    User Contributed Perl Documentation                   XPath::NodeSet(3)



NAME
       XML::XPath::NodeSet - a list of XML document nodes

DESCRIPTION
       An XML::XPath::NodeSet object contains an ordered list of nodes. The nodes each take the same format
       as described in XML::XPath::XMLParser.

SYNOPSIS
               my $results = $xp->find('//someelement');
               if (!$results->isa('XML::XPath::NodeSet')) {
                       print "Found $results\n";
                       exit;
               }
               foreach my $context ($results->get_nodelist) {
                       my $newresults = $xp->find('./other/element', $context);
                       ...
               }

API
       new()

       You will almost never have to create a new NodeSet object, as it is all done for you by XPath.

       get_nodelist()

       Returns a list of nodes. See XML::XPath::XMLParser for the format of the nodes.

       string_value()

       Returns the string-value of the first node in the list.  See the XPath specification for what
       "string-value" means.

       to_literal()

       Returns the concatenation of all the string-values of all the nodes in the list.

       get_node($pos)

       Returns the node at $pos. The node position in XPath is based at 1, not 0.

       size()

       Returns the number of nodes in the NodeSet.

       pop()

       Equivalent to perl's pop function.

       push(@nodes)

       Equivalent to perl's push function.

       append($nodeset)

       Given a nodeset, appends the list of nodes in $nodeset to the end of the current list.

       shift()

       Equivalent to perl's shift function.

       unshift(@nodes)

       Equivalent to perl's unshift function.

       prepend($nodeset)

       Given a nodeset, prepends the list of nodes in $nodeset to the front of the current list.



perl v5.8.8                                      2002-09-02                                XPath::NodeSet(3)