Java Doc for ElementImpl.java in  » XML » xerces-2_9_1 » org » apache » xerces » dom » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Elements may have Attributes associated with them; the API for this is defined in Node, but the function is implemented here. In general, XML applications should retrive Attributes as Nodes, since they may contain entity references and hence be a fairly complex sub-tree. HTML users will be dealing with simple string values, and convenience methods are provided to work in terms of Strings.

ElementImpl does not support Namespaces. ElementNSImpl, which inherits from it, does.
See Also:   ElementNSImpl
author:
   Arnaud Le Hors, IBM
author:
   Joe Kesselman, IBM
author:
   Andy Clark, IBM
author:
   Ralf Pfeiffer, IBM
version:
   $Id: ElementImpl.java 449328 2006-09-23 22:58:23Z mrglavas $
since:
   PR-DOM-Level-1-19980818.

Note: NodeList is a "live" view of the DOM.

This method allows you to add an Attribute that has already been constructed, and hence avoids the limitations of the simple setAttribute() call.

Note: Attributes may contain complex node trees. This method returns the "flattened" string obtained from Attribute.getValue(). If you need the structure information, see getAttributeNode().

Retrieves an attribute value by local name and namespace URI.
Parameters:
  namespaceURI - The namespace URI of the attribute toretrieve.
Parameters:
  localName - The local name of the attribute to retrieve. String The Attr value as a string, or empty stringif that attributedoes not have a specified or default value.
since:
   WD-DOM-Level-2-19990923

If no matching attribute is available, returns null.

Note: NodeList is a "live" view of the DOM. Its contents will change as the DOM changes, and alterations made to the NodeList will be reflected in the DOM.
Parameters:
  tagname - The type of element to gather. To obtain a list ofall elements no matter what their names, use the wild-card tagname "*".
See Also:   DeepNodeListImpl

Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.
Parameters:
  namespaceURI - The namespace URI of the elements to matchon. The special value "*" matches allnamespaces. When it is null or an emptystring, this method behaves likegetElementsByTagName.
Parameters:
  localName - The local name of the elements to match on.The special value "*" matches all local names. NodeList A new NodeList object containing all the matchedElements.
since:
   WD-DOM-Level-2-19990923

This is case-preserving in XML. HTML should uppercasify it on the way in.

Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
Parameters:
  typeNamespaceArg - The namspace of the ancestor type declaration
Parameters:
  typeNameArg - The name of the ancestor type declaration
Parameters:
  derivationMethod - The derivation method boolean True if the type is derived by restriciton for thereference type

To normalize a Document, normalize its top-level Element child.

As of PR-DOM-Level-1-19980818, CDATA -- despite being a subclass of Text -- is considered "markup" and will _not_ be merged either with normal Text or with other CDATASections.

The default logic is actually implemented in NamedNodeMapImpl. PR-DOM-Level-1-19980818 doesn't fully address the DTD, so some of this behavior is likely to change in future versions. ?????

Note that this call "succeeds" even if no attribute by this name existed -- unlike removeAttributeNode, which will throw a not-found exception in that case.
throws:
  DOMException - (NO_MODIFICATION_ALLOWED_ERR) if the node isreadonly.

Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.

Parameters:
  namespaceURI - The namespace URI of the attribute to remove.
Parameters:
  localName - The local name of the attribute to remove.
throws:
  NO_MODIFICATION_ALLOWED_ERR - : Raised if thisnode is readonly.
since:
   WD-DOM-Level-2-19990923

NOTE: Specifically removes THIS NODE -- not the node with this name, nor the node with these contents. If the specific Attribute object passed in is not stored in this Element, we throw a DOMException. If you really want to remove an attribute by name, use removeAttribute(). the Attribute object that was removed.
throws:
  DOMException - (NOT_FOUND_ERR) if oldattr is not an attribute ofthis Element.
throws:
  DOMException - (NO_MODIFICATION_ALLOWED_ERR) if the node isreadonly.

Adds a new attribute. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the new attribute is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces]. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be 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 setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.
Parameters:
  namespaceURI - The namespace URI of the attribute to createor alter.
Parameters:
  qualifiedName - The qualified name of the attribute to create oralter.
Parameters:
  value - The value to set in string form.
throws:
  INVALID_CHARACTER_ERR - : Raised if the specifiedname contains an invalid character.
throws:
  NO_MODIFICATION_ALLOWED_ERR - : Raised if thisnode is readonly.
throws:
  NAMESPACE_ERR - : Raised if the qualifiedNamehas a prefix that is "xml" and the namespaceURIis neither null nor an empty string nor"http://www.w3.org/XML/1998/namespace", or ifthe qualifiedName has a prefix that is "xmlns"but the namespaceURI is neither null nor anempty string, or if if the qualifiedName has aprefix different from "xml" and "xmlns" and thenamespaceURI is null or an empty string.
since:
   WD-DOM-Level-2-19990923

This method allows you to add an Attribute that has already been constructed, and hence avoids the limitations of the simple setAttribute() call. It can handle attribute values that have arbitrarily complex tree structure -- in particular, those which had entity references mixed into their text.
throws:
  DOMException - (INUSE_ATTRIBUTE_ERR) if the Attribute objecthas already been assigned to another Element.

Adds a new attribute. If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.
Parameters:
  newAttr - The Attr node to add to the attribute list. Whenthe Node has no namespaceURI, this method behaveslike setAttributeNode. Attr If the newAttr attribute replaces an existing attributewith the same local name and namespace URI, the *previously existing Attr node is returned, otherwisenull is returned.
throws:
  WRONG_DOCUMENT_ERR - : Raised if newAttrwas created from a different document than the one thatcreated the element.
throws:
  NO_MODIFICATION_ALLOWED_ERR - : Raised ifthis node is readonly.
throws:
  INUSE_ATTRIBUTE_ERR - : Raised if newAttr isalready an attribute of another Element object. TheDOM user must explicitly clone Attr nodes to re-usethem in other elements.
since:
   WD-DOM-Level-2-19990923