APIdia Launch Partner
Top Fields Constructors Methods
com.sun.org.apache.xerces.internal.impl.xs.opti

public Class DefaultDocument

extends NodeImpl
implements Document
Class Inheritance
All Implemented Interfaces
org.w3c.dom.Document, org.w3c.dom.Node
Known Direct Subclasses
com.sun.org.apache.xerces.internal.impl.xs.opti.SchemaDOM
Imports
org.w3c.dom.DOMConfiguration, .Attr, .Node, .Text, .Element, .Comment, .Document, .NodeList, .DocumentType, .CDATASection, .EntityReference, .DocumentFragment, .DOMImplementation, .ProcessingInstruction, .DOMException
Author
Rahul Srivastava, Sun Microsystems Inc.

Field Summary

Modifier and TypeField and Description
private String
fDocumentURI

Inherited from com.sun.org.apache.xerces.internal.impl.xs.opti.NodeImpl:
hiddenlocalpartnodeTypeprefixrawnameuri

Constructor Summary

AccessConstructor and Description
public
DefaultDocument()

Method Summary

Modifier and TypeMethod and Description
public Node
adoptNode(Node source)

Implements org.w3c.dom.Document.adoptNode.

DOM Level 3

public Attr
createAttribute(String name)

Implements org.w3c.dom.Document.createAttribute.

Creates an Attr of the given name.

public Attr
createAttributeNS(String namespaceURI, String qualifiedName)

Implements org.w3c.dom.Document.createAttributeNS.

Creates an attribute of the given qualified name and namespace URI.

public CDATASection
createCDATASection(String data)

Implements org.w3c.dom.Document.createCDATASection.

Creates a CDATASection node whose value is the specified string.

public Comment
createComment(String data)

Implements org.w3c.dom.Document.createComment.

Creates a Comment node given the specified string.

public DocumentFragment
createDocumentFragment()

Implements org.w3c.dom.Document.createDocumentFragment.

Creates an empty DocumentFragment object.

public Element
createElement(String tagName)

Implements org.w3c.dom.Document.createElement.

Creates an element of the type specified.

public Element
createElementNS(String namespaceURI, String qualifiedName)

Implements org.w3c.dom.Document.createElementNS.

Creates an element of the given qualified name and namespace URI.

public EntityReference
createEntityReference(String name)

Implements org.w3c.dom.Document.createEntityReference.

Creates an EntityReference object.

public ProcessingInstruction
createProcessingInstruction(String target, String data)

Implements org.w3c.dom.Document.createProcessingInstruction.

Creates a ProcessingInstruction node given the specified name and data strings.

public Text
createTextNode(String data)

Implements org.w3c.dom.Document.createTextNode.

Creates a Text node given the specified string.

public DocumentType
getDoctype()

Implements org.w3c.dom.Document.getDoctype.

The Document Type Declaration (see DocumentType) associated with this document.

public Element
getDocumentElement()

Implements org.w3c.dom.Document.getDocumentElement.

This is a convenience attribute that allows direct access to the child node that is the document element of the document.

public String
getDocumentURI()

Implements org.w3c.dom.Document.getDocumentURI.

The location of the document or null if undefined.

public DOMConfiguration
getDomConfig()

Implements org.w3c.dom.Document.getDomConfig.

The configuration used when Document.normalizeDocument is invoked.

public Element
getElementById(String elementId)

Implements org.w3c.dom.Document.getElementById.

Returns the Element that has an ID attribute with the given value.

public NodeList
getElementsByTagName(String tagname)

Implements org.w3c.dom.Document.getElementsByTagName.

Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.

public NodeList
getElementsByTagNameNS(String namespaceURI, String localName)

Implements org.w3c.dom.Document.getElementsByTagNameNS.

Returns a NodeList of all the Elements with a given local name and namespace URI in document order.

public DOMImplementation
getImplementation()

Implements org.w3c.dom.Document.getImplementation.

The DOMImplementation object that handles this document.

public String
getInputEncoding()

Implements org.w3c.dom.Document.getInputEncoding.

An attribute specifying the encoding used for this document at the time of the parsing.

public boolean
getStrictErrorChecking()

Implements org.w3c.dom.Document.getStrictErrorChecking.

An attribute specifying whether errors checking is enforced or not.

public String
getXmlEncoding()

Implements org.w3c.dom.Document.getXmlEncoding.

public void setInputEncoding(String actualEncoding){ throw new DOMException(DOMException.NOT_SUPPORTED_ERR, "Method not supported"); }

public boolean
getXmlStandalone()

Implements org.w3c.dom.Document.getXmlStandalone.

An attribute specifying, as part of the XML declaration, whether this document is standalone.

public String
getXmlVersion()

Implements org.w3c.dom.Document.getXmlVersion.

An attribute specifying, as part of the XML declaration, the version number of this document.

public Node
importNode(Node importedNode, boolean deep)

Implements org.w3c.dom.Document.importNode.

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.

public void
normalizeDocument()

Implements org.w3c.dom.Document.normalizeDocument.

DOM Level 3

public Node
renameNode(Node n, String namespaceURI, String name)

Implements org.w3c.dom.Document.renameNode.

DOM Level 3

public void
setDocumentURI(String documentURI)

Implements org.w3c.dom.Document.setDocumentURI.

The location of the document or null if undefined.

public void
setStrictErrorChecking(boolean strictErrorChecking)

Implements org.w3c.dom.Document.setStrictErrorChecking.

An attribute specifying whether errors checking is enforced or not.

public void
setXmlStandalone(boolean standalone)

Implements org.w3c.dom.Document.setXmlStandalone.

An attribute specifying, as part of the XML declaration, whether this document is standalone.

public void
setXmlVersion(String version)

Implements org.w3c.dom.Document.setXmlVersion.

An attribute specifying, as part of the XML declaration, the version number of this document.

Inherited from com.sun.org.apache.xerces.internal.impl.xs.opti.NodeImpl:
getLocalNamegetNamespaceURIgetNodeNamegetNodeTypegetPrefixgetReadOnlysetReadOnly

Field Detail

fDocumentURIback to summary
private String fDocumentURI

Constructor Detail

DefaultDocumentback to summary
public DefaultDocument()

Method Detail

adoptNodeback to summary
public Node adoptNode(Node source) throws DOMException

Implements org.w3c.dom.Document.adoptNode.

DOM Level 3

Exceptions
DOMException:

Doc from org.w3c.dom.Document.adoptNode.

NOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT, DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.

createAttributeback to summary
public Attr createAttribute(String name) throws DOMException

Implements org.w3c.dom.Document.createAttribute.

Doc from org.w3c.dom.Document.createAttribute.

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.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
createAttributeNSback to summary
public Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException

Implements org.w3c.dom.Document.createAttributeNS.

Doc from org.w3c.dom.Document.createAttributeNS.

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.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
createCDATASectionback to summary
public CDATASection createCDATASection(String data) throws DOMException

Implements org.w3c.dom.Document.createCDATASection.

Doc from org.w3c.dom.Document.createCDATASection.

Creates a CDATASection node whose value is the specified string.

Exceptions
DOMException:
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createCommentback to summary
public Comment createComment(String data)

Implements org.w3c.dom.Document.createComment.

Doc from org.w3c.dom.Document.createComment.

Creates a Comment node given the specified string.

createDocumentFragmentback to summary
public DocumentFragment createDocumentFragment()

Implements org.w3c.dom.Document.createDocumentFragment.

Doc from org.w3c.dom.Document.createDocumentFragment.

Creates an empty DocumentFragment object.

createElementback to summary
public Element createElement(String tagName) throws DOMException

Implements org.w3c.dom.Document.createElement.

Doc from org.w3c.dom.Document.createElement.

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.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
createElementNSback to summary
public Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException

Implements org.w3c.dom.Document.createElementNS.

Doc from org.w3c.dom.Document.createElementNS.

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.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] , or if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
createEntityReferenceback to summary
public EntityReference createEntityReference(String name) throws DOMException

Implements org.w3c.dom.Document.createEntityReference.

Doc from org.w3c.dom.Document.createEntityReference.

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.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createProcessingInstructionback to summary
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException

Implements org.w3c.dom.Document.createProcessingInstruction.

Doc from org.w3c.dom.Document.createProcessingInstruction.

Creates a ProcessingInstruction node given the specified name and data strings.

Exceptions
DOMException:
INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createTextNodeback to summary
public Text createTextNode(String data)

Implements org.w3c.dom.Document.createTextNode.

Doc from org.w3c.dom.Document.createTextNode.

Creates a Text node given the specified string.

getDoctypeback to summary
public DocumentType getDoctype()

Implements org.w3c.dom.Document.getDoctype.

Doc from org.w3c.dom.Document.getDoctype.

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.

getDocumentElementback to summary
public Element getDocumentElement()

Implements org.w3c.dom.Document.getDocumentElement.

Doc from org.w3c.dom.Document.getDocumentElement.

This is a convenience attribute that allows direct access to the child node that is the document element of the document.

getDocumentURIback to summary
public String getDocumentURI()

Implements org.w3c.dom.Document.getDocumentURI.

The location of the document or null if undefined.
Beware that when the Document supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.

Since
DOM Level 3
getDomConfigback to summary
public DOMConfiguration getDomConfig()

Implements org.w3c.dom.Document.getDomConfig.

The configuration used when Document.normalizeDocument is invoked.

Since
DOM Level 3
getElementByIdback to summary
public Element getElementById(String elementId)

Implements org.w3c.dom.Document.getElementById.

Doc from org.w3c.dom.Document.getElementById.

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.

getElementsByTagNameback to summary
public NodeList getElementsByTagName(String tagname)

Implements org.w3c.dom.Document.getElementsByTagName.

Doc from org.w3c.dom.Document.getElementsByTagName.

Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.

getElementsByTagNameNSback to summary
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)

Implements org.w3c.dom.Document.getElementsByTagNameNS.

Doc from org.w3c.dom.Document.getElementsByTagNameNS.

Returns a NodeList of all the Elements with a given local name and namespace URI in document order.

getImplementationback to summary
public DOMImplementation getImplementation()

Implements org.w3c.dom.Document.getImplementation.

Doc from org.w3c.dom.Document.getImplementation.

The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.

getInputEncodingback to summary
public String getInputEncoding()

Implements org.w3c.dom.Document.getInputEncoding.

Doc from org.w3c.dom.Document.getInputEncoding.

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.

getStrictErrorCheckingback to summary
public boolean getStrictErrorChecking()

Implements org.w3c.dom.Document.getStrictErrorChecking.

An attribute specifying whether errors 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. In case of error, the behavior is undefined. This attribute is true by defaults.

Since
DOM Level 3
getXmlEncodingback to summary
public String getXmlEncoding()

Implements org.w3c.dom.Document.getXmlEncoding.

public void setInputEncoding(String actualEncoding){ throw new DOMException(DOMException.NOT_SUPPORTED_ERR, "Method not supported"); }

getXmlStandaloneback to summary
public boolean getXmlStandalone()

Implements org.w3c.dom.Document.getXmlStandalone.

An attribute specifying, as part of the XML declaration, whether this document is standalone.
This attribute represents the property [standalone] defined in .

Since
DOM Level 3
getXmlVersionback to summary
public String getXmlVersion()

Implements org.w3c.dom.Document.getXmlVersion.

An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.
This attribute represents the property [version] defined in .

Exceptions
DOMException:
NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document.
Since
DOM Level 3
importNodeback to summary
public Node importNode(Node importedNode, boolean deep) throws DOMException

Implements org.w3c.dom.Document.importNode.

Doc from org.w3c.dom.Document.importNode.

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.
Exceptions
DOMException:
NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
INVALID_CHARACTER_ERR: Raised if one of the imported names is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. This may happen when importing an XML 1.1 [XML 1.1] element into an XML 1.0 document, for instance.
normalizeDocumentback to summary
public void normalizeDocument()

Implements org.w3c.dom.Document.normalizeDocument.

DOM Level 3

renameNodeback to summary
public Node renameNode(Node n, String namespaceURI, String name) throws DOMException

Implements org.w3c.dom.Document.renameNode.

DOM Level 3

Exceptions
DOMException:

Doc from org.w3c.dom.Document.renameNode.

NOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE, or if the implementation does not support the renaming of the document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

setDocumentURIback to summary
public void setDocumentURI(String documentURI)

Implements org.w3c.dom.Document.setDocumentURI.

The location of the document or null if undefined.
Beware that when the Document supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.

Since
DOM Level 3
setStrictErrorCheckingback to summary
public void setStrictErrorChecking(boolean strictErrorChecking)

Implements org.w3c.dom.Document.setStrictErrorChecking.

An attribute specifying whether errors 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. In case of error, the behavior is undefined. This attribute is true by defaults.

Since
DOM Level 3
setXmlStandaloneback to summary
public void setXmlStandalone(boolean standalone)

Implements org.w3c.dom.Document.setXmlStandalone.

An attribute specifying, as part of the XML declaration, whether this document is standalone.
This attribute represents the property [standalone] defined in .

Since
DOM Level 3
setXmlVersionback to summary
public void setXmlVersion(String version) throws DOMException

Implements org.w3c.dom.Document.setXmlVersion.

An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.
This attribute represents the property [version] defined in .

Exceptions
DOMException:
NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document.
Since
DOM Level 3