public final class DocumentImpl extends InnerNodeImpl implements Document
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.
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 and Description |
|---|
DocumentImpl(DOMImplementationImpl impl,
String namespaceURI,
String qualifiedName,
DocumentType doctype,
String inputEncoding) |
| Modifier and Type | Method and Description |
|---|---|
Node |
adoptNode(Node node)
Detaches the node from its parent (if any) and changes its document to
this document.
|
AttrImpl |
createAttribute(String name)
Creates an
Attr of the given name. |
AttrImpl |
createAttributeNS(String namespaceURI,
String qualifiedName)
Creates an attribute of the given qualified name and namespace URI.
|
CDATASectionImpl |
createCDATASection(String data)
Creates a
CDATASection node whose value is the specified
string. |
CommentImpl |
createComment(String data)
Creates a
Comment node given the specified string. |
DocumentFragmentImpl |
createDocumentFragment()
Creates an empty
DocumentFragment object. |
ElementImpl |
createElement(String tagName)
Creates an element of the type specified.
|
ElementImpl |
createElementNS(String namespaceURI,
String qualifiedName)
Creates an element of the given qualified name and namespace URI.
|
EntityReferenceImpl |
createEntityReference(String name)
Creates an
EntityReference object. |
ProcessingInstructionImpl |
createProcessingInstruction(String target,
String data)
Creates a
ProcessingInstruction node given the specified
name and data strings. |
TextImpl |
createTextNode(String data)
Creates a
Text node given the specified string. |
DocumentType |
getDoctype()
The Document Type Declaration (see
DocumentType)
associated with this document. |
Element |
getDocumentElement()
This is a convenience attribute that allows direct access to the child
node that is the document element of the document.
|
String |
getDocumentURI()
The location of the document or
null if undefined or if
the Document was created using
DOMImplementation.createDocument. |
DOMConfiguration |
getDomConfig()
The configuration used when
Document.normalizeDocument()
is invoked. |
Element |
getElementById(String elementId)
Returns the
Element that has an ID attribute with the
given value. |
NodeList |
getElementsByTagName(String name)
Returns a
NodeList of all the Elements in
document order with a given tag name and are contained in the
document. |
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a
NodeList of all the Elements with a
given local name and namespace URI in document order. |
DOMImplementation |
getImplementation()
The
DOMImplementation object that handles this document. |
String |
getInputEncoding()
An attribute specifying the encoding used for this document at the time
of the parsing.
|
String |
getNodeName()
The name of this node, depending on its type; see the table above.
|
short |
getNodeType()
A code representing the type of the underlying object, as defined above.
|
boolean |
getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not.
|
String |
getTextContent()
This attribute returns the text content of this node and its
descendants.
|
String |
getXmlEncoding()
An attribute specifying, as part of the XML declaration, the encoding of this document.
|
boolean |
getXmlStandalone()
An attribute specifying, as part of the XML declaration, whether this document is standalone.
|
String |
getXmlVersion()
An attribute specifying, as part of the XML declaration, the version number of this document.
|
Node |
importNode(Node importedNode,
boolean deep)
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.
|
Node |
insertChildAt(Node toInsert,
int index)
Document elements may have at most one root element and at most one DTD
element.
|
void |
normalizeDocument()
This method acts as if the document was going through a save and load
cycle, putting the document in a "normal" form.
|
Node |
renameNode(Node node,
String namespaceURI,
String qualifiedName)
Rename an existing node of type
ELEMENT_NODE or
ATTRIBUTE_NODE. |
void |
setDocumentURI(String documentUri)
The location of the document or
null if undefined or if
the Document was created using
DOMImplementation.createDocument. |
void |
setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error checking is enforced or not.
|
void |
setXmlStandalone(boolean xmlStandalone)
An attribute specifying, as part of the XML declaration, whether this document is standalone.
|
void |
setXmlVersion(String xmlVersion)
An attribute specifying, as part of the XML declaration, the version number of this document.
|
appendChild, getChildNodes, getFirstChild, getLastChild, getNextSibling, hasChildNodes, insertBefore, isParentOf, normalize, removeChild, replaceChildgetParentNode, getPreviousSiblingcloneNode, compareDocumentPosition, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNodeValue, getOwnerDocument, getPrefix, getUserData, hasAttributes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setPrefix, setTextContent, setUserDataclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitappendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserDatapublic DocumentImpl(DOMImplementationImpl impl, String namespaceURI, String qualifiedName, DocumentType doctype, String inputEncoding)
public Node importNode(Node importedNode, boolean deep)
DocumentparentNode is null).
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.
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.
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.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
nodes cannot be imported.DocumentType
nodes cannot be imported.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 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.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 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.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.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.importNode in interface DocumentimportedNode - 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.Document.public Node adoptNode(Node node)
public Node renameNode(Node node, String namespaceURI, String qualifiedName)
DocumentELEMENT_NODE or
ATTRIBUTE_NODE.
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.
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.
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.
NODE_RENAMED is fired,
http://www.w3.org/2001/xml-events,
DOMElementNameChanged} or {
http://www.w3.org/2001/xml-events,
DOMAttributeNameChanged} is fired.
renameNode in interface Documentnode - The node to rename.namespaceURI - The new namespace URI.qualifiedName - The new qualified name.public AttrImpl createAttribute(String name)
DocumentAttr of the given name. Note that the
Attr instance can then be set on an Element
using the setAttributeNode method.
createAttributeNS method.createAttribute in interface Documentname - The name of the attribute.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.public AttrImpl createAttributeNS(String namespaceURI, String qualifiedName)
Documentnull as the
namespaceURI parameter for methods if they wish to have
no namespace.createAttributeNS in interface DocumentnamespaceURI - The namespace URI of the attribute to create.qualifiedName - The qualified name of the attribute to
instantiate.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 |
public CDATASectionImpl createCDATASection(String data)
DocumentCDATASection node whose value is the specified
string.createCDATASection in interface Documentdata - The data for the CDATASection contents.CDATASection object.public CommentImpl createComment(String data)
DocumentComment node given the specified string.createComment in interface Documentdata - The data for the node.Comment object.public DocumentFragmentImpl createDocumentFragment()
DocumentDocumentFragment object.createDocumentFragment in interface DocumentDocumentFragment.public ElementImpl createElement(String tagName)
DocumentElement interface, so attributes
can be specified directly on the returned object.
Attr nodes representing them are automatically created
and attached to the element.
createElementNS method.createElement in interface DocumenttagName - 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.Element object with the
nodeName attribute set to tagName, and
localName, prefix, and
namespaceURI set to null.public ElementImpl createElementNS(String namespaceURI, String qualifiedName)
Documentnull as the
namespaceURI parameter for methods if they wish to have no namespace.createElementNS in interface DocumentnamespaceURI - The namespace URI of the element to create.qualifiedName - The qualified name of the element type to
instantiate.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 |
public EntityReferenceImpl createEntityReference(String name)
DocumentEntityReference 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.
createEntityReference in interface Documentname - 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.EntityReference object.public ProcessingInstructionImpl createProcessingInstruction(String target, String data)
DocumentProcessingInstruction node given the specified
name and data strings.createProcessingInstruction in interface Documenttarget - 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.ProcessingInstruction object.public TextImpl createTextNode(String data)
DocumentText node given the specified string.createTextNode in interface Documentdata - The data for the node.Text object.public DocumentType getDoctype()
DocumentDocumentType)
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.
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.getDoctype in interface Documentpublic Element getDocumentElement()
DocumentgetDocumentElement in interface Documentpublic Element getElementById(String elementId)
DocumentElement 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.
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.
getElementById in interface DocumentelementId - The unique id value for an element.null if there is none.public NodeList getElementsByTagName(String name)
DocumentNodeList of all the Elements in
document order with a given tag name and are contained in the
document.getElementsByTagName in interface Documentname - 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.NodeList object containing all the matched
Elements.public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
DocumentNodeList of all the Elements with a
given local name and namespace URI in document order.getElementsByTagNameNS in interface DocumentnamespaceURI - 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.NodeList object containing all the matched
Elements.public DOMImplementation getImplementation()
DocumentDOMImplementation object that handles this document. A
DOM application may use objects from multiple implementations.getImplementation in interface Documentpublic String getNodeName()
NodegetNodeName in interface NodegetNodeName in class NodeImplpublic short getNodeType()
NodegetNodeType in interface NodegetNodeType in class NodeImplpublic Node insertChildAt(Node toInsert, int index)
public String getTextContent()
Nodenull, 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.
Text.isElementContentWhitespace). Similarly, on setting,
no parsing is performed either, the input string is taken as pure
textual content.
| 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 |
getTextContent in interface NodegetTextContent in class InnerNodeImplpublic String getInputEncoding()
Documentnull when it is not known, such
as when the Document was created in memory.getInputEncoding in interface Documentpublic String getXmlEncoding()
Documentnull when
unspecified or when it is not known, such as when the
Document was created in memory.getXmlEncoding in interface Documentpublic boolean getXmlStandalone()
Documentfalse 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].
getXmlStandalone in interface Documentpublic void setXmlStandalone(boolean xmlStandalone)
Documentfalse 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].
setXmlStandalone in interface Documentpublic String getXmlVersion()
Document"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.
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.getXmlVersion in interface Documentpublic void setXmlVersion(String xmlVersion)
Document"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.
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.setXmlVersion in interface Documentpublic boolean getStrictErrorChecking()
Documentfalse, 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.getStrictErrorChecking in interface Documentpublic void setStrictErrorChecking(boolean strictErrorChecking)
Documentfalse, 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.setStrictErrorChecking in interface Documentpublic String getDocumentURI()
Documentnull 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
.
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.getDocumentURI in interface Documentpublic void setDocumentURI(String documentUri)
Documentnull 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
.
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.setDocumentURI in interface Documentpublic DOMConfiguration getDomConfig()
DocumentDocument.normalizeDocument()
is invoked.getDomConfig in interface Documentpublic void normalizeDocument()
DocumentEntityReference nodes and normalizes Text
nodes, as defined in the method Node.normalize().
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();
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.normalizeDocument in interface Document