| java.lang.Object
 org.apache.cocoon.xml.dom.DocumentWrapper
| DocumentWrapper | | public class DocumentWrapper implements org.w3c.dom.Document,XMLizable(Code) | | Wraps an org.w3c.dom.Document and offers additional interfaces
like XMLizable and a toString() method.
author:
Christian Haul
version:
CVS $Id: DocumentWrapper.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| public Node | adoptNode(Node source)
| | public Node | appendChild(Node newChild)
Adds the node newChild to the end of the list of children
of this node. | | public Node | cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy
constructor for nodes. | | public short | compareDocumentPosition(Node other)
| | public Attr | createAttribute(String name)
Creates an Attr of the given name. | | public Attr | createAttributeNS(String namespaceURI, String qualifiedName)
Creates an attribute of the given qualified name and namespace URI.
Parameters:
namespaceURI - The namespace URI of the attribute to create.
Parameters:
qualifiedName - The qualified name of the attribute toinstantiate. | | public CDATASection | createCDATASection(String data)
Creates a CDATASection node whose value is the specified
string.
Parameters:
data - The data for the CDATASection contents. | | public Comment | createComment(String data)
Creates a Comment node given the specified string.
Parameters:
data - The data for the node. | | public DocumentFragment | createDocumentFragment()
Creates an empty DocumentFragment object. | | public Element | createElement(String tagName)
Creates an element of the type specified. | | public Element | createElementNS(String namespaceURI, String qualifiedName)
Creates an element of the given qualified name and namespace URI.
Parameters:
namespaceURI - The namespace URI of the element to create.
Parameters:
qualifiedName - The qualified name of the element type toinstantiate. | | public EntityReference | createEntityReference(String name)
Creates an EntityReference object. | | public ProcessingInstruction | createProcessingInstruction(String target, String data)
Creates a ProcessingInstruction node given the specified
name and data strings.
Parameters:
target - The target part of the processing instruction.
Parameters:
data - The data for the node. | | public Text | createTextNode(String data)
Creates a Text node given the specified string.
Parameters:
data - The data for the node. | | public NamedNodeMap | getAttributes()
A NamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise. | | public String | getBaseURI()
| | public NodeList | getChildNodes()
A NodeList that contains all children of this node. | | public DocumentType | getDoctype()
The Document Type Declaration (see DocumentType)
associated with this document. | | public Element | getDocumentElement()
This is a convenience attribute that allows direct access to the child
node that is the root element of the document. | | public String | getDocumentURI()
| | public DOMConfiguration | getDomConfig()
| | public Element | getElementById(String elementId)
Returns the Element whose ID is given by
elementId. | | public NodeList | getElementsByTagName(String tagname)
Returns a NodeList of all the Elements with a
given tag name in the order in which they are encountered in a
preorder traversal of the Document tree.
Parameters:
tagname - The name of the tag to match on. | | public NodeList | getElementsByTagNameNS(String namespaceURI, String localName)
Returns a NodeList of all the Elements with a
given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document tree.
Parameters:
namespaceURI - The namespace URI of the elements to match on. | | public Object | getFeature(String feature, String version)
| | public Node | getFirstChild()
The first child of this node. | | public DOMImplementation | getImplementation()
The DOMImplementation object that handles this document. | | public String | getInputEncoding()
| | public Node | getLastChild()
The last child of this node. | | public String | getLocalName()
Returns the local part of the qualified name of this node. | | public String | getNamespaceURI()
The namespace URI of this node, or null if it is
unspecified.
This is not a computed value that is the result of a namespace
lookup based on an examination of the namespace declarations in
scope. | | public Node | getNextSibling()
The node immediately following this node. | | public String | getNodeName()
The name of this node, depending on its type; see the table above. | | public short | getNodeType()
A code representing the type of the underlying object, as defined above. | | public String | getNodeValue()
The value of this node, depending on its type; see the table above. | | public Document | getOwnerDocument()
The Document object associated with this node. | | public Node | getParentNode()
The parent of this node. | | public String | getPrefix()
The namespace prefix of this node, or null if it is
unspecified. | | public Node | getPreviousSibling()
The node immediately preceding this node. | | public boolean | getStrictErrorChecking()
| | public String | getTextContent()
| | public Object | getUserData(String key)
| | public String | getXmlEncoding()
| | public boolean | getXmlStandalone()
| | public String | getXmlVersion()
| | public boolean | hasAttributes()
Returns whether this node (if it is an element) has any attributes. | | public boolean | hasChildNodes()
Returns whether this node has any children. | | public Node | importNode(Node importedNode, boolean deep)
Imports a node from another document to this document. | | public Node | insertBefore(Node newChild, Node refChild)
Inserts the node newChild before the existing child node
refChild. | | public boolean | isDefaultNamespace(String namespaceURI)
| | public boolean | isEqualNode(Node arg)
| | public boolean | isSameNode(Node other)
| | public boolean | isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node.
Parameters:
feature - The name of the feature to test. | | public String | lookupNamespaceURI(String prefix)
| | public String | lookupPrefix(String namespaceURI)
| | public void | normalize()
Puts all Text nodes in the full depth of the sub-tree
underneath this Node, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text nodes, i.e., there are neither adjacent
Text nodes nor empty Text nodes. | | public void | normalizeDocument()
| | public Node | removeChild(Node oldChild)
Removes the child node indicated by oldChild from the list
of children, and returns it.
Parameters:
oldChild - The node being removed. | | public Node | renameNode(Node node, String namespaceURI, String qualifiedName)
| | public Node | replaceChild(Node newChild, Node oldChild)
Replaces the child node oldChild with newChild
in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object,
oldChild is replaced by all of the
DocumentFragment children, which are inserted in the
same order. | | public void | setDocumentURI(String uri)
| | public void | setNodeValue(String nodeValue)
The value of this node, depending on its type; see the table above. | | public void | setPrefix(String prefix)
The namespace prefix of this node, or null if it is
unspecified. | | public void | setStrictErrorChecking(boolean value)
| | public void | setTextContent(String textContent)
| | public Object | setUserData(String key, Object value, UserDataHandler handler)
| | public void | setXmlEncoding(String version)
| | public void | setXmlStandalone(boolean value)
| | public void | setXmlVersion(String version)
| | public void | toSAX(org.xml.sax.ContentHandler handler)
Generates SAX events representing the object's state.
NOTE : if the implementation can produce lexical events,
care should be taken that handler can actually be
a
org.apache.cocoon.xml.XMLConsumer that accepts such
events. | | public String | toString()
|
| DOMLEVEL3_ERR_MSG | | final protected static String DOMLEVEL3_ERR_MSG(Code) | | |
| DocumentWrapper | | public DocumentWrapper(Document doc)(Code) | | Creates a new instance of DocmentWrapper
|
| appendChild | | public Node appendChild(Node newChild) throws DOMException(Code) | | Adds the node newChild to the end of the list of children
of this node. If the newChild is already in the tree, it
is first removed.
Parameters:
newChild - The node to add.If it is aDocumentFragment object, the entire contents of thedocument fragment are moved into the child list of this node The node added.
exception:
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does notallow children of the type of the newChild node, or ifthe node to append is one of this node's ancestors or this nodeitself.
WRONG_DOCUMENT_ERR: Raised if newChild was createdfrom a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly orif the previous parent of the node being inserted is readonly. |
| cloneNode | | public Node cloneNode(boolean deep)(Code) | | Returns a duplicate of this node, i.e., serves as a generic copy
constructor for nodes. The duplicate node has no parent; (
parentNode is null.).
Cloning an Element copies all attributes and their
values, including those generated by the XML processor to represent
defaulted attributes, but this method does not copy any text it
contains unless it is a deep clone, since the text is contained in a
child Text node. Cloning an Attribute
directly, as opposed to be cloned as part of an Element
cloning operation, returns a specified attribute (
specified is true). Cloning any other type
of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy,
but the children of an EntityReference clone are readonly
. In addition, clones of unspecified Attr nodes are
specified. And, cloning Document,
DocumentType, Entity, and
Notation nodes is implementation dependent.
Parameters:
deep - If true, recursively clone the subtree underthe specified node; if false, clone only the nodeitself (and its attributes, if it is an Element). The duplicate node. |
| compareDocumentPosition | | public short compareDocumentPosition(Node other) throws DOMException(Code) | |
since:
DOM Level 3 |
| createAttribute | | public Attr createAttribute(String name) throws DOMException(Code) | | Creates an Attr of the given name. Note that the
Attr instance can then be set on an Element
using the setAttributeNode method.
To create an attribute with a qualified name and namespace URI, use
the createAttributeNS method.
Parameters:
name - The name of the attribute. A new Attr object with the nodeNameattribute set to name, and localName,prefix, and namespaceURI set tonull. The value of the attribute is the empty string.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains anillegal character. |
| createAttributeNS | | public Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException(Code) | | Creates an attribute of the given qualified name and namespace URI.
Parameters:
namespaceURI - The namespace URI of the attribute to create.
Parameters:
qualifiedName - The qualified name of the attribute toinstantiate. A new Attr object with the following attributes:| Attribute | Value |
|---|
Node.nodeName | qualifiedName | Node.namespaceURI | namespaceURI | Node.prefix | prefix, extracted fromqualifiedName, or null if there is noprefix | Node.localName | local name, extracted fromqualifiedName | Attr.name | qualifiedName | Node.nodeValue | the emptystring |
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified namecontains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName ismalformed per the Namespaces in XML specification, if thequalifiedName has a prefix and thenamespaceURI is null, if thequalifiedName has a prefix that is "xml" and thenamespaceURI is different from "http://www.w3.org/XML/1998/namespace", or if thequalifiedName, or its prefix, is "xmlns" and thenamespaceURI is different from "http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does notsupport the "XML" feature, since namespaces weredefined by XML.
since:
DOM Level 2 |
| createCDATASection | | public CDATASection createCDATASection(String data) throws DOMException(Code) | | Creates a CDATASection node whose value is the specified
string.
Parameters:
data - The data for the CDATASection contents. The new CDATASection object.
exception:
DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
| createComment | | public Comment createComment(String data)(Code) | | Creates a Comment node given the specified string.
Parameters:
data - The data for the node. The new Comment object. |
| createDocumentFragment | | public DocumentFragment createDocumentFragment()(Code) | | Creates an empty DocumentFragment object.
A new DocumentFragment. |
| createElement | | public Element createElement(String tagName) throws DOMException(Code) | | Creates an element of the type specified. Note that the instance
returned implements the Element interface, so attributes
can be specified directly on the returned object.
In addition, if there are known attributes with default values,
Attr nodes representing them are automatically created
and attached to the element.
To create an element with a qualified name and namespace URI, use
the createElementNS method.
Parameters:
tagName - The name of the element type to instantiate. For XML,this is case-sensitive. For HTML, the tagNameparameter may be provided in any case, but it must be mapped to thecanonical uppercase form by the DOM implementation. A new Element object with thenodeName attribute set to tagName, andlocalName, prefix, andnamespaceURI set to null.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains anillegal character. |
| createElementNS | | public Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException(Code) | | Creates an element of the given qualified name and namespace URI.
Parameters:
namespaceURI - The namespace URI of the element to create.
Parameters:
qualifiedName - The qualified name of the element type toinstantiate. A new Element object with the followingattributes:| Attribute | Value |
|---|
Node.nodeName | qualifiedName | Node.namespaceURI | namespaceURI | Node.prefix | prefix, extractedfrom qualifiedName, or null if there isno prefix | Node.localName | local name, extracted fromqualifiedName | Element.tagName | qualifiedName |
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified namecontains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName ismalformed per the Namespaces in XML specification, if thequalifiedName has a prefix and thenamespaceURI is null, or if thequalifiedName has a prefix that is "xml" and thenamespaceURI is different from "http://www.w3.org/XML/1998/namespace" .
NOT_SUPPORTED_ERR: Always thrown if the current document does notsupport the "XML" feature, since namespaces weredefined by XML.
since:
DOM Level 2 |
| createEntityReference | | public EntityReference createEntityReference(String name) throws DOMException(Code) | | Creates an EntityReference object. In addition, if the
referenced entity is known, the child list of the
EntityReference node is made the same as that of the
corresponding Entity node.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 does not support any mechanism to
resolve namespace prefixes.
Parameters:
name - The name of the entity to reference. The new EntityReference object.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains anillegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
| createProcessingInstruction | | public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException(Code) | | Creates a ProcessingInstruction node given the specified
name and data strings.
Parameters:
target - The target part of the processing instruction.
Parameters:
data - The data for the node. The new ProcessingInstruction object.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains anillegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
| createTextNode | | public Text createTextNode(String data)(Code) | | Creates a Text node given the specified string.
Parameters:
data - The data for the node. The new Text object. |
| getAttributes | | public NamedNodeMap getAttributes()(Code) | | A NamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise.
|
| getBaseURI | | public String getBaseURI()(Code) | |
since:
DOM Level 3 |
| getChildNodes | | public NodeList getChildNodes()(Code) | | A NodeList that contains all children of this node. If
there are no children, this is a NodeList containing no
nodes.
|
| getDoctype | | public DocumentType getDoctype()(Code) | | The Document Type Declaration (see DocumentType)
associated with this document. For HTML documents as well as XML
documents without a document type declaration this returns
null. The DOM Level 2 does not support editing the
Document Type Declaration. docType cannot be altered in
any way, including through the use of methods inherited from the
Node interface, such as insertNode or
removeNode.
|
| getDocumentElement | | public Element getDocumentElement()(Code) | | This is a convenience attribute that allows direct access to the child
node that is the root element of the document. For HTML documents,
this is the element with the tagName "HTML".
|
| getDocumentURI | | public String getDocumentURI()(Code) | |
since:
DOM Level 3 |
| getElementById | | public Element getElementById(String elementId)(Code) | | 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. 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.
Parameters:
elementId - The unique id value for an element. The matching element.
since:
DOM Level 2 |
| getElementsByTagName | | public NodeList getElementsByTagName(String tagname)(Code) | | Returns a NodeList of all the Elements with a
given tag name in the order in which they are encountered in a
preorder traversal of the Document tree.
Parameters:
tagname - The name of the tag to match on. The special value "*"matches all tags. A new NodeList object containing all the matchedElements. |
| getElementsByTagNameNS | | public NodeList getElementsByTagNameNS(String namespaceURI, String localName)(Code) | | Returns a NodeList of all the Elements with a
given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document tree.
Parameters:
namespaceURI - The namespace URI of the elements to match on. Thespecial value "*" matches all namespaces.
Parameters:
localName - The local name of the elements to match on. Thespecial value "*" matches all local names. A new NodeList object containing all the matchedElements.
since:
DOM Level 2 |
| getFirstChild | | public Node getFirstChild()(Code) | | The first child of this node. If there is no such node, this returns
null.
|
| getImplementation | | public DOMImplementation getImplementation()(Code) | | The DOMImplementation object that handles this document. A
DOM application may use objects from multiple implementations.
|
| getInputEncoding | | public String getInputEncoding()(Code) | |
since:
DOM Level 3 |
| getLastChild | | public Node getLastChild()(Code) | | The last child of this node. If there is no such node, this returns
null.
|
| getLocalName | | public String getLocalName()(Code) | | Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
Document interface, this is always null.
since:
DOM Level 2 |
| getNamespaceURI | | public String getNamespaceURI()(Code) | | The namespace URI of this node, or null if it is
unspecified.
This is not a computed value that is the result of a namespace
lookup based on an examination of the namespace declarations in
scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
Document interface, this is always null.Per
the Namespaces in XML Specification an attribute does not inherit
its namespace from the element it is attached to. If an attribute is
not explicitly given a namespace, it simply has no namespace.
since:
DOM Level 2 |
| getNextSibling | | public Node getNextSibling()(Code) | | The node immediately following this node. If there is no such node,
this returns null.
|
| getNodeName | | public String getNodeName()(Code) | | The name of this node, depending on its type; see the table above.
|
| getNodeType | | public short getNodeType()(Code) | | A code representing the type of the underlying object, as defined above.
|
| getNodeValue | | public String getNodeValue() throws DOMException(Code) | | The value of this node, depending on its type; see the table above.
When it is defined to be null, setting it has no effect.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMSTRING_SIZE_ERR: Raised when it would return more characters thanfit in a DOMString variable on the implementationplatform. |
| getOwnerDocument | | public Document getOwnerDocument()(Code) | | The Document object associated with this node. This is
also the Document object used to create new nodes. When
this node is a Document or a DocumentType
which is not used with any Document yet, this is
null.
since:
DOM Level 2 |
| getParentNode | | public Node getParentNode()(Code) | | The parent of this node. All nodes, except Attr,
Document, DocumentFragment,
Entity, and Notation may have a parent.
However, if a node has just been created and not yet added to the
tree, or if it has been removed from the tree, this is
null.
|
| getPrefix | | public String getPrefix()(Code) | | The namespace prefix of this node, or null if it is
unspecified.
Note that setting this attribute, when permitted, changes the
nodeName attribute, which holds the qualified name, as
well as the tagName and name attributes of
the Element and Attr interfaces, when
applicable.
Note also that changing the prefix of an attribute that is known to
have a default value, does not make a new attribute with the default
value and the original prefix appear, since the
namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
Document interface, this is always null.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains anillegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix ismalformed per the Namespaces in XML specification, if thenamespaceURI of this node is null, if thespecified prefix is "xml" and the namespaceURI of thisnode is different from "http://www.w3.org/XML/1998/namespace", ifthis node is an attribute and the specified prefix is "xmlns" andthe namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute andthe qualifiedName of this node is "xmlns" .
since:
DOM Level 2 |
| getPreviousSibling | | public Node getPreviousSibling()(Code) | | The node immediately preceding this node. If there is no such node,
this returns null.
|
| getStrictErrorChecking | | public boolean getStrictErrorChecking()(Code) | |
since:
DOM Level 3 |
| getXmlEncoding | | public String getXmlEncoding()(Code) | |
since:
DOM Level 3 |
| getXmlStandalone | | public boolean getXmlStandalone()(Code) | |
since:
DOM Level 3 |
| getXmlVersion | | public String getXmlVersion()(Code) | |
since:
DOM Level 3 |
| hasAttributes | | public boolean hasAttributes()(Code) | | Returns whether this node (if it is an element) has any attributes.
true if this node has any attributes,false otherwise.
since:
DOM Level 2 |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Returns whether this node has any children.
true if this node has any children,false otherwise. |
| importNode | | public Node importNode(Node importedNode, boolean deep) throws DOMException(Code) | | Imports a node from another document to this document. The returned
node has no parent; (parentNode is null).
The source node is not altered or removed from the original document;
this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the
importing document, with attribute values identical to the source
node's nodeName and nodeType, plus the
attributes related to namespaces (prefix,
localName, and namespaceURI). As in the
cloneNode operation on a Node, the source
node is not altered.
Additional information is copied as appropriate to the
nodeType, attempting to mirror the behavior expected if
a fragment of XML or HTML source was copied from one document to
another, recognizing that the two documents may have different DTDs
in the XML case. The following list describes the specifics for each
type of node.
- ATTRIBUTE_NODE
- The
ownerElement attribute
is set to null and the specified flag is
set to true on the generated Attr. The
descendants of the source Attr are recursively imported
and the resulting nodes reassembled to form the corresponding subtree.
Note that the deep parameter has no effect on
Attr nodes; they always carry their children with them
when imported.
- DOCUMENT_FRAGMENT_NODE
- If the
deep option
was set to true, the descendants of the source element
are recursively imported and the resulting nodes reassembled to form
the corresponding subtree. Otherwise, this simply generates an empty
DocumentFragment.
- DOCUMENT_NODE
Document
nodes cannot be imported.- DOCUMENT_TYPE_NODE
DocumentType
nodes cannot be imported.- ELEMENT_NODE
- Specified attribute nodes of the
source element are imported, and the generated
Attr
nodes are attached to the generated Element. Default
attributes are not copied, though if the document being imported into
defines default attributes for this element name, those are assigned.
If the importNode deep parameter was set to
true, the descendants of the source element are
recursively imported and the resulting nodes reassembled to form the
corresponding subtree.
- ENTITY_NODE
Entity nodes can be
imported, however in the current release of the DOM the
DocumentType is readonly. Ability to add these imported
nodes to a DocumentType will be considered for addition
to a future release of the DOM.On import, the publicId,
systemId, and notationName attributes are
copied. If a deep import is requested, the descendants
of the the source Entity are recursively imported and
the resulting nodes reassembled to form the corresponding subtree.-
ENTITY_REFERENCE_NODE
- Only the
EntityReference itself is
copied, even if a deep import is requested, since the
source and destination documents might have defined the entity
differently. If the document being imported into provides a
definition for this entity name, its value is assigned.
- NOTATION_NODE
-
Notation nodes can be imported, however in the current
release of the DOM the DocumentType is readonly. Ability
to add these imported nodes to a DocumentType will be
considered for addition to a future release of the DOM.On import, the
publicId and systemId attributes are copied.
Note that the deep parameter has no effect on
Notation nodes since they never have any children.
-
PROCESSING_INSTRUCTION_NODE
- The imported node copies its
target and data values from those of the
source node.
- TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
- These three
types of nodes inheriting from
CharacterData copy their
data and length attributes from those of
the source node.
Parameters:
importedNode - The node to import.
Parameters:
deep - If true, recursively import the subtree underthe specified node; if false, import only the nodeitself, as explained above. This has no effect on Attr, EntityReference, and Notation nodes. The imported node that belongs to this Document.
exception:
DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is notsupported.
since:
DOM Level 2 |
| insertBefore | | public Node insertBefore(Node newChild, Node refChild) throws DOMException(Code) | | Inserts the node newChild before the existing child node
refChild. If refChild is null,
insert newChild at the end of the list of children.
If newChild is a DocumentFragment object,
all of its children are inserted, in the same order, before
refChild. If the newChild is already in the
tree, it is first removed.
Parameters:
newChild - The node to insert.
Parameters:
refChild - The reference node, i.e., the node before which thenew node must be inserted. The node being inserted.
exception:
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does notallow children of the type of the newChild node, or ifthe node to insert is one of this node's ancestors or this nodeitself.
WRONG_DOCUMENT_ERR: Raised if newChild was createdfrom a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly orif the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child ofthis node. |
| isDefaultNamespace | | public boolean isDefaultNamespace(String namespaceURI)(Code) | |
since:
DOM Level 3 |
| isEqualNode | | public boolean isEqualNode(Node arg)(Code) | |
since:
DOM Level 3 |
| isSameNode | | public boolean isSameNode(Node other)(Code) | |
since:
DOM Level 3 |
| isSupported | | public boolean isSupported(String feature, String version)(Code) | | Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node.
Parameters:
feature - The name of the feature to test. This is the same namewhich can be passed to the method hasFeature onDOMImplementation.
Parameters:
version - This is the version number of the feature to test. InLevel 2, version 1, this is the string "2.0". If the version is notspecified, supporting any version of the feature will cause themethod to return true. Returns true if the specified feature issupported on this node, false otherwise.
since:
DOM Level 2 |
| normalize | | public void normalize()(Code) | | Puts all Text nodes in the full depth of the sub-tree
underneath this Node, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text nodes, i.e., there are neither adjacent
Text nodes nor empty Text nodes. This can
be used to ensure that the DOM view of a document is the same as if
it were saved and re-loaded, and is useful when operations (such as
XPointer lookups) that depend on a particular document tree
structure are to be used.In cases where the document contains
CDATASections, the normalize operation alone may not be
sufficient, since XPointers do not differentiate between
Text nodes and CDATASection nodes.
since:
DOM Level 2 |
| normalizeDocument | | public void normalizeDocument()(Code) | |
since:
DOM Level 3 |
| removeChild | | public Node removeChild(Node oldChild) throws DOMException(Code) | | Removes the child node indicated by oldChild from the list
of children, and returns it.
Parameters:
oldChild - The node being removed. The node removed.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child ofthis node. |
| replaceChild | | public Node replaceChild(Node newChild, Node oldChild) throws DOMException(Code) | | Replaces the child node oldChild with newChild
in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object,
oldChild is replaced by all of the
DocumentFragment children, which are inserted in the
same order. If the newChild is already in the tree, it
is first removed.
Parameters:
newChild - The new node to put in the child list.
Parameters:
oldChild - The node being replaced in the list. The node replaced.
exception:
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does notallow children of the type of the newChild node, or ifthe node to put in is one of this node's ancestors or this nodeitself.
WRONG_DOCUMENT_ERR: Raised if newChild was createdfrom a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent ofthe new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child ofthis node. |
| setDocumentURI | | public void setDocumentURI(String uri)(Code) | |
since:
DOM Level 3 |
| setNodeValue | | public void setNodeValue(String nodeValue) throws DOMException(Code) | | The value of this node, depending on its type; see the table above.
When it is defined to be null, setting it has no effect.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMSTRING_SIZE_ERR: Raised when it would return more characters thanfit in a DOMString variable on the implementationplatform. |
| setPrefix | | public void setPrefix(String prefix) throws DOMException(Code) | | The namespace prefix of this node, or null if it is
unspecified.
Note that setting this attribute, when permitted, changes the
nodeName attribute, which holds the qualified name, as
well as the tagName and name attributes of
the Element and Attr interfaces, when
applicable.
Note also that changing the prefix of an attribute that is known to
have a default value, does not make a new attribute with the default
value and the original prefix appear, since the
namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
Document interface, this is always null.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains anillegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix ismalformed per the Namespaces in XML specification, if thenamespaceURI of this node is null, if thespecified prefix is "xml" and the namespaceURI of thisnode is different from "http://www.w3.org/XML/1998/namespace", ifthis node is an attribute and the specified prefix is "xmlns" andthe namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute andthe qualifiedName of this node is "xmlns" .
since:
DOM Level 2 |
| setStrictErrorChecking | | public void setStrictErrorChecking(boolean value)(Code) | |
since:
DOM Level 3 |
| setXmlEncoding | | public void setXmlEncoding(String version)(Code) | |
since:
DOM Level 3 |
| setXmlStandalone | | public void setXmlStandalone(boolean value)(Code) | |
since:
DOM Level 3 |
| setXmlVersion | | public void setXmlVersion(String version)(Code) | |
since:
DOM Level 3 |
|
|