xml::dom::namednodemap(3pm) [debian man page]
XML::DOM::NamedNodeMap(3pm) User Contributed Perl Documentation XML::DOM::NamedNodeMap(3pm) NAME
XML::DOM::NamedNodeMap - A hash table interface for XML::DOM DESCRIPTION
Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name. Note that NamedNodeMap does not inherit from NodeList; NamedNodeMaps are not maintained in any particular order. Objects contained in an object implementing NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a NamedNodeMap, and does not imply that the DOM specifies an order to these Nodes. Note that in this implementation, the objects added to a NamedNodeMap are kept in order. METHODS getNamedItem (name) Retrieves a node specified by name. Return Value: A Node (of any type) with the specified name, or undef if the specified name did not identify any node in the map. setNamedItem (arg) Adds a node using its nodeName attribute. As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased. Parameters: arg A node to store in a named node map. The node will later be accessible using the value of the nodeName attribute of the node. If a node with that name is already present in the map, it is replaced by the new one. Return Value: If the new Node replaces an existing node with the same name the previously existing Node is returned, otherwise undef is returned. DOMExceptions: * WRONG_DOCUMENT_ERR Raised if arg was created from a different document than the one that created the NamedNodeMap. * NO_MODIFICATION_ALLOWED_ERR Raised if this NamedNodeMap is readonly. * INUSE_ATTRIBUTE_ERR Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. removeNamedItem (name) Removes a node specified by name. If the removed node is an Attr with a default value it is immediately replaced. Return Value: The node removed from the map or undef if no node with such a name exists. DOMException: * NOT_FOUND_ERR Raised if there is no node named name in the map. item (index) Returns the indexth item in the map. If index is greater than or equal to the number of nodes in the map, this returns undef. Return Value: The node at the indexth position in the NamedNodeMap, or undef if that is not a valid index. getLength Returns the number of nodes in the map. The range of valid child node indices is 0 to length-1 inclusive. Additional methods not in the DOM Spec getValues Returns a NodeList with the nodes contained in the NamedNodeMap. The NodeList is "live", in that it reflects changes made to the NamedNodeMap. When this method is called in a list context, it returns a regular perl list containing the values. Note that this list is not "live". E.g. @list = $map->getValues; # returns a perl list $nodelist = $map->getValues; # returns a NodeList (object ref.) for my $val ($map->getValues) # iterate over the values getChildIndex (node) Returns the index of the node in the NodeList as returned by getValues, or -1 if the node is not in the NamedNodeMap. dispose Removes all circular references in this NamedNodeMap and its descendants so the objects can be claimed for garbage collection. The objects should not be used afterwards. perl v5.8.8 2008-02-03 XML::DOM::NamedNodeMap(3pm)
Check Out this Related Man Page
ELEMENT(1) User Contributed Perl Documentation ELEMENT(1) NAME
XML::DOM::Element - An XML element node in XML::DOM DESCRIPTION
XML::DOM::Element extends XML::DOM::Node. By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element nodes. Assume the fol- lowing XML document: <elementExample id="demo"> <subelement1/> <subelement2><subsubelement/></subelement2> </elementExample> When represented using DOM, the top node is an Element node for "elementExample", which contains two child Element nodes, one for "subele- ment1" and one for "subelement2". "subelement1" contains no child nodes. Elements may have attributes associated with them; since the Element interface inherits from Node, the generic Node interface method getAt- tributes may be used to retrieve the set of all attributes for an element. There are methods on the Element interface to retrieve either an Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience. METHODS getTagName The name of the element. For example, in: <elementExample id="demo"> ... </elementExample> tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. getAttribute (name) Retrieves an attribute value by name. Return Value: The Attr value as a string, or the empty string if that attribute does not have a specified or default value. setAttribute (name, value) Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute. DOMExceptions: o INVALID_CHARACTER_ERR Raised if the specified name contains an invalid character. o NO_MODIFICATION_ALLOWED_ERR Raised if this node is readonly. removeAttribute (name) Removes an attribute by name. If the removed attribute has a default value it is immediately replaced. DOMExceptions: o NO_MODIFICATION_ALLOWED_ERR Raised if this node is readonly. getAttributeNode Retrieves an Attr node by name. Return Value: The Attr node with the specified attribute name or undef if there is no such attribute. setAttributeNode (attr) Adds a new attribute. If an attribute with that name is already present in the element, it is replaced by the new one. Return Value: If the newAttr attribute replaces an existing attribute with the same name, the previously existing Attr node is returned, otherwise undef is returned. DOMExceptions: o WRONG_DOCUMENT_ERR Raised if newAttr was created from a different document than the one that created the element. o NO_MODIFICATION_ALLOWED_ERR Raised if this node is readonly. o INUSE_ATTRIBUTE_ERR Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. removeAttributeNode (oldAttr) Removes the specified attribute. If the removed Attr has a default value it is immediately replaced. If the Attr already is the default value, nothing happens and nothing is returned. Parameters: oldAttr The Attr node to remove from the attribute list. Return Value: The Attr node that was removed. DOMExceptions: o NO_MODIFICATION_ALLOWED_ERR Raised if this node is readonly. o NOT_FOUND_ERR Raised if oldAttr is not an attribute of the element. Additional methods not in the DOM Spec setTagName (newTagName) Sets the tag name of the Element. Note that this method is not portable between DOM implementations. DOMExceptions: o INVALID_CHARACTER_ERR Raised if the specified name contains an invalid character. check ($checker) Uses the specified XML::Checker to validate the document. NOTE: an XML::Checker must be supplied. The checker can be created in different ways, e.g. when parsing a document with XML::DOM::ValParser, or with XML::DOM::Document::createChecker(). See XML::Checker for more info. perl v5.8.0 2000-01-31 ELEMENT(1)