Package org.smooks.engine.delivery.sax.ng.org.apache.xerces.dom

Class NamedNodeMapImpl

  • All Implemented Interfaces:
    Serializable, NamedNodeMap
    Direct Known Subclasses:
    AttributeMap
    public class NamedNodeMapImpl
extends Object
implements NamedNodeMap, Serializable
    NamedNodeMaps represent collections of Nodes that can be accessed by name. Entity and Notation nodes are stored in NamedNodeMaps attached to the DocumentType. Attributes are placed in a NamedNodeMap attached to the elem they're related too. However, because attributes require more work, such as firing mutation events, they are stored in a subclass of NamedNodeMapImpl.

    Only one Node may be stored per name; attempting to store another will replace the previous value.

    NOTE: The "primary" storage key is taken from the NodeName attribute of the node. The "secondary" storage key is the namespaceURI and localName, when accessed by DOM level 2 nodes. All nodes, even DOM Level 2 nodes are stored in a single ArrayList sorted by the primary "nodename" key.

    NOTE: item()'s integer index does _not_ imply that the named nodes must be stored in an array; that's only an access method. Note too that these indices are "live"; if someone changes the map's contents, the indices associated with nodes may change.

    Since:
    PR-DOM-Level-1-19980818.
    Version:
    $Id$
    See Also:
    Serialized Form

    • Constructor Detail

      • NamedNodeMapImpl

        protected NamedNodeMapImpl​(NodeImpl ownerNode)
        Constructs a named node map.

    • Method Detail

      • getLength

        public int getLength()
        Report how many nodes are currently stored in this NamedNodeMap. Caveat: This is a count rather than an index, so the highest-numbered node at any time can be accessed via item(getLength()-1).
        Specified by:
        getLength in interface NamedNodeMap

      • item

        public Node item​(int index)
        Retrieve an item from the map by 0-based index.
        Specified by:
        item in interface NamedNodeMap
        Parameters:
        index - Which item to retrieve. Note that indices are just an enumeration of the current contents; they aren't guaranteed to be stable, nor do they imply any promises about the order of the NamedNodeMap's contents. In other words, DO NOT assume either that index(i) will always refer to the same entry, or that there is any stable ordering of entries... and be prepared for double-reporting or skips as insertion and deletion occur.
        Returns:
        the node which currenly has the specified index, or null if index is greater than or equal to getLength().

      • getNamedItem

        public Node getNamedItem​(String name)
        Retrieve a node by name.
        Specified by:
        getNamedItem in interface NamedNodeMap
        Parameters:
        name - Name of a node to look up.
        Returns:
        the Node (of unspecified sub-class) stored with that name, or null if no value has been assigned to that name.

      • getNamedItemNS

        public Node getNamedItemNS​(String namespaceURI,
                           String localName)
        Introduced in DOM Level 2.

        Retrieves a node specified by local name and namespace URI.

        Specified by:
        getNamedItemNS in interface NamedNodeMap
        Parameters:
        namespaceURI - The namespace URI of the node to retrieve. When it is null or an empty string, this method behaves like getNamedItem.
        localName - The local name of the node to retrieve.
        Returns:
        Node A Node (of any type) with the specified name, or null if the specified name did not identify any node in the map.

      • setNamedItem

        public Node setNamedItem​(Node arg)
                  throws DOMException
        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.
        Specified by:
        setNamedItem in interface NamedNodeMap
        Parameters:
        arg - A node to store in a named node map. The node will later be accessible using the value of the namespaceURI and localName attribute of the node. If a node with those namespace URI and local name is already present in the map, it is replaced by the new one.
        Returns:
        If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.
        Throws:
        DOMException - The exception description.
        See Also:
        NamedNodeMap.setNamedItem(org.w3c.dom.Node)

      • setNamedItemNS

        public Node setNamedItemNS​(Node arg)
                    throws DOMException
        Adds a node using its namespaceURI and localName.
        Specified by:
        setNamedItemNS in interface NamedNodeMap
        Parameters:
        arg - A node to store in a named node map. The node will later be accessible using the value of the namespaceURI and localName attribute of the node. If a node with those namespace URI and local name is already present in the map, it is replaced by the new one.
        Returns:
        If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.
        Throws:
        DOMException
        See Also:
        NamedNodeMap.setNamedItem(org.w3c.dom.Node)

      • removeNamedItemNS

        public Node removeNamedItemNS​(String namespaceURI,
                              String name)
                       throws DOMException
        Introduced in DOM Level 2.

        Removes a node specified by local name and namespace URI.

        Specified by:
        removeNamedItemNS in interface NamedNodeMap
        Parameters:
        namespaceURI - The namespace URI of the node to remove. When it is null or an empty string, this method behaves like removeNamedItem.
        name - The local name of the node to remove.
        Returns:
        Node The node removed from the map if a node with such a local name and namespace URI exists.
        Throws:
        DOMException

      • cloneMap

        public NamedNodeMapImpl cloneMap​(NodeImpl ownerNode)
        Cloning a NamedNodeMap is a DEEP OPERATION; it always clones all the nodes contained in the map.

      • setOwnerDocument

        protected void setOwnerDocument​(CoreDocumentImpl doc)
        NON-DOM set the ownerDocument of this node, and the attributes it contains

      • findNamePoint

        protected int findNamePoint​(String name,
                            int start)
        Subroutine: Locate the named item, or the point at which said item should be added.
        Parameters:
        name - Name of a node to look up.
        Returns:
        If positive or zero, the index of the found item. If negative, index of the appropriate point at which to insert the item, encoded as -1-index and hence reconvertable by subtracting it from -1. (Encoding because I don't want to recompare the strings but don't want to burn bytes on a datatype to hold a flagged value.)

      • findNamePoint

        protected int findNamePoint​(String namespaceURI,
                            String name)
        This findNamePoint is for DOM Level 2 Namespaces.

      • precedes

        protected boolean precedes​(Node a,
                           Node b)

      • removeItem

        protected void removeItem​(int index)
        NON-DOM: Remove attribute at specified index

      • getItem

        protected Object getItem​(int index)

      • addItem

        protected int addItem​(Node arg)

      • cloneMap

        protected ArrayList cloneMap​(ArrayList list)
        NON-DOM: copy content of this map into the specified ArrayList
        Parameters:
        list - ArrayList to copy information into.
        Returns:
        A copy of this node named map

      • getNamedItemIndex

        protected int getNamedItemIndex​(String namespaceURI,
                                String localName)

      • removeAll

        public void removeAll()
        NON-DOM remove all elements from this map