MAN page from Mandrake Other perl-XML-Grove-0.05-1.i386.rpm

lib::XML::Grove::Iter

Section: User Contributed Perl Documentation (3)
Updated: perl 5.004, patch 04
Index

NAME

XML::Grove::Iter - add tree iteration methods to XML objects

SYNOPSIS

 use XML::Grove::Iter;

 $iter = $xml_object->iter;

 $iter2 = $iter->parent; $iter2 = $iter->next; $iter2 = $iter->previous;

 $iter2 = $element_iter->first_child; $iter2 = $element_iter->last_child; $iter2 = $element_iter->attr_first ($attr); $iter2 = $element_iter->attr_last ($attr);

 $obj = $iter->delegate; $root = $iter->root; @path = $iter->rootpath;

 $bool = $iter->is_iter; $bool = $iter->is_same ($obj); $bool = $iter->at_last; $bool = $iter->at_first;

DESCRIPTION

XML::Grove::Iter is a proxy-based tree iterator. ``Proxy based''means that the iterator ``stands in'' for the real object and is usedas you would normally use the real object. The iterator handlesmoving around the tree and forwards all other methods to the realobject.

`parent' returns the parent iterator of this iterator, or`undef' if this is the root iterator. `next' and `previous'return the iterator of the next object or the previous object,respectively, in the parent's content (the sibling objects), or`undef' if there is no next or previous sibling.

`first_child' and `last_child' return the iterator of the firstchild or the last child of the contents of this element or document.`attr_first' and `attr_last' return the iterator of the firstchild or last child of the named attribute. These all return`undef' if the contents are empty.

`delegate' returns the object that this iterator stands-in for,``the delegate''.

`root' returns the iterator of the top-most object of the sub-treebeing iterated. Note that this may not be the root of the documenttree if the first iterator was created using a nested object.

`rootpath' returns a list of the parent iterators between andincluding the root and this iterator.

`is_iter' returns true if this object is an iterator. Ordinary XMLobjects have been extended with an `is_iter' method that returnsfalse.

`is_same' returns true if `$obj' is this iterator's delegate, orif `$obj' is an iterator that points to the same delegate.

`at_last' and `at_first' return true if calling `next' or`previous', respectively, would return `undef'. Or in otherwords, they return true if this iterator is at the end or thebeginning of the parent element's content.

AUTHOR

Ken MacLeod, kenAATTbitsko.slc.ut.us

This document was created byman2html,using the manual pages.