Package org.apache.harmony.xml.dom

Class DocumentImpl

java.lang.Object
org.apache.harmony.xml.dom.NodeImpl
org.apache.harmony.xml.dom.LeafNodeImpl
org.apache.harmony.xml.dom.InnerNodeImpl
org.apache.harmony.xml.dom.DocumentImpl
All Implemented Interfaces:
Document, Node
public final class DocumentImpl
extends InnerNodeImpl
implements Document
Provides a straightforward implementation of the corresponding W3C DOM interface. The class is used internally only, thus only notable members that are not in the original interface are documented (the W3C docs are quite extensive). Hope that's ok.

Some of the fields may have package visibility, so other classes belonging to the DOM implementation can easily access them while maintaining the DOM tree structure.

  • Constructor Details

  • Method Details

    • importNode

      public Node importNode​(Node importedNode, boolean deep)
      Description copied from interface: Document
      Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. The returned node has no parent; (parentNode is null).
      For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation, the source node is not altered. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
      Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.
      ATTRIBUTE_NODE
      The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported.
      DOCUMENT_FRAGMENT_NODE
      If the deep option was set to true, the descendants of the source DocumentFragment are recursively imported and the resulting nodes reassembled under the imported DocumentFragment to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.
      DOCUMENT_NODE
      Document nodes cannot be imported.
      DOCUMENT_TYPE_NODE
      DocumentType nodes cannot be imported.
      ELEMENT_NODE
      Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
      ENTITY_NODE
      Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
      ENTITY_REFERENCE_NODE
      Only the EntityReference itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
      NOTATION_NODE
      Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
      PROCESSING_INSTRUCTION_NODE
      The imported node copies its target and data values from those of the source node.Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
      TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
      These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.Note that the deep parameter has no effect on these types of nodes since they cannot have any children.
      Specified by:
      importNode in interface Document
      Parameters:
      importedNode - The node to import.
      deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on nodes that cannot have any children, and on Attr, and EntityReference nodes.
      Returns:
      The imported node that belongs to this Document.

    • adoptNode

      public Node adoptNode​(Node node)
      Detaches the node from its parent (if any) and changes its document to this document. The node's subtree and attributes will remain attached, but their document will be changed to this document.
      Specified by:
      adoptNode in interface Document
      Parameters:
      node - The node to move into this document.
      Returns:
      The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.

    • renameNode

      public Node renameNode​(Node node, String namespaceURI, String qualifiedName)
      Description copied from interface: Document
      Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
      When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
      If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an Element its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
      When the node being renamed is an Element only the specified attributes are moved, default attributes originated from the DTD are updated according to the new element name. In addition, the implementation may update default attributes from other schemas. Applications should use Document.normalizeDocument() to guarantee these attributes are up-to-date.
      When the node being renamed is an Attr that is attached to an Element, the node is first removed from the Element attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
      In addition,
      • a user data event NODE_RENAMED is fired,
      • when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event { http://www.w3.org/2001/xml-events, DOMElementNameChanged} or { http://www.w3.org/2001/xml-events, DOMAttributeNameChanged} is fired.
      Specified by:
      renameNode in interface Document
      Parameters:
      node - The node to rename.
      namespaceURI - The new namespace URI.
      qualifiedName - The new qualified name.
      Returns:
      The renamed node. This is either the specified node or the new node that was created to replace the specified node.

    • createAttribute

      public AttrImpl createAttribute​(String name)
      Description copied from interface: Document
      Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method.
      To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.
      Specified by:
      createAttribute in interface Document
      Parameters:
      name - The name of the attribute.
      Returns:
      A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string.

    • createAttributeNS

      public AttrImpl createAttributeNS​(String namespaceURI, String qualifiedName)
      Description copied from interface: Document
      Creates an attribute of the given qualified name and namespace URI.
      Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
      Specified by:
      createAttributeNS in interface Document
      Parameters:
      namespaceURI - The namespace URI of the attribute to create.
      qualifiedName - The qualified name of the attribute to instantiate.
      Returns:
      A new Attr object with the following attributes:
      Attribute Value
      Node.nodeName qualifiedName
      Node.namespaceURI namespaceURI
      Node.prefix prefix, extracted from qualifiedName, or null if there is no prefix
      Node.localName local name, extracted from qualifiedName
      Attr.name qualifiedName
      Node.nodeValue the empty string

    • createCDATASection

      public CDATASectionImpl createCDATASection​(String data)
      Description copied from interface: Document
      Creates a CDATASection node whose value is the specified string.
      Specified by:
      createCDATASection in interface Document
      Parameters:
      data - The data for the CDATASection contents.
      Returns:
      The new CDATASection object.

    • createComment

      public CommentImpl createComment​(String data)
      Description copied from interface: Document
      Creates a Comment node given the specified string.
      Specified by:
      createComment in interface Document
      Parameters:
      data - The data for the node.
      Returns:
      The new Comment object.

    • createDocumentFragment

      public DocumentFragmentImpl createDocumentFragment()
      Description copied from interface: Document
      Creates an empty DocumentFragment object.
      Specified by:
      createDocumentFragment in interface Document
      Returns:
      A new DocumentFragment.

    • createElement

      public ElementImpl createElement​(String tagName)
      Description copied from interface: Document
      Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
      In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element.
      To create an element with a qualified name and namespace URI, use the createElementNS method.
      Specified by:
      createElement in interface Document
      Parameters:
      tagName - The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation.
      Returns:
      A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.

    • createElementNS

      public ElementImpl createElementNS​(String namespaceURI, String qualifiedName)
      Description copied from interface: Document
      Creates an element of the given qualified name and namespace URI.
      Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
      Specified by:
      createElementNS in interface Document
      Parameters:
      namespaceURI - The namespace URI of the element to create.
      qualifiedName - The qualified name of the element type to instantiate.
      Returns:
      A new Element object with the following attributes:
      Attribute Value
      Node.nodeName qualifiedName
      Node.namespaceURI namespaceURI
      Node.prefix prefix, extracted from qualifiedName, or null if there is no prefix
      Node.localName local name, extracted from qualifiedName
      Element.tagName qualifiedName

    • createEntityReference

      public EntityReferenceImpl createEntityReference​(String name)
      Description copied from interface: Document
      Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.

      Note: If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case.

      Specified by:
      createEntityReference in interface Document
      Parameters:
      name - The name of the entity to reference.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the entity name. Applications should invoke Document.normalizeDocument() with the parameter " namespaces" set to true in order to ensure that the entity name is namespace well-formed.
      Returns:
      The new EntityReference object.

    • createProcessingInstruction

      public ProcessingInstructionImpl createProcessingInstruction​(String target, String data)
      Description copied from interface: Document
      Creates a ProcessingInstruction node given the specified name and data strings.
      Specified by:
      createProcessingInstruction in interface Document
      Parameters:
      target - The target part of the processing instruction.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the target name. Applications should invoke Document.normalizeDocument() with the parameter " namespaces" set to true in order to ensure that the target name is namespace well-formed.
      data - The data for the node.
      Returns:
      The new ProcessingInstruction object.

    • createTextNode

      public TextImpl createTextNode​(String data)
      Description copied from interface: Document
      Creates a Text node given the specified string.
      Specified by:
      createTextNode in interface Document
      Parameters:
      data - The data for the node.
      Returns:
      The new Text object.

    • getDoctype

      public DocumentType getDoctype()
      Description copied from interface: Document
      The Document Type Declaration (see DocumentType) associated with this document. For XML documents without a document type declaration this returns null. For HTML documents, a DocumentType object may be returned, independently of the presence or absence of document type declaration in the HTML document.
      This provides direct access to the DocumentType node, child node of this Document. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such as Node.insertBefore, or Node.replaceChild. Note, however, that while some implementations may instantiate different types of Document objects supporting additional features than the "Core", such as "HTML" [DOM Level 2 HTML] , based on the DocumentType specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.
      Specified by:
      getDoctype in interface Document

    • getDocumentElement

      public Element getDocumentElement()
      Description copied from interface: Document
      This is a convenience attribute that allows direct access to the child node that is the document element of the document.
      Specified by:
      getDocumentElement in interface Document

    • getElementById

      public Element getElementById​(String elementId)
      Description copied from interface: Document
      Returns the Element that has an ID attribute with the given value. If no such element exists, this returns null . If more than one element has an ID attribute with that value, what is returned is undefined.
      The DOM implementation is expected to use the attribute Attr.isId to determine if an attribute is of type ID.

      Note: Attributes with the name "ID" or "id" are not of type ID unless so defined.

      Specified by:
      getElementById in interface Document
      Parameters:
      elementId - The unique id value for an element.
      Returns:
      The matching element or null if there is none.

    • getElementsByTagName

      public NodeList getElementsByTagName​(String name)
      Description copied from interface: Document
      Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.
      Specified by:
      getElementsByTagName in interface Document
      Parameters:
      name - The name of the tag to match on. The special value "*" matches all tags. For XML, the tagname parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use.
      Returns:
      A new NodeList object containing all the matched Elements.

    • getElementsByTagNameNS

      public NodeList getElementsByTagNameNS​(String namespaceURI, String localName)
      Description copied from interface: Document
      Returns a NodeList of all the Elements with a given local name and namespace URI in document order.
      Specified by:
      getElementsByTagNameNS in interface Document
      Parameters:
      namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.
      localName - The local name of the elements to match on. The special value "*" matches all local names.
      Returns:
      A new NodeList object containing all the matched Elements.

    • getImplementation

      public DOMImplementation getImplementation()
      Description copied from interface: Document
      The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.
      Specified by:
      getImplementation in interface Document

    • getNodeName

      public String getNodeName()
      Description copied from interface: Node
      The name of this node, depending on its type; see the table above.
      Specified by:
      getNodeName in interface Node
      Overrides:
      getNodeName in class NodeImpl

    • getNodeType

      public short getNodeType()
      Description copied from interface: Node
      A code representing the type of the underlying object, as defined above.
      Specified by:
      getNodeType in interface Node
      Specified by:
      getNodeType in class NodeImpl

    • insertChildAt

      public Node insertChildAt​(Node toInsert, int index)
      Document elements may have at most one root element and at most one DTD element.

    • getTextContent

      public String getTextContent()
      Description copied from interface: Node
      This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
      On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
      The string returned is made of the text content of this node depending on its type, as defined below:
      Node type Content
      ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
      TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
      DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
      Specified by:
      getTextContent in interface Node
      Overrides:
      getTextContent in class InnerNodeImpl

    • getInputEncoding

      public String getInputEncoding()
      Description copied from interface: Document
      An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the Document was created in memory.
      Specified by:
      getInputEncoding in interface Document

    • getXmlEncoding

      public String getXmlEncoding()
      Description copied from interface: Document
      An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.
      Specified by:
      getXmlEncoding in interface Document

    • getXmlStandalone

      public boolean getXmlStandalone()
      Description copied from interface: Document
      An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

      Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument() with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

      Specified by:
      getXmlStandalone in interface Document

    • setXmlStandalone

      public void setXmlStandalone​(boolean xmlStandalone)
      Description copied from interface: Document
      An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

      Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument() with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

      Specified by:
      setXmlStandalone in interface Document

    • getXmlVersion

      public String getXmlVersion()
      Description copied from interface: Document
      An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke Document.normalizeDocument() in order to check for invalid characters in the Nodes that are already part of this Document.
      DOM applications may use the DOMImplementation.hasFeature(feature, version) method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using Document.xmlVersion.
      Specified by:
      getXmlVersion in interface Document

    • setXmlVersion

      public void setXmlVersion​(String xmlVersion)
      Description copied from interface: Document
      An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke Document.normalizeDocument() in order to check for invalid characters in the Nodes that are already part of this Document.
      DOM applications may use the DOMImplementation.hasFeature(feature, version) method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using Document.xmlVersion.
      Specified by:
      setXmlVersion in interface Document

    • getStrictErrorChecking

      public boolean getStrictErrorChecking()
      Description copied from interface: Document
      An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
      Specified by:
      getStrictErrorChecking in interface Document

    • setStrictErrorChecking

      public void setStrictErrorChecking​(boolean strictErrorChecking)
      Description copied from interface: Document
      An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
      Specified by:
      setStrictErrorChecking in interface Document

    • getDocumentURI

      public String getDocumentURI()
      Description copied from interface: Document
      The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
      Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.
      Specified by:
      getDocumentURI in interface Document

    • setDocumentURI

      public void setDocumentURI​(String documentUri)
      Description copied from interface: Document
      The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
      Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.
      Specified by:
      setDocumentURI in interface Document

    • getDomConfig

      public DOMConfiguration getDomConfig()
      Description copied from interface: Document
      The configuration used when Document.normalizeDocument() is invoked.
      Specified by:
      getDomConfig in interface Document

    • normalizeDocument

      public void normalizeDocument()
      Description copied from interface: Document
      This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree of EntityReference nodes and normalizes Text nodes, as defined in the method Node.normalize().
      Otherwise, the actual result depends on the features being set on the Document.domConfig object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in , check the character normalization, remove the CDATASection nodes, etc. See DOMConfiguration for details. 
      // Keep in the document
 the information defined // in the XML Information Set (Java example)
 DOMConfiguration docConfig = myDocument.getDomConfig();
 docConfig.setParameter("infoset", Boolean.TRUE);
 myDocument.normalizeDocument();

      Mutation events, when supported, are generated to reflect the changes occurring on the document.
      If errors occur during the invocation of this method, such as an attempt to update a read-only node or a Node.nodeName contains an invalid character according to the XML version in use, errors or warnings (DOMError.SEVERITY_ERROR or DOMError.SEVERITY_WARNING) will be reported using the DOMErrorHandler object associated with the "error-handler " parameter. Note this method might also report fatal errors ( DOMError.SEVERITY_FATAL_ERROR) if an implementation cannot recover from an error.
      Specified by:
      normalizeDocument in interface Document