001: /*
002: * Copyright (c) 2000 World Wide Web Consortium,
003: * (Massachusetts Institute of Technology, Institut National de
004: * Recherche en Informatique et en Automatique, Keio University). All
005: * Rights Reserved. This program is distributed under the W3C's Software
006: * Intellectual Property License. This program is distributed in the
007: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009: * PURPOSE.
010: * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
011: */
012:
013: package org.w3c.dom;
014:
015: /**
016: * Objects implementing the <code>NamedNodeMap</code> interface are used to
017: * represent collections of nodes that can be accessed by name. Note that
018: * <code>NamedNodeMap</code> does not inherit from <code>NodeList</code>;
019: * <code>NamedNodeMaps</code> are not maintained in any particular order.
020: * Objects contained in an object implementing <code>NamedNodeMap</code> may
021: * also be accessed by an ordinal index, but this is simply to allow
022: * convenient enumeration of the contents of a <code>NamedNodeMap</code>,
023: * and does not imply that the DOM specifies an order to these Nodes.
024: * <p><code>NamedNodeMap</code> objects in the DOM are live.
025: * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
026: */
027: public interface NamedNodeMap {
028: /**
029: * Retrieves a node specified by name.
030: * @param nameThe <code>nodeName</code> of a node to retrieve.
031: * @return A <code>Node</code> (of any type) with the specified
032: * <code>nodeName</code>, or <code>null</code> if it does not identify
033: * any node in this map.
034: */
035: public Node getNamedItem(String name);
036:
037: /**
038: * Adds a node using its <code>nodeName</code> attribute. If a node with
039: * that name is already present in this map, it is replaced by the new
040: * one.
041: * <br>As the <code>nodeName</code> attribute is used to derive the name
042: * which the node must be stored under, multiple nodes of certain types
043: * (those that have a "special" string value) cannot be stored as the
044: * names would clash. This is seen as preferable to allowing nodes to be
045: * aliased.
046: * @param argA node to store in this map. The node will later be
047: * accessible using the value of its <code>nodeName</code> attribute.
048: * @return If the new <code>Node</code> replaces an existing node the
049: * replaced <code>Node</code> is returned, otherwise <code>null</code>
050: * is returned.
051: * @exception DOMException
052: * WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
053: * different document than the one that created this map.
054: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
055: * <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
056: * <code>Attr</code> that is already an attribute of another
057: * <code>Element</code> object. The DOM user must explicitly clone
058: * <code>Attr</code> nodes to re-use them in other elements.
059: */
060: public Node setNamedItem(Node arg) throws DOMException;
061:
062: /**
063: * Removes a node specified by name. When this map contains the attributes
064: * attached to an element, if the removed attribute is known to have a
065: * default value, an attribute immediately appears containing the
066: * default value as well as the corresponding namespace URI, local name,
067: * and prefix when applicable.
068: * @param nameThe <code>nodeName</code> of the node to remove.
069: * @return The node removed from this map if a node with such a name
070: * exists.
071: * @exception DOMException
072: * NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in
073: * this map.
074: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
075: */
076: public Node removeNamedItem(String name) throws DOMException;
077:
078: /**
079: * Returns the <code>index</code>th item in the map. If <code>index</code>
080: * is greater than or equal to the number of nodes in this map, this
081: * returns <code>null</code>.
082: * @param indexIndex into this map.
083: * @return The node at the <code>index</code>th position in the map, or
084: * <code>null</code> if that is not a valid index.
085: */
086: public Node item(int index);
087:
088: /**
089: * The number of nodes in this map. The range of valid child node indices
090: * is <code>0</code> to <code>length-1</code> inclusive.
091: */
092: public int getLength();
093:
094: /**
095: * Retrieves a node specified by local name and namespace URI. HTML-only
096: * DOM implementations do not need to implement this method.
097: * @param namespaceURIThe namespace URI of the node to retrieve.
098: * @param localNameThe local name of the node to retrieve.
099: * @return A <code>Node</code> (of any type) with the specified local
100: * name and namespace URI, or <code>null</code> if they do not
101: * identify any node in this map.
102: * @since DOM Level 2
103: */
104: public Node getNamedItemNS(String namespaceURI, String localName);
105:
106: /**
107: * Adds a node using its <code>namespaceURI</code> and
108: * <code>localName</code>. If a node with that namespace URI and that
109: * local name is already present in this map, it is replaced by the new
110: * one.
111: * <br>HTML-only DOM implementations do not need to implement this method.
112: * @param argA node to store in this map. The node will later be
113: * accessible using the value of its <code>namespaceURI</code> and
114: * <code>localName</code> attributes.
115: * @return If the new <code>Node</code> replaces an existing node the
116: * replaced <code>Node</code> is returned, otherwise <code>null</code>
117: * is returned.
118: * @exception DOMException
119: * WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
120: * different document than the one that created this map.
121: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
122: * <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
123: * <code>Attr</code> that is already an attribute of another
124: * <code>Element</code> object. The DOM user must explicitly clone
125: * <code>Attr</code> nodes to re-use them in other elements.
126: * @since DOM Level 2
127: */
128: public Node setNamedItemNS(Node arg) throws DOMException;
129:
130: /**
131: * Removes a node specified by local name and namespace URI. A removed
132: * attribute may be known to have a default value when this map contains
133: * the attributes attached to an element, as returned by the attributes
134: * attribute of the <code>Node</code> interface. If so, an attribute
135: * immediately appears containing the default value as well as the
136: * corresponding namespace URI, local name, and prefix when applicable.
137: * <br>HTML-only DOM implementations do not need to implement this method.
138: * @param namespaceURIThe namespace URI of the node to remove.
139: * @param localNameThe local name of the node to remove.
140: * @return The node removed from this map if a node with such a local
141: * name and namespace URI exists.
142: * @exception DOMException
143: * NOT_FOUND_ERR: Raised if there is no node with the specified
144: * <code>namespaceURI</code> and <code>localName</code> in this map.
145: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
146: * @since DOM Level 2
147: */
148: public Node removeNamedItemNS(String namespaceURI, String localName)
149: throws DOMException;
150:
151: }
|