Class CoreDocumentImpl
- All Implemented Interfaces:
Serializable
,Cloneable
,Document
,EventTarget
,Node
,NodeList
- Direct Known Subclasses:
DocumentImpl
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.
The CoreDocumentImpl class only implements the DOM Core. Additional modules are supported by the more complete DocumentImpl subclass.
Note: When any node in the document is serialized, the entire document is serialized along with it.
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Since:
- PR-DOM-Level-1-19980818.
- Version:
- $Id: CoreDocumentImpl.java 950601 2010-06-02 15:38:55Z mrglavas $
- Author:
- Arnaud Le Hors, IBM, Joe Kesselman, IBM, Andy Clark, IBM, Ralf Pfeiffer, IBM
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Experimental DOM Level 3 feature: Document actualEncodingprotected boolean
Allow grammar access.protected int
Number of alterations made to this document since its creation.protected ElementImpl
Document element.protected DocumentTypeImpl
Document type.protected String
Experimental DOM Level 3 feature: Document encodingprotected boolean
Bypass error checking.protected String
Experimental DOM Level 3 feature: documentURIprotected Hashtable
Identifiers.protected boolean
Experimental DOM Level 3 feature: Document standaloneprotected Map
Table for user data attached to this document nodes.protected String
Experimental DOM Level 3 feature: Document versionprotected boolean
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_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
ConstructorsConstructorDescriptionNON-DOM: Actually creating a Document is outside the DOM's spec, since it has to operate in terms of a particular implementation.CoreDocumentImpl
(boolean grammarAccess) Constructor.CoreDocumentImpl
(DocumentType doctype) For DOM2 support.CoreDocumentImpl
(DocumentType doctype, boolean grammarAccess) For DOM2 support. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
DOM Level 3 WD - Experimental.protected void
addEventListener
(NodeImpl node, String type, EventListener listener, boolean useCapture) DOM Level 3 WD - Experimental Change the node's ownerDocument, and its subtree, to this Documentprotected void
callUserDataHandlers
(Node n, Node c, short operation) Call user data handlers when a node is deleted (finalized)protected boolean
canRenameElements
(String newNamespaceURI, String newNodeName, ElementImpl el) protected void
changed()
Denotes that this node has changed.protected int
changes()
Returns the number of changes to this node.protected final void
checkDOMNSErr
(String prefix, String namespace) protected final void
checkNamespaceWF
(String qname, int colon1, int colon2) Call user data handlers to let them know the nodes they are related to are being deleted.protected final void
checkQName
(String prefix, String local) Checks if the given qualified name is legal with respect to the version of XML to which this document must conform.protected final void
Remove all identifiers from the ID tableclone()
Clone.cloneNode
(boolean deep) Deep-clone a document, including fixing ownerDoc for the cloned children.protected void
cloneNode
(CoreDocumentImpl newdoc, boolean deep) internal method to share code with subclassprotected void
copyEventListeners
(NodeImpl src, NodeImpl tgt) createAttribute
(String name) Factory method; creates an Attribute having this Document as its OwnerDoc.createAttributeNS
(String namespaceURI, String qualifiedName) Introduced in DOM Level 2.createAttributeNS
(String namespaceURI, String qualifiedName, String localpart) NON-DOM: a factory method used by the Xerces DOM parser to create an element.createCDATASection
(String data) Factory method; creates a CDATASection having this Document as its OwnerDoc.createComment
(String data) Factory method; creates a Comment having this Document as its OwnerDoc.Factory method; creates a DocumentFragment having this Document as its OwnerDoc.createDocumentType
(String qualifiedName, String publicID, String systemID) NON-DOM Factory method; creates a DocumentType having this Document as its OwnerDoc.createElement
(String tagName) Factory method; creates an Element having this Document as its OwnerDoc.NON-DOM Factory method: creates an element definition.createElementNS
(String namespaceURI, String qualifiedName) Introduced in DOM Level 2.createElementNS
(String namespaceURI, String qualifiedName, String localpart) NON-DOM: a factory method used by the Xerces DOM parser to create an element.createEntity
(String name) NON-DOM Factory method; creates an Entity having this Document as its OwnerDoc.createEntityReference
(String name) Factory method; creates an EntityReference having this Document as its OwnerDoc.createNotation
(String name) NON-DOM Factory method; creates a Notation having this Document as its OwnerDoc.createProcessingInstruction
(String target, String data) Factory method; creates a ProcessingInstruction having this Document as its OwnerDoc.createTextNode
(String data) Factory method; creates a Text node having this Document as its OwnerDoc.protected boolean
dispatchEvent
(NodeImpl node, Event event) boolean
getAsync()
DOM Level 3 WD - Experimental.Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.For XML, this provides access to the Document Type Definition.Convenience method, allowing direct access to the child node which is considered the root of the actual document content.DOM Level 3 WD - Experimental.DOM Level 3 CR - Experimental The configuration used whenDocument.normalizeDocument
is invoked.getElementById
(String elementId) Introduced in DOM Level 2 Returns the Element whose ID is given by elementId.getElementsByTagName
(String tagname) Return a live collection of all descendent Elements (not just immediate children) having the specified tag name.getElementsByTagNameNS
(String namespaceURI, String localName) Introduced in DOM Level 2.Deprecated.This method is internal and only exists for compatibility with older applications.boolean
Returns true if the DOM implementation performs error checking.getFeature
(String feature, String version) getIdentifier
(String idName) Returns a previously registered element with the specified identifier name, or null if no element is registered.Returns an enumeration registered of identifier names.Retrieve information describing the abilities of this particular DOM implementation.DOM Level 3 CR - Experimental.Returns the node name.protected int
NON-DOM: Get the number associated with this document.protected int
getNodeNumber
(Node node) NON-DOM: Get a number associated with a node created with respect to this document.short
Returns the node type.final Document
Find the Document that this Node belongs to (the document in whose context the Node was created).boolean
Deprecated.This method is internal and only exists for compatibility with older applications.boolean
This attribute returns the text content of this node and its descendants.protected Object
NON-DOM: kept for backward compatibility Retreive user data related to a given nodegetUserData
(Node n, String key) Retrieves the object associated to a key on a this node.protected Hashtable
Deprecated.This method is internal and only exists for compatibility with older applications.DOM Level 3 WD - Experimental.boolean
DOM Level 3 WD - Experimental.DOM Level 3 WD - Experimental.importNode
(Node source, boolean deep) Copies a node from another document to this document.insertBefore
(Node newChild, Node refChild) Since a Document may contain at most one top-level Element child, and at most one DocumentType declaraction, we need to subclass our add-children methods to implement this constraint.protected boolean
Uses the kidOK lookup table to check whether the proposed tree structure is legal.static final boolean
isValidQName
(String prefix, String local, boolean xml11Version) Checks if the given qualified name is legal with respect to the version of XML to which this document must conform.static final boolean
Check the string against XML's definition of acceptable names for elements and attributes and so on using the XMLCharacterProperties utility classboolean
DOM Level 3 WD - Experimental.boolean
DOM Level 3 WD - Experimental.void
DOM Level 3 WD - Experimental Normalize document.void
putIdentifier
(String idName, Element element) Registers an identifier name with a specified element node.removeChild
(Node oldChild) Since insertBefore caches the docElement (and, currently, docType), removeChild has to know how to undo the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any wayprotected void
removeEventListener
(NodeImpl node, String type, EventListener listener, boolean useCapture) void
removeIdentifier
(String idName) Removes a previously registered element with the specified identifier name.renameNode
(Node n, String namespaceURI, String name) DOM Level 3 WD - Experimental.replaceChild
(Node newChild, Node oldChild) Since we cache the docElement (and, currently, docType), replaceChild has to update the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any wayDOM Level 3 WD - Experimental.void
setAsync
(boolean async) DOM Level 3 WD - Experimental.void
setDocumentURI
(String documentURI) DOM Level 3 WD - Experimental.void
setEncoding
(String value) Deprecated.This method is internal and only exists for compatibility with older applications.void
setErrorChecking
(boolean check) Sets whether the DOM implementation performs error checking upon operations.void
setInputEncoding
(String value) DOM Internal (Was a DOM L3 Core WD public interface method setActualEncoding ) An attribute specifying the actual encoding of this document.void
setStandalone
(boolean value) Deprecated.This method is internal and only exists for compatibility with older applications.void
setStrictErrorChecking
(boolean check) void
setTextContent
(String textContent) This attribute returns the text content of this node and its descendants.protected void
setUserData
(NodeImpl n, Object data) NON-DOM: kept for backward compatibility Store user data related to a given node This is a place where we could use weak references! Indeed, the node here won't be GC'ed as long as some user data is attached to it, since the userData table will have a reference to the node.setUserData
(Node n, String key, Object data, UserDataHandler handler) Associate an object to a key on this node.void
setVersion
(String value) Deprecated.This method is internal and only exists for compatibility with older applications.void
setXmlEncoding
(String value) DOM Internal (Was a DOM L3 Core WD public interface method setXMLEncoding ) An attribute specifying, as part of the XML declaration, the encoding of this document.void
setXmlStandalone
(boolean value) DOM Level 3 CR - Experimental.void
setXmlVersion
(String value) DOM Level 3 CR - Experimental.protected void
undeferChildren
(Node node) Traverses the DOM Tree and expands deferred nodes and their children.Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setOwnerDocument, setReadOnly, synchronizeChildren
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getContainer, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, setPrefix, setUserData
-
Field Details
-
docType
Document type. -
docElement
Document element. -
encoding
Experimental DOM Level 3 feature: Document encoding -
actualEncoding
Experimental DOM Level 3 feature: Document actualEncoding -
version
Experimental DOM Level 3 feature: Document version -
standalone
protected boolean standaloneExperimental DOM Level 3 feature: Document standalone -
fDocumentURI
Experimental DOM Level 3 feature: documentURI -
userData
Table for user data attached to this document nodes. -
identifiers
Identifiers. -
changes
protected int changesNumber of alterations made to this document since its creation. Serves as a "dirty bit" so that live objects such as NodeList can recognize when an alteration has been made and discard its cached state information.Any method that alters the tree structure MUST cause or be accompanied by a call to changed(), to inform it that any outstanding NodeLists may have to be updated.
(Required because NodeList is simultaneously "live" and integer- indexed -- a bad decision in the DOM's design.)
Note that changes which do not affect the tree's structure -- changing the node's name, for example -- do _not_ have to call changed().
Alternative implementation would be to use a cryptographic Digest value rather than a count. This would have the advantage that "harmless" changes (those producing equal() trees) would not force NodeList to resynchronize. Disadvantage is that it's slightly more prone to "false negatives", though that's the difference between "wildly unlikely" and "absurdly unlikely". IF we start maintaining digests, we should consider taking advantage of them. Note: This used to be done a node basis, so that we knew what subtree changed. But since only DeepNodeList really use this today, the gain appears to be really small compared to the cost of having an int on every (parent) node plus having to walk up the tree all the way to the root to mark the branch as changed everytime a node is changed. So we now have a single counter global to the document. It means that some objects may flush their cache more often than necessary, but this makes nodes smaller and only the document needs to be marked as changed.
-
allowGrammarAccess
protected boolean allowGrammarAccessAllow grammar access. -
errorChecking
protected boolean errorCheckingBypass error checking. -
xmlVersionChanged
protected boolean xmlVersionChanged
-
-
Constructor Details
-
CoreDocumentImpl
public CoreDocumentImpl()NON-DOM: Actually creating a Document is outside the DOM's spec, since it has to operate in terms of a particular implementation. -
CoreDocumentImpl
public CoreDocumentImpl(boolean grammarAccess) Constructor. -
CoreDocumentImpl
For DOM2 support. The createDocument factory method is in DOMImplementation. -
CoreDocumentImpl
For DOM2 support.
-
-
Method Details
-
getOwnerDocument
Description copied from class:ParentNode
Find the Document that this Node belongs to (the document in whose context the Node was created). The Node may or may not currently be part of that Document's actual contents.- Specified by:
getOwnerDocument
in interfaceNode
- Overrides:
getOwnerDocument
in classParentNode
-
getNodeType
public short getNodeType()Returns the node type.- Specified by:
getNodeType
in interfaceNode
- Specified by:
getNodeType
in classNodeImpl
-
getNodeName
Returns the node name.- Specified by:
getNodeName
in interfaceNode
- Specified by:
getNodeName
in classNodeImpl
-
cloneNode
Deep-clone a document, including fixing ownerDoc for the cloned children. Note that this requires bypassing the WRONG_DOCUMENT_ERR protection. I've chosen to implement it by calling importNode which is DOM Level 2.- Specified by:
cloneNode
in interfaceNode
- Overrides:
cloneNode
in classParentNode
- Parameters:
deep
- boolean, iff true replicate children- Returns:
- org.w3c.dom.Node
- See Also:
-
cloneNode
internal method to share code with subclass -
insertBefore
Since a Document may contain at most one top-level Element child, and at most one DocumentType declaraction, we need to subclass our add-children methods to implement this constraint. Since appendChild() is implemented as insertBefore(,null), altering the latter fixes both.While I'm doing so, I've taken advantage of the opportunity to cache documentElement and docType so we don't have to search for them. REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way
- Specified by:
insertBefore
in interfaceNode
- Overrides:
insertBefore
in classParentNode
- Parameters:
newChild
- The Node to be moved to our subtree. As a convenience feature, inserting a DocumentNode will instead insert all its children.refChild
- Current child which newChild should be placed immediately before. If refChild is null, the insertion occurs after all existing Nodes, like appendChild().- Returns:
- newChild, in its new state (relocated, or emptied in the case of DocumentNode.)
- Throws:
DOMException
- See Also:
-
removeChild
Since insertBefore caches the docElement (and, currently, docType), removeChild has to know how to undo the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way- Specified by:
removeChild
in interfaceNode
- Overrides:
removeChild
in classParentNode
- Returns:
- oldChild, in its new state (removed).
- Throws:
DOMException
- See Also:
-
replaceChild
Since we cache the docElement (and, currently, docType), replaceChild has to update the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way- Specified by:
replaceChild
in interfaceNode
- Overrides:
replaceChild
in classParentNode
- Returns:
- oldChild, in its new state (removed).
- Throws:
DOMException
- See Also:
-
getTextContent
Description copied from class:NodeImpl
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a singleText
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, the returned string does not contain the element content whitespaces . 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 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, the returned string does not contain the element content whitespaces . 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, 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 nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
getTextContent
in interfaceNode
- Overrides:
getTextContent
in classParentNode
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
setTextContent
Description copied from class:NodeImpl
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a singleText
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, the returned string does not contain the element content whitespaces . 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, 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 nodesATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
setTextContent
in interfaceNode
- Overrides:
setTextContent
in classParentNode
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
getFeature
- Specified by:
getFeature
in interfaceNode
- Overrides:
getFeature
in classNodeImpl
- Since:
- DOM Level 3
createAttribute
Factory method; creates an Attribute having this Document as its OwnerDoc.- Specified by:
createAttribute
in interfaceDocument
- Parameters:
name
- The name of the attribute. Note that the attribute's value is _not_ established at the factory; remember to set it!- Throws:
DOMException
createCDATASection
Factory method; creates a CDATASection having this Document as its OwnerDoc.- Specified by:
createCDATASection
in interfaceDocument
- Parameters:
data
- The initial contents of the CDATA- Throws:
DOMException
createComment
Factory method; creates a Comment having this Document as its OwnerDoc.- Specified by:
createComment
in interfaceDocument
- Parameters:
data
- The initial contents of the Comment.
createDocumentFragment
Factory method; creates a DocumentFragment having this Document as its OwnerDoc.- Specified by:
createDocumentFragment
in interfaceDocument
createElement
Factory method; creates an Element having this Document as its OwnerDoc.- Specified by:
createElement
in interfaceDocument
- Parameters:
tagName
- The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.- Throws:
DOMException
createEntityReference
Factory method; creates an EntityReference having this Document as its OwnerDoc.- Specified by:
createEntityReference
in interfaceDocument
- Parameters:
name
- The name of the Entity we wish to refer to- Throws:
DOMException
createProcessingInstruction
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException Factory method; creates a ProcessingInstruction having this Document as its OwnerDoc.- Specified by:
createProcessingInstruction
in interfaceDocument
- Parameters:
target
- The target "processor channel"data
- Parameter string to be passed to the target.- Throws:
DOMException
createTextNode
Factory method; creates a Text node having this Document as its OwnerDoc.- Specified by:
createTextNode
in interfaceDocument
- Parameters:
data
- The initial contents of the Text.
getDoctype
For XML, this provides access to the Document Type Definition. For HTML documents, and XML documents which don't specify a DTD, it will be null.- Specified by:
getDoctype
in interfaceDocument
getDocumentElement
Convenience method, allowing direct access to the child node which is considered the root of the actual document content. For HTML, where it is legal to have more than one Element at the top level of the document, we pick the one with the tagName "HTML". For XML there should be only one top-level (HTML not yet supported.)- Specified by:
getDocumentElement
in interfaceDocument
getElementsByTagName
Return a live collection of all descendent Elements (not just immediate children) having the specified tag name.- Specified by:
getElementsByTagName
in interfaceDocument
- Parameters:
tagname
- The type of Element we want to gather. "*" will be taken as a wildcard, meaning "all elements in the document."- See Also:
getImplementation
Retrieve information describing the abilities of this particular DOM implementation. Intended to support applications that may be using DOMs retrieved from several different sources, potentially with different underlying representations.- Specified by:
getImplementation
in interfaceDocument
setErrorChecking
public void setErrorChecking(boolean check) Sets whether the DOM implementation performs error checking upon operations. Turning off error checking only affects the following DOM checks:- Checking strings to make sure that all characters are legal XML characters
- Hierarchy checking such as allowed children, checks for cycles, etc.
Turning off error checking does not turn off the following checks:
- Read only checks
- Checks related to DOM events
setStrictErrorChecking
public void setStrictErrorChecking(boolean check) - Specified by:
setStrictErrorChecking
in interfaceDocument
getErrorChecking
public boolean getErrorChecking()Returns true if the DOM implementation performs error checking.getStrictErrorChecking
public boolean getStrictErrorChecking()- Specified by:
getStrictErrorChecking
in interfaceDocument
getInputEncoding
DOM Level 3 CR - Experimental. (Was getActualEncoding) An attribute specifying the encoding used for this document at the time of the parsing. This isnull
when it is not known, such as when theDocument
was created in memory.- Specified by:
getInputEncoding
in interfaceDocument
- Since:
- DOM Level 3
setInputEncoding
DOM Internal (Was a DOM L3 Core WD public interface method setActualEncoding ) An attribute specifying the actual encoding of this document. This isnull
otherwise.
This attribute represents the property [character encoding scheme] defined in .setXmlEncoding
DOM Internal (Was a DOM L3 Core WD public interface method setXMLEncoding ) An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.setEncoding
Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.getXmlEncoding
DOM Level 3 WD - Experimental. The encoding of this document (part of XML Declaration)- Specified by:
getXmlEncoding
in interfaceDocument
getEncoding
Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.setXmlVersion
DOM Level 3 CR - Experimental. version - An attribute specifying, as part of the XML declaration, the version number of this document.- Specified by:
setXmlVersion
in interfaceDocument
setVersion
Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.getXmlVersion
DOM Level 3 WD - Experimental. The version of this document (part of XML Declaration)- Specified by:
getXmlVersion
in interfaceDocument
getVersion
Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.setXmlStandalone
DOM Level 3 CR - Experimental. Xmlstandalone - An attribute specifying, as part of the XML declaration, whether this document is standalone- Specified by:
setXmlStandalone
in interfaceDocument
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.- Since:
- DOM Level 3
setStandalone
public void setStandalone(boolean value) Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.getXmlStandalone
public boolean getXmlStandalone()DOM Level 3 WD - Experimental. standalone that specifies whether this document is standalone (part of XML Declaration)- Specified by:
getXmlStandalone
in interfaceDocument
getStandalone
public boolean getStandalone()Deprecated.This method is internal and only exists for compatibility with older applications. New applications should never call this method.getDocumentURI
DOM Level 3 WD - Experimental. The location of the document ornull
if undefined.
Beware that when theDocument
supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.- Specified by:
getDocumentURI
in interfaceDocument
- Since:
- DOM Level 3
canRenameElements
renameNode
DOM Level 3 WD - Experimental. Renaming node- Specified by:
renameNode
in interfaceDocument
- Throws:
DOMException
normalizeDocument
public void normalizeDocument()DOM Level 3 WD - Experimental Normalize document.- Specified by:
normalizeDocument
in interfaceDocument
getDomConfig
DOM Level 3 CR - Experimental The configuration used whenDocument.normalizeDocument
is invoked.- Specified by:
getDomConfig
in interfaceDocument
- Since:
- DOM Level 3
getBaseURI
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned.- Specified by:
getBaseURI
in interfaceNode
- Overrides:
getBaseURI
in classNodeImpl
- Returns:
- The absolute base URI of this node or null.
- Since:
- DOM Level 3
setDocumentURI
DOM Level 3 WD - Experimental.- Specified by:
setDocumentURI
in interfaceDocument
getAsync
public boolean getAsync()DOM Level 3 WD - Experimental. Indicates whether the method load should be synchronous or asynchronous. When the async attribute is set totrue
the load method returns control to the caller before the document has completed loading. The default value of this property isfalse
.
Setting the value of this attribute might throw NOT_SUPPORTED_ERR if the implementation doesn't support the mode the attribute is being set to. Should the DOM spec define the default value of this property? What if implementing both async and sync IO is impractical in some systems? 2001-09-14. default isfalse
but we need to check with Mozilla and IE.setAsync
public void setAsync(boolean async) DOM Level 3 WD - Experimental. Indicates whether the method load should be synchronous or asynchronous. When the async attribute is set totrue
the load method returns control to the caller before the document has completed loading. The default value of this property isfalse
.
Setting the value of this attribute might throw NOT_SUPPORTED_ERR if the implementation doesn't support the mode the attribute is being set to. Should the DOM spec define the default value of this property? What if implementing both async and sync IO is impractical in some systems? 2001-09-14. default isfalse
but we need to check with Mozilla and IE.abort
public void abort()DOM Level 3 WD - Experimental. If the document is currently being loaded as a result of the methodload
being invoked the loading and parsing is immediately aborted. The possibly partial result of parsing the document is discarded and the document is cleared.load
DOM Level 3 WD - Experimental. Replaces the content of the document with the result of parsing the given URI. Invoking this method will either block the caller or return to the caller immediately depending on the value of the async attribute. Once the document is fully loaded a "load" event (as defined in [DOM Level 3 Events] , except that theEvent.targetNode
will be the document, not an element) will be dispatched on the document. If an error occurs, an implementation dependent "error" event will be dispatched on the document. If this method is called on a document that is currently loading, the current load is interrupted and the new URI load is initiated.
When invoking this method the parameters used in theDOMParser
interface are assumed to have their default values with the exception that the parameters"entities"
,"normalize-characters"
,"check-character-normalization"
are set to"false"
.
The result of a call to this method is the same the result of a call toDOMParser.parseWithContext
with an input stream referencing the URI that was passed to this call, the document as the context node, and the actionACTION_REPLACE_CHILDREN
.- Parameters:
uri
- The URI reference for the XML file to be loaded. If this is a relative URI, the base URI used by the implementation is implementation dependent.- Returns:
- If async is set to
true
load
returnstrue
if the document load was successfully initiated. If an error occurred when initiating the document load,load
returnsfalse
.If async is set tofalse
load
returnstrue
if the document was successfully loaded and parsed. If an error occurred when either loading or parsing the URI,load
returnsfalse
.
loadXML
DOM Level 3 WD - Experimental. Replace the content of the document with the result of parsing the input string, this method is always synchronous.- Parameters:
source
- A string containing an XML document.- Returns:
true
if parsing the input string succeeded without errors, otherwisefalse
.
saveXML
DOM Level 3 WD - Experimental. Save the document or the given node and all its descendants to a string (i.e. serialize the document or node).
The parameters used in theLSSerializer
interface are assumed to have their default values when invoking this method.
The result of a call to this method is the same the result of a call toLSSerializer.writeToString
with the document as the node to write.- Parameters:
node
- Specifies what to serialize, if this parameter isnull
the whole document is serialized, if it's non-null the given node is serialized.- Returns:
- The serialized document or
null
in case an error occurred. - Throws:
DOMException
- WRONG_DOCUMENT_ERR: Raised if the node passed in as the node parameter is from an other document.
createDocumentType
public DocumentType createDocumentType(String qualifiedName, String publicID, String systemID) throws DOMException NON-DOM Factory method; creates a DocumentType having this Document as its OwnerDoc. (REC-DOM-Level-1-19981001 left the process of building DTD information unspecified.)- Parameters:
qualifiedName
-publicID
-systemID
-- Throws:
DOMException
createEntity
NON-DOM Factory method; creates an Entity having this Document as its OwnerDoc. (REC-DOM-Level-1-19981001 left the process of building DTD information unspecified.)- Parameters:
name
- The name of the Entity we wish to provide a value for.- Throws:
DOMException
createNotation
NON-DOM Factory method; creates a Notation having this Document as its OwnerDoc. (REC-DOM-Level-1-19981001 left the process of building DTD information unspecified.)- Parameters:
name
- The name of the Notation we wish to describe- Throws:
DOMException
createElementDefinition
NON-DOM Factory method: creates an element definition. Element definitions hold default attribute values.- Throws:
DOMException
getNodeNumber
protected int getNodeNumber()NON-DOM: Get the number associated with this document. Used to order documents in the implementation.- Overrides:
getNodeNumber
in classNodeImpl
getNodeNumber
NON-DOM: Get a number associated with a node created with respect to this document. Needed for compareDocumentPosition when nodes are disconnected. This is only used on demand.importNode
Copies a node from another document to this document. The new nodes are created using this document's factory methods and are populated with the data from the source's accessor methods defined by the DOM interfaces. Its behavior is otherwise similar to that of cloneNode.According to the DOM specifications, document nodes cannot be imported and a NOT_SUPPORTED_ERR exception is thrown if attempted.
- Specified by:
importNode
in interfaceDocument
- Throws:
DOMException
adoptNode
DOM Level 3 WD - Experimental Change the node's ownerDocument, and its subtree, to this DocumentundeferChildren
Traverses the DOM Tree and expands deferred nodes and their children.getElementById
Introduced in DOM Level 2 Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID.Note: The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.
- Specified by:
getElementById
in interfaceDocument
- See Also:
clearIdentifiers
protected final void clearIdentifiers()Remove all identifiers from the ID tableputIdentifier
Registers an identifier name with a specified element node. If the identifier is already registered, the new element node replaces the previous node. If the specified element node is null, removeIdentifier() is called.- See Also:
getIdentifier
Returns a previously registered element with the specified identifier name, or null if no element is registered.- See Also:
removeIdentifier
Removes a previously registered element with the specified identifier name.- See Also:
getIdentifiers
Returns an enumeration registered of identifier names.createElementNS
Introduced in DOM Level 2.Creates an element of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
- Specified by:
createElementNS
in interfaceDocument
- Parameters:
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to instantiate.- Returns:
- Element A new Element object with the following attributes:
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.DOMException
- NAMESPACE_ERR: Raised if the qualifiedName has a prefix that is "xml" and the namespaceURI is neither null nor an empty string nor "http://www.w3.org/XML/1998/namespace", or if the qualifiedName has a prefix different from "xml" and the namespaceURI is null or an empty string.- Since:
- WD-DOM-Level-2-19990923
createElementNS
public Element createElementNS(String namespaceURI, String qualifiedName, String localpart) throws DOMException NON-DOM: a factory method used by the Xerces DOM parser to create an element.- Parameters:
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to instantiate.localpart
- The local name of the attribute to instantiate.- Returns:
- Element A new Element object with the following attributes:
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
createAttributeNS
Introduced in DOM Level 2.Creates an attribute of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
- Specified by:
createAttributeNS
in interfaceDocument
- Parameters:
namespaceURI
- The namespace URI of the attribute to create. When it is null or an empty string, this method behaves like createAttribute.qualifiedName
- The qualified name of the attribute to instantiate.- Returns:
- Attr A new Attr object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.- Since:
- WD-DOM-Level-2-19990923
createAttributeNS
public Attr createAttributeNS(String namespaceURI, String qualifiedName, String localpart) throws DOMException NON-DOM: a factory method used by the Xerces DOM parser to create an element.- Parameters:
namespaceURI
- The namespace URI of the attribute to create. When it is null or an empty string, this method behaves like createAttribute.qualifiedName
- The qualified name of the attribute to instantiate.localpart
- The local name of the attribute to instantiate.- Returns:
- Attr A new Attr object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
getElementsByTagNameNS
Introduced in DOM Level 2.Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree.
- Specified by:
getElementsByTagNameNS
in interfaceDocument
- Parameters:
namespaceURI
- The namespace URI of the elements to match on. The special value "*" matches all namespaces. When it is null or an empty string, this method behaves like getElementsByTagName.localName
- The local name of the elements to match on. The special value "*" matches all local names.- Returns:
- NodeList A new NodeList object containing all the matched Elements.
- Since:
- WD-DOM-Level-2-19990923
clone
Clone.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
isXMLName
Check the string against XML's definition of acceptable names for elements and attributes and so on using the XMLCharacterProperties utility classisValidQName
Checks if the given qualified name is legal with respect to the version of XML to which this document must conform.- Parameters:
prefix
- prefix of qualified namelocal
- local part of qualified name
isKidOK
Uses the kidOK lookup table to check whether the proposed tree structure is legal.changed
protected void changed()Denotes that this node has changed.changes
protected int changes()Returns the number of changes to this node.setUserData
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.- Parameters:
n
- The node to associate the object to.key
- The key to associate the object to.data
- The object to associate to the given key, ornull
to remove any existing association to that key.handler
- The handler to associate to that key, ornull
.- Returns:
- Returns the
DOMObject
previously associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3 REVISIT: we could use a free list of UserDataRecord here
getUserData
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.- Parameters:
n
- The node the object is associated to.key
- The key the object is associated to.- Returns:
- Returns the
DOMObject
associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3
getUserDataRecord
callUserDataHandlers
Call user data handlers when a node is deleted (finalized)- Parameters:
n
- The node this operation applies to.c
- The copy node or null.operation
- The operation - import, clone, or delete.
checkNamespaceWF
Call user data handlers to let them know the nodes they are related to are being deleted. The alternative would be to do that on Node but because the nodes are used as the keys we have a reference to them that prevents them from being gc'ed until the document is. At the same time, doing it here has the advantage of avoiding a finalize() method on Node, which would affect all nodes and not just the ones that have a user data.checkDOMNSErr
checkQName
Checks if the given qualified name is legal with respect to the version of XML to which this document must conform.- Parameters:
prefix
- prefix of qualified namelocal
- local part of qualified name
setUserData
NON-DOM: kept for backward compatibility Store user data related to a given node This is a place where we could use weak references! Indeed, the node here won't be GC'ed as long as some user data is attached to it, since the userData table will have a reference to the node.getUserData
NON-DOM: kept for backward compatibility Retreive user data related to a given nodeaddEventListener
protected void addEventListener(NodeImpl node, String type, EventListener listener, boolean useCapture) removeEventListener
protected void removeEventListener(NodeImpl node, String type, EventListener listener, boolean useCapture) copyEventListeners
dispatchEvent
-