DocumentImpl (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- org.openxml.dom.NodeImpl
- - org.openxml.dom.ParentNodeImpl
  - - org.openxml.dom.DocumentImpl

All Implemented Interfaces:

Cloneable, Document, Node

Direct Known Subclasses:

HTMLDocumentImpl
```
public class DocumentImpl
extends ParentNodeImpl
implements Document
```
Implements an XML document, and also derived to implement an HTML document. Provides access to the top level element in the document (getDocumentElement()), to the DTD if one exists (getDoctype(), and to all node operations.
Several methods create new nodes of all basic types (comment, text, element, etc.). These methods create new nodes but do not place them in the document tree. The nodes may be placed in the document tree using Node.appendChild(org.w3c.dom.Node) or Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), or they may be placed in some other document tree.
Notes:
1. Node type is Node.DOCUMENT_NODE
2. Node supports childern
3. Node name is always "#document"
4. Node does not have a value
5. Node may not be added to other nodes
Author:

Assaf Arkin

See Also:

Document, ParentNodeImpl, DOMImplementation

Field Summary
- Fields inherited from class org.openxml.dom.NodeImpl
  ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_NODE
- Fields inherited from interface org.w3c.dom.Node
  ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DocumentImpl()`
`protected`	`DocumentImpl(String namespaceURI, String qualifiedName, DocumentType docType)` Constructor for new document requires qualified name to create document element.
`protected`	`DocumentImpl(String namespaceURI, String qualifiedName, DocumentType docType, ElementFactory elementFactory)` [JF] Constructor for new document requires qualified name to create document element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquire(long lockTimeout)` Called to acquire access to a possible locked resource.
`Node`	`adoptNode(Node source)`
`Object`	`clone()`
`protected void`	`cloneInto(NodeImpl into, boolean deep)` This clone method is called after a new node has been constructed to copy the contents of this node into the new one.
`Node`	`cloneNode(boolean deep)`
`short`	`compareDocumentPosition(Node other)`
`Attr`	`createAttribute(String name)`
`Attr`	`createAttribute(String name, String defValue)` Creates an attribute with the default value specified in the DTD.
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)`
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName, String defValue)`
`CDATASection`	`createCDATASection(String data)`
`Comment`	`createComment(String data)`
`DocumentFragment`	`createDocumentFragment()`
`Element`	`createElement(String tagName)`
`Element`	`createElementNS(String namespaceURI, String qualifiedName)`
`EntityReference`	`createEntityReference(String name)`
`org.w3c.dom.traversal.NodeIterator`	`createNodeIterator(Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean entityRefExpansion)`
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)`
`Text`	`createTextNode(String data)`
`boolean`	`equals(Object other)` Returns true if this node and `other` are identical by content but not context.
`String`	`getBaseURI()`
`DocumentType`	`getDoctype()`
`Element`	`getDocumentElement()`
`String`	`getDocumentURI()`
`DOMConfiguration`	`getDomConfig()`
`Element`	`getElementById(String elementId)`
`NodeList`	`getElementsByTagName(String tagName)`
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`
`String`	`getEncoding()` DOM Level 3 WD - Experimental.
`Object`	`getFeature(String feature, String version)`
`DOMImplementation`	`getImplementation()`
`String`	`getInputEncoding()`
`String`	`getNamespaceURI()`
`short`	`getNodeType()` Abstract method must be implemented by each node class.
`boolean`	`getStandalone()` DOM Level 3 WD - Experimental.
`boolean`	`getStrictErrorChecking()`
`String`	`getTextContent()`
`Object`	`getUserData(String key)`
`String`	`getVersion()` DOM Level 3 WD - Experimental.
`String`	`getXmlEncoding()`
`boolean`	`getXmlStandalone()`
`String`	`getXmlVersion()`
`boolean`	`hasAttributes()`
`Node`	`importNode(Node importedNode, boolean deep)` NOT IMPLEMENTED
`boolean`	`isDefaultNamespace(String namespaceURI)`
`boolean`	`isEqualNode(Node arg)`
`boolean`	`isSameNode(Node other)`
`boolean`	`isSupported(String feature, String version)`
`void`	`lock()` Obtains a lock, preventing other threads from gaining access to the locked resource.
`String`	`lookupNamespaceURI(String prefix)`
`String`	`lookupPrefix(String namespaceURI)`
`void`	`normalizeDocument()`
`void`	`registerElement(String tagName, Class elementClass)` Register an application-defined element type.
`Node`	`renameNode(Node n, String namespaceURI, String qualifiedName)`
`void`	`setDocumentURI(String documentURI)`
`void`	`setEncoding(String value)` DOM Level 3 WD - Experimental.
`void`	`setNodeValue(String value)` Changes the value of the node.
`void`	`setStandalone(boolean value)` DOM Level 3 WD - Experimental.
`void`	`setStrictErrorChecking(boolean check)`
`void`	`setTextContent(String textContent)`
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`
`void`	`setVersion(String value)` DOM Level 3 WD - Experimental.
`void`	`setXmlStandalone(boolean xmlStandalone)`
`void`	`setXmlVersion(String xmlVersion)`
`String`	`toString()`
`void`	`unlock()` Releases a lock, so other thread may gain access to the resource.
`void`	`useElementFactory(ElementFactory elementFactory)` Sets the element factory for this document.

Methods inherited from class org.openxml.dom.ParentNodeImpl
appendChild, castNewChild, castOldChild, createNodeIterator, getChildNodes, getFirstChild, getLastChild, hasChildNodes, insertBefore, normalize, removeChild, removeInnerIterator, replaceChild

Methods inherited from class org.openxml.dom.NodeImpl
getAttributes, getLocalName, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, isReadOnly, makeReadOnly, setOwnerDocument, setPrefix, supports

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setPrefix

- Constructor Detail
  - DocumentImpl
```
protected DocumentImpl(String namespaceURI,
                       String qualifiedName,
                       DocumentType docType)
                throws DOMException
```
    Constructor for new document requires qualified name to create document element. Document type is optional, if specified it will be associated with this document; if already in use, an exception will be thrown.
    
    Parameters:
    
    namespaceURI - The namespace URI, or null
    
    qualifiedName - The qualified name of the document element
    
    docType - The type of the document, or null
    
    Throws:
    
    DOMException - The document type is already used, or the qualified name is invalid
  - DocumentImpl
```
protected DocumentImpl(String namespaceURI,
                       String qualifiedName,
                       DocumentType docType,
                       ElementFactory elementFactory)
                throws DOMException
```
    [JF] Constructor for new document requires qualified name to create document element. Document type is optional, if specified it will be associated with this document; if already in use, an exception will be thrown. The element factory is optional.
    
    Parameters:
    
    namespaceURI - The namespace URI, or null
    
    qualifiedName - The qualified name of the document element
    
    docType - The type of the document, or null
    
    Throws:
    
    DOMException - The document type is already used, or the qualified name is invalid
  - DocumentImpl
```
public DocumentImpl()
```
- Method Detail
  - getNodeType
```
public short getNodeType()
```
    Description copied from class: NodeImpl
    
    Abstract method must be implemented by each node class.
    
    Specified by:
    
    getNodeType in interface Node
    
    Specified by:
    
    getNodeType in class NodeImpl
    
    See Also:
    
    Node.getNodeType()
  - setNodeValue
```
public final void setNodeValue(String value)
```
    Description copied from class: NodeImpl
    Changes the value of the node. Not all node types support the notion of a value. If the value is not supported by a particular node type, it will throw an exception when calling this method. The following table specifies which node types support values:
```
 Element                Not supported
 Attr                   Supported
 Text                   Supported
 CDATASection           Supported
 EntityReference        Not supported
 Entity                 Not supported
 ProcessingInstruction  Supported
 Comment                Supported
 Document               Not supported
 DocumentType           Not supported
 DocumentFragment       Not supported
 Notation               Not supported
 
```
    For most node types, if the value is set to null, NodeImpl.getNodeValue() will return an empty string instead.
    Specified by:
    
    setNodeValue in interface Node
    
    Overrides:
    
    setNodeValue in class NodeImpl
    
    Parameters:
    
    value - New value of node
  - getDoctype
```
public final DocumentType getDoctype()
```
    Specified by:
    
    getDoctype in interface Document
  - getImplementation
```
public final DOMImplementation getImplementation()
```
    Specified by:
    
    getImplementation in interface Document
  - getDocumentElement
```
public Element getDocumentElement()
```
    Specified by:
    
    getDocumentElement in interface Document
  - createElement
```
public Element createElement(String tagName)
                      throws DOMException
```
    Specified by:
    
    createElement in interface Document
    
    Throws:
    
    DOMException
  - createElementNS
```
public Element createElementNS(String namespaceURI,
                               String qualifiedName)
                        throws DOMException
```
    Specified by:
    
    createElementNS in interface Document
    
    Throws:
    
    DOMException
  - createDocumentFragment
```
public final DocumentFragment createDocumentFragment()
```
    Specified by:
    
    createDocumentFragment in interface Document
  - createTextNode
```
public final Text createTextNode(String data)
```
    Specified by:
    
    createTextNode in interface Document
  - createComment
```
public final Comment createComment(String data)
```
    Specified by:
    
    createComment in interface Document
  - createCDATASection
```
public final CDATASection createCDATASection(String data)
                                      throws DOMException
```
    Specified by:
    
    createCDATASection in interface Document
    
    Throws:
    
    DOMException
  - createProcessingInstruction
```
public final ProcessingInstruction createProcessingInstruction(String target,
                                                               String data)
                                                        throws DOMException
```
    Specified by:
    
    createProcessingInstruction in interface Document
    
    Throws:
    
    DOMException
  - createAttribute
```
public final Attr createAttribute(String name)
                           throws DOMException
```
    Specified by:
    
    createAttribute in interface Document
    
    Throws:
    
    DOMException
  - createAttribute
```
public final Attr createAttribute(String name,
                                  String defValue)
                           throws DOMException
```
    Creates an attribute with the default value specified in the DTD. This method is not defined in the DOM but is used by the parser.
    
    Parameters:
    
    name - The name of the attribute
    
    defValue - The default value of the attribute
    
    Throws:
    
    DOMException
  - createAttributeNS
```
public final Attr createAttributeNS(String namespaceURI,
                                    String qualifiedName,
                                    String defValue)
                             throws DOMException
```
    Throws:
    
    DOMException
  - createAttributeNS
```
public final Attr createAttributeNS(String namespaceURI,
                                    String qualifiedName)
```
    Specified by:
    
    createAttributeNS in interface Document
  - createEntityReference
```
public final EntityReference createEntityReference(String name)
                                            throws DOMException
```
    Specified by:
    
    createEntityReference in interface Document
    
    Throws:
    
    DOMException
  - getElementsByTagName
```
public NodeList getElementsByTagName(String tagName)
```
    Specified by:
    
    getElementsByTagName in interface Document
  - getElementsByTagNameNS
```
public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)
```
    Specified by:
    
    getElementsByTagNameNS in interface Document
  - createNodeIterator
```
public org.w3c.dom.traversal.NodeIterator createNodeIterator(Node root,
                                                             int whatToShow,
                                                             org.w3c.dom.traversal.NodeFilter filter,
                                                             boolean entityRefExpansion)
```
  - getElementById
```
public Element getElementById(String elementId)
```
    Specified by:
    
    getElementById in interface Document
  - registerElement
```
public void registerElement(String tagName,
                            Class elementClass)
```
    Register an application-defined element type. The element's tag name and class are specified. When a so named element is created with createElement(java.lang.String), an object of the specified class is created and returned. This allows applications to define classes for specific element types.
    
    Parameters:
    
    tagName - The name of the element tag
    
    elementClass - Class derived from ElementImpl, used to construct the element
  - useElementFactory
```
public void useElementFactory(ElementFactory elementFactory)
```
    Sets the element factory for this document. The element factory is given a first chance to construct new elements based on the tag name.
    
    Parameters:
    
    elementFactory - The new element factory
  - importNode
```
public final Node importNode(Node importedNode,
                             boolean deep)
                      throws DOMException
```
    NOT IMPLEMENTED
    
    Specified by:
    
    importNode in interface Document
    
    Throws:
    
    DOMException
  - getNamespaceURI
```
public final String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface Node
    
    Overrides:
    
    getNamespaceURI in class NodeImpl
  - lock
```
public void lock()
          throws RuntimeException
```
    Obtains a lock, preventing other threads from gaining access to the locked resource. The lock is retained across multiple calls, until unlock() is called. Attempts to call acquire(long) from another thread will be blocked.
    If the resource is already locked by another thread, the method will block until the lock is released or until the block has timedout.
    lock() may be called any number of times, and unlock() must be called that number of times to release the lock.
    
    Throws:
    
    RuntimeException
    
    See Also:
    
    unlock()
  - unlock
```
public void unlock()
```
    Releases a lock, so other thread may gain access to the resource. unlock() must be called as many times as lock() was called to release the lock. unlock() may be called an additional number of times, if so required by the implementation (e.g. to assure that a lock is released at the end of a thread).
    
    See Also:
    
    lock()
  - acquire
```
public void acquire(long lockTimeout)
             throws RuntimeException
```
    Called to acquire access to a possible locked resource. If the resource was locked by the current thread, the method will return immediately. If the resource was locked by some other thread, the method will block until the resource is unlocked, or the block has timed out.
    
    Throws:
    
    RuntimeException
    
    See Also:
    
    lock(), unlock()
  - equals
```
public boolean equals(Object other)
```
    Description copied from class: NodeImpl
    Returns true if this node and other are identical by content but not context. Test by content but not context adheres to the following:
    - Both nodes must be of the same type, must have the same name and value (case sensitive) and for elements, the same tag name
    - For elements, both must have identical attribute list, although attributes may be specified/unspecified and in different orders
    - Both nodes must have no children, or must have the exact same sequence of children; children are tested for equality by calling NodeImpl.equals(java.lang.Object) on each pair
    - However, both nodes may reside in different documents, belong to different parents, have different siblings, different read-only flags, etc.
    It is guaranteed that the act of cloning a node will return a second node that will pass the test of equality.
    Note that for large document roots, the equality operation can be very expensive.
    Overrides:
    
    equals in class ParentNodeImpl
    
    Parameters:
    
    other - The other node to test for equality
    
    Returns:
    
    True if both nodes are equal based on their content but not their context
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - cloneNode
```
public Node cloneNode(boolean deep)
```
    Specified by:
    
    cloneNode in interface Node
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - cloneInto
```
protected void cloneInto(NodeImpl into,
                         boolean deep)
```
    Description copied from class: NodeImpl
    
    This clone method is called after a new node has been constructed to copy the contents of this node into the new one. It clones in contents but not in context, and guarantees that the cloned node will pass the equality test (see NodeImpl.equals(java.lang.Object)).
    into must be a valid node of the exact same class as this one. deep is true if deep cloning (includes all children nodes) is to be performed. If deep is false, the clone might not pass the equality test.
    Derived classes override and call this method to add per-class variable copying. This method is called by Node.cloneNode(boolean) and the default Object.clone() method.
    Contents cloning duplicates the node's name and value, and its children. It does not duplicate it's context, that is, the node's parent or sibling. Initially a clone node has no parents or siblings. However, the node does belong to the same document, since all nodes must belong to some document. The cloned node is never read-only.
    
    Overrides:
    
    cloneInto in class ParentNodeImpl
    
    Parameters:
    
    into - A node into which to duplicate this one
    
    deep - True if deep cloning is required
  - getEncoding
```
public String getEncoding()
```
    DOM Level 3 WD - Experimental. The encoding of this document (part of XML Declaration)
  - getStandalone
```
public boolean getStandalone()
```
    DOM Level 3 WD - Experimental. standalone that specifies whether this document is standalone (part of XML Declaration)
  - setStandalone
```
public void setStandalone(boolean value)
```
    DOM Level 3 WD - Experimental. standalone - An attribute specifying, as part of the XML declaration, whether this document is standalone
  - adoptNode
```
public Node adoptNode(Node source)
```
    Specified by:
    
    adoptNode in interface Document
  - getStrictErrorChecking
```
public boolean getStrictErrorChecking()
```
    Specified by:
    
    getStrictErrorChecking in interface Document
  - setStrictErrorChecking
```
public void setStrictErrorChecking(boolean check)
```
    Specified by:
    
    setStrictErrorChecking in interface Document
  - getVersion
```
public String getVersion()
```
    DOM Level 3 WD - Experimental. The version of this document (part of XML Declaration)
  - setVersion
```
public void setVersion(String value)
```
    DOM Level 3 WD - Experimental. version - An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified
  - setEncoding
```
public void setEncoding(String value)
```
    DOM Level 3 WD - Experimental. An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.
  - getDocumentURI
```
public String getDocumentURI()
```
    Specified by:
    
    getDocumentURI in interface Document
  - getDomConfig
```
public DOMConfiguration getDomConfig()
```
    Specified by:
    
    getDomConfig in interface Document
  - getInputEncoding
```
public String getInputEncoding()
```
    Specified by:
    
    getInputEncoding in interface Document
  - getXmlEncoding
```
public String getXmlEncoding()
```
    Specified by:
    
    getXmlEncoding in interface Document
  - getXmlStandalone
```
public boolean getXmlStandalone()
```
    Specified by:
    
    getXmlStandalone in interface Document
  - getXmlVersion
```
public String getXmlVersion()
```
    Specified by:
    
    getXmlVersion in interface Document
  - normalizeDocument
```
public void normalizeDocument()
```
    Specified by:
    
    normalizeDocument in interface Document
  - renameNode
```
public Node renameNode(Node n,
                       String namespaceURI,
                       String qualifiedName)
                throws DOMException
```
    Specified by:
    
    renameNode in interface Document
    
    Throws:
    
    DOMException
  - setDocumentURI
```
public void setDocumentURI(String documentURI)
```
    Specified by:
    
    setDocumentURI in interface Document
  - setXmlStandalone
```
public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException
```
    Specified by:
    
    setXmlStandalone in interface Document
    
    Throws:
    
    DOMException
  - setXmlVersion
```
public void setXmlVersion(String xmlVersion)
                   throws DOMException
```
    Specified by:
    
    setXmlVersion in interface Document
    
    Throws:
    
    DOMException
  - compareDocumentPosition
```
public short compareDocumentPosition(Node other)
                              throws DOMException
```
    Specified by:
    
    compareDocumentPosition in interface Node
    
    Throws:
    
    DOMException
  - getBaseURI
```
public String getBaseURI()
```
    Specified by:
    
    getBaseURI in interface Node
  - getFeature
```
public Object getFeature(String feature,
                         String version)
```
    Specified by:
    
    getFeature in interface Node
  - getTextContent
```
public String getTextContent()
                      throws DOMException
```
    Specified by:
    
    getTextContent in interface Node
    
    Throws:
    
    DOMException
  - getUserData
```
public Object getUserData(String key)
```
    Specified by:
    
    getUserData in interface Node
  - isDefaultNamespace
```
public boolean isDefaultNamespace(String namespaceURI)
```
    Specified by:
    
    isDefaultNamespace in interface Node
  - isEqualNode
```
public boolean isEqualNode(Node arg)
```
    Specified by:
    
    isEqualNode in interface Node
  - isSameNode
```
public boolean isSameNode(Node other)
```
    Specified by:
    
    isSameNode in interface Node
  - lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix)
```
    Specified by:
    
    lookupNamespaceURI in interface Node
  - lookupPrefix
```
public String lookupPrefix(String namespaceURI)
```
    Specified by:
    
    lookupPrefix in interface Node
  - setTextContent
```
public void setTextContent(String textContent)
                    throws DOMException
```
    Specified by:
    
    setTextContent in interface Node
    
    Throws:
    
    DOMException
  - setUserData
```
public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)
```
    Specified by:
    
    setUserData in interface Node
  - hasAttributes
```
public boolean hasAttributes()
```
    Specified by:
    
    hasAttributes in interface Node
  - isSupported
```
public boolean isSupported(String feature,
                           String version)
```
    Specified by:
    
    isSupported in interface Node

Class DocumentImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.openxml.dom.ParentNodeImpl

Methods inherited from class org.openxml.dom.NodeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Node

Constructor Detail

DocumentImpl

DocumentImpl

DocumentImpl

Method Detail

getNodeType

setNodeValue

getDoctype

getImplementation

getDocumentElement

createElement

createElementNS

createDocumentFragment

createTextNode

createComment

createCDATASection

createProcessingInstruction

createAttribute

createAttribute

createAttributeNS

createAttributeNS

createEntityReference

getElementsByTagName

getElementsByTagNameNS

createNodeIterator

getElementById

registerElement

useElementFactory

importNode

getNamespaceURI

lock

unlock

acquire

equals

clone

cloneNode

toString

cloneInto

getEncoding

getStandalone

setStandalone

adoptNode

getStrictErrorChecking

setStrictErrorChecking

getVersion

setVersion

setEncoding

getDocumentURI

getDomConfig

getInputEncoding

getXmlEncoding

getXmlStandalone

getXmlVersion

normalizeDocument

renameNode

setDocumentURI

setXmlStandalone

setXmlVersion

compareDocumentPosition

getBaseURI

getFeature

getTextContent

getUserData

isDefaultNamespace

isEqualNode

isSameNode

lookupNamespaceURI

lookupPrefix

setTextContent

setUserData