Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.CoreDocumentImpl
Field Summary | |
protected String |
|
protected boolean |
|
protected int |
|
protected ElementImpl |
|
protected DocumentTypeImpl |
|
protected String |
|
protected boolean |
|
protected String |
|
protected Hashtable |
|
protected boolean |
|
protected Hashtable |
|
protected String |
|
protected boolean |
Fields inherited from class org.apache.xerces.dom.ParentNode | |
fNodeListCache , firstChild , ownerDocument |
Fields inherited from class org.apache.xerces.dom.ChildNode | |
nextSibling , previousSibling |
Constructor Summary | |
| |
| |
| |
|
Method Summary | |
void |
|
protected void |
|
org.w3c.dom.Node |
|
protected void |
|
protected void |
|
protected int |
|
protected void |
|
protected void |
|
protected void |
|
protected void |
|
Object |
|
org.w3c.dom.Node |
|
protected void |
|
protected void |
|
org.w3c.dom.Attr |
|
org.w3c.dom.Attr |
|
org.w3c.dom.Attr |
|
org.w3c.dom.CDATASection |
|
org.w3c.dom.Comment |
|
org.w3c.dom.DocumentFragment |
|
org.w3c.dom.DocumentType |
|
org.w3c.dom.Element |
|
ElementDefinitionImpl |
|
org.w3c.dom.Element |
|
org.w3c.dom.Element |
|
org.w3c.dom.Entity |
|
org.w3c.dom.EntityReference |
|
org.w3c.dom.Notation |
|
org.w3c.dom.ProcessingInstruction |
|
org.w3c.dom.Text |
|
protected boolean |
|
boolean |
|
String |
|
org.w3c.dom.DocumentType |
|
org.w3c.dom.Element |
|
String |
|
org.w3c.dom.DOMConfiguration |
|
org.w3c.dom.Element |
|
org.w3c.dom.NodeList |
|
org.w3c.dom.NodeList |
|
String |
|
boolean |
|
Object |
|
org.w3c.dom.Element |
|
Enumeration |
|
org.w3c.dom.DOMImplementation |
|
String |
|
String |
|
protected int |
|
protected int |
|
short |
|
org.w3c.dom.Document | |
boolean |
|
boolean | |
String | |
protected Object |
|
Object |
|
protected Hashtable |
|
String |
|
String |
|
boolean |
|
String |
|
org.w3c.dom.Node |
|
org.w3c.dom.Node |
|
protected boolean |
|
static boolean |
|
static boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
org.w3c.dom.Node |
|
protected void |
|
void |
|
org.w3c.dom.Node |
|
org.w3c.dom.Node |
|
String |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
Object |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
Methods inherited from class org.apache.xerces.dom.ParentNode | |
cloneNode , getChildNodes , getChildNodesUnoptimized , getFirstChild , getLastChild , getLength , getOwnerDocument , getTextContent , hasChildNodes , insertBefore , isEqualNode , item , normalize , removeChild , replaceChild , setOwnerDocument , setReadOnly , setTextContent , synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.ChildNode | |
cloneNode , getNextSibling , getParentNode , getPreviousSibling |
protected String actualEncoding
Experimental DOM Level 3 feature: Document actualEncoding
protected boolean allowGrammarAccess
Allow grammar access.
protected int changes
Number 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.
protected String encoding
Experimental DOM Level 3 feature: Document encoding
protected boolean errorChecking
Bypass error checking.
protected String fDocumentURI
Experimental DOM Level 3 feature: documentURI
protected Hashtable identifiers
Identifiers.
protected boolean standalone
Experimental DOM Level 3 feature: Document standalone
protected Hashtable userData
Table for user data attached to this document nodes.
protected String version
Experimental DOM Level 3 feature: Document version
protected boolean xmlVersionChanged
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.
public CoreDocumentImpl(boolean grammarAccess)
Constructor.
public CoreDocumentImpl(org.w3c.dom.DocumentType doctype)
For DOM2 support. The createDocument factory method is in DOMImplementation.
public CoreDocumentImpl(org.w3c.dom.DocumentType doctype, boolean grammarAccess)
For DOM2 support.
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.
protected void addEventListener(NodeImpl node, String type, org.w3c.dom.events.EventListener listener, boolean useCapture)
public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
DOM Level 3 WD - Experimental Change the node's ownerDocument, and its subtree, to this Document
- Specified by:
- adoptNode in interface org.w3c.dom.Document
- Parameters:
source
- The node to adopt.
- See Also:
importNode(Node,boolean)
protected void callUserDataHandlers(org.w3c.dom.Node n, org.w3c.dom.Node c, short operation)
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.
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. 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.
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.
- Parameters:
prefix
- prefix of qualified namelocal
- local part of qualified name
protected final void clearIdentifiers()
Remove all identifiers from the ID table
public Object clone() throws CloneNotSupportedException
Clone.
public org.w3c.dom.Node cloneNode(boolean deep)
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 interface org.w3c.dom.Node
- Overrides:
- cloneNode in interface ParentNode
- Parameters:
deep
- boolean, iff true replicate children
- Returns:
- org.w3c.dom.Node
protected void cloneNode(CoreDocumentImpl newdoc, boolean deep)
internal method to share code with subclass
public org.w3c.dom.Attr createAttribute(String name) throws org.w3c.dom.DOMException
Factory method; creates an Attribute having this Document as its OwnerDoc.
- Specified by:
- createAttribute in interface org.w3c.dom.Document
- Parameters:
name
- The name of the attribute. Note that the attribute's value is _not_ established at the factory; remember to set it!
public org.w3c.dom.Attr createAttributeNS(String namespaceURI, String qualifiedName) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Document
- 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:
org.w3c.dom.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
- Since:
- WD-DOM-Level-2-19990923
public org.w3c.dom.Attr createAttributeNS(String namespaceURI, String qualifiedName, String localpart) throws org.w3c.dom.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:
org.w3c.dom.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
public org.w3c.dom.CDATASection createCDATASection(String data) throws org.w3c.dom.DOMException
Factory method; creates a CDATASection having this Document as its OwnerDoc.
- Specified by:
- createCDATASection in interface org.w3c.dom.Document
- Parameters:
data
- The initial contents of the CDATA
public org.w3c.dom.Comment createComment(String data)
Factory method; creates a Comment having this Document as its OwnerDoc.
- Specified by:
- createComment in interface org.w3c.dom.Document
- Parameters:
data
- The initial contents of the Comment.
public org.w3c.dom.DocumentFragment createDocumentFragment()
Factory method; creates a DocumentFragment having this Document as its OwnerDoc.
- Specified by:
- createDocumentFragment in interface org.w3c.dom.Document
public org.w3c.dom.DocumentType createDocumentType(String qualifiedName, String publicID, String systemID) throws org.w3c.dom.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:
public org.w3c.dom.Element createElement(String tagName) throws org.w3c.dom.DOMException
Factory method; creates an Element having this Document as its OwnerDoc.
- Specified by:
- createElement in interface org.w3c.dom.Document
- 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.
public ElementDefinitionImpl createElementDefinition(String name) throws org.w3c.dom.DOMException
NON-DOM Factory method: creates an element definition. Element definitions hold default attribute values.
public org.w3c.dom.Element createElementNS(String namespaceURI, String qualifiedName) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Document
- 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:
org.w3c.dom.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.org.w3c.dom.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
public org.w3c.dom.Element createElementNS(String namespaceURI, String qualifiedName, String localpart) throws org.w3c.dom.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:
org.w3c.dom.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
public org.w3c.dom.Entity createEntity(String name) throws org.w3c.dom.DOMException
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.
public org.w3c.dom.EntityReference createEntityReference(String name) throws org.w3c.dom.DOMException
Factory method; creates an EntityReference having this Document as its OwnerDoc.
- Specified by:
- createEntityReference in interface org.w3c.dom.Document
- Parameters:
name
- The name of the Entity we wish to refer to
public org.w3c.dom.Notation createNotation(String name) throws org.w3c.dom.DOMException
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
public org.w3c.dom.ProcessingInstruction createProcessingInstruction(String target, String data) throws org.w3c.dom.DOMException
Factory method; creates a ProcessingInstruction having this Document as its OwnerDoc.
- Specified by:
- createProcessingInstruction in interface org.w3c.dom.Document
- Parameters:
target
- The target "processor channel"data
- Parameter string to be passed to the target.
public org.w3c.dom.Text createTextNode(String data)
Factory method; creates a Text node having this Document as its OwnerDoc.
- Specified by:
- createTextNode in interface org.w3c.dom.Document
- Parameters:
data
- The initial contents of the Text.
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.
public String 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 interface org.w3c.dom.Node
- Overrides:
- getBaseURI in interface NodeImpl
- Returns:
- The absolute base URI of this node or null.
- Since:
- DOM Level 3
public org.w3c.dom.DocumentType 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 interface org.w3c.dom.Document
public org.w3c.dom.Element 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 interface org.w3c.dom.Document
public String 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 interface org.w3c.dom.Document
- Since:
- DOM Level 3
public org.w3c.dom.DOMConfiguration getDomConfig()
DOM Level 3 CR - Experimental The configuration used whenDocument.normalizeDocument
is invoked.
- Specified by:
- getDomConfig in interface org.w3c.dom.Document
- Since:
- DOM Level 3
public org.w3c.dom.Element getElementById(String elementId)
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 interface org.w3c.dom.Document
- See Also:
getIdentifier(String)
public org.w3c.dom.NodeList getElementsByTagName(String tagname)
Return a live collection of all descendent Elements (not just immediate children) having the specified tag name.
- Specified by:
- getElementsByTagName in interface org.w3c.dom.Document
- Parameters:
tagname
- The type of Element we want to gather. "*" will be taken as a wildcard, meaning "all elements in the document."
- See Also:
DeepNodeListImpl
public org.w3c.dom.NodeList getElementsByTagNameNS(String namespaceURI, String localName)
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 interface org.w3c.dom.Document
- 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
public String getEncoding()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method.
public boolean getErrorChecking()
Returns true if the DOM implementation performs error checking.
public Object getFeature(String feature, String version)
- Specified by:
- getFeature in interface org.w3c.dom.Node
- Overrides:
- getFeature in interface NodeImpl
- Since:
- DOM Level 3
public org.w3c.dom.Element getIdentifier(String idName)
Returns a previously registered element with the specified identifier name, or null if no element is registered.
public Enumeration getIdentifiers()
Returns an enumeration registered of identifier names.
public org.w3c.dom.DOMImplementation 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 interface org.w3c.dom.Document
public String 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 interface org.w3c.dom.Document
- Since:
- DOM Level 3
public String getNodeName()
Returns the node name.
- Specified by:
- getNodeName in interface org.w3c.dom.Node
- Overrides:
- getNodeName in interface NodeImpl
protected int getNodeNumber()
NON-DOM: Get the number associated with this document. Used to order documents in the implementation.
- Overrides:
- getNodeNumber in interface NodeImpl
protected int getNodeNumber(org.w3c.dom.Node node)
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.
public short getNodeType()
Returns the node type.
- Specified by:
- getNodeType in interface org.w3c.dom.Node
- Overrides:
- getNodeType in interface NodeImpl
public final org.w3c.dom.Document getOwnerDocument()
- Specified by:
- getOwnerDocument in interface org.w3c.dom.Node
- Overrides:
- getOwnerDocument in interface ParentNode
public boolean getStandalone()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method.
public boolean getStrictErrorChecking()
- Specified by:
- getStrictErrorChecking in interface org.w3c.dom.Document
public String getTextContent() throws org.w3c.dom.DOMException
- Specified by:
- getTextContent in interface org.w3c.dom.Node
- Overrides:
- getTextContent in interface ParentNode
protected Object getUserData(NodeImpl n)
NON-DOM: kept for backward compatibility Retreive user data related to a given node
public Object getUserData(org.w3c.dom.Node n, String key)
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
protected Hashtable getUserDataRecord(org.w3c.dom.Node n)
public String getVersion()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method.
public String getXmlEncoding()
DOM Level 3 WD - Experimental. The encoding of this document (part of XML Declaration)
- Specified by:
- getXmlEncoding in interface org.w3c.dom.Document
public boolean getXmlStandalone()
DOM Level 3 WD - Experimental. standalone that specifies whether this document is standalone (part of XML Declaration)
- Specified by:
- getXmlStandalone in interface org.w3c.dom.Document
public String getXmlVersion()
DOM Level 3 WD - Experimental. The version of this document (part of XML Declaration)
- Specified by:
- getXmlVersion in interface org.w3c.dom.Document
public org.w3c.dom.Node importNode(org.w3c.dom.Node source, boolean deep) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Document
public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Node
- Overrides:
- insertBefore in interface ParentNode
protected boolean isKidOK(org.w3c.dom.Node parent, org.w3c.dom.Node child)
Uses the kidOK lookup table to check whether the proposed tree structure is legal.
public 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.
- Parameters:
prefix
- prefix of qualified namelocal
- local part of qualified name
public static final boolean isXMLName(String s, boolean xml11Version)
Check the string against XML's definition of acceptable names for elements and attributes and so on using the XMLCharacterProperties utility class
public boolean load(String uri)
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
.
public boolean loadXML(String source)
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
.
public void normalizeDocument()
DOM Level 3 WD - Experimental Normalize document.
- Specified by:
- normalizeDocument in interface org.w3c.dom.Document
public void putIdentifier(String idName, org.w3c.dom.Element element)
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.
public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Node
- Overrides:
- removeChild in interface ParentNode
protected void removeEventListener(NodeImpl node, String type, org.w3c.dom.events.EventListener listener, boolean useCapture)
public void removeIdentifier(String idName)
Removes a previously registered element with the specified identifier name.
public org.w3c.dom.Node renameNode(org.w3c.dom.Node n, String namespaceURI, String name) throws org.w3c.dom.DOMException
DOM Level 3 WD - Experimental. Renaming node
- Specified by:
- renameNode in interface org.w3c.dom.Document
public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException
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 interface org.w3c.dom.Node
- Overrides:
- replaceChild in interface ParentNode
public String saveXML(org.w3c.dom.Node node) throws org.w3c.dom.DOMException
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:
org.w3c.dom.DOMException
- WRONG_DOCUMENT_ERR: Raised if the node passed in as the node parameter is from an other document.
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.
public void setDocumentURI(String documentURI)
DOM Level 3 WD - Experimental.
- Specified by:
- setDocumentURI in interface org.w3c.dom.Document
public void setEncoding(String value)
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method.
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:Turning off error checking does not turn off the following checks:
- Checking strings to make sure that all characters are legal XML characters
- Hierarchy checking such as allowed children, checks for cycles, etc.
- Read only checks
- Checks related to DOM events
public 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. This isnull
otherwise.
This attribute represents the property [character encoding scheme] defined in .
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.
public void setStrictErrorChecking(boolean check)
- Specified by:
- setStrictErrorChecking in interface org.w3c.dom.Document
public void setTextContent(String textContent) throws org.w3c.dom.DOMException
- Specified by:
- setTextContent in interface org.w3c.dom.Node
- Overrides:
- setTextContent in interface ParentNode
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.
public Object setUserData(org.w3c.dom.Node n, String key, Object data, org.w3c.dom.UserDataHandler handler)
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
public void setVersion(String value)
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method.
public 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. This is null when unspecified.
public void setXmlStandalone(boolean value) throws org.w3c.dom.DOMException
DOM Level 3 CR - Experimental. Xmlstandalone - An attribute specifying, as part of the XML declaration, whether this document is standalone
- Specified by:
- setXmlStandalone in interface org.w3c.dom.Document
- Throws:
org.w3c.dom.DOMException
- NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
- Since:
- DOM Level 3
public void setXmlVersion(String value)
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 interface org.w3c.dom.Document
protected void undeferChildren(org.w3c.dom.Node node)
Traverses the DOM Tree and expands deferred nodes and their children.