java.lang.Object | |
↳ | org.apache.xerces.dom.NodeImpl |
Known Direct Subclasses |
NodeImpl provides the basic structure of a DOM tree. It is never used directly, but instead is subclassed to add type and data information, and additional methods, appropriate to each node of the tree. Only its subclasses should be instantiated -- and those, with the exception of Document itself, only through a specific Document's factory methods.
The Node interface provides shared behaviors such as siblings and children, both for consistancy and so that the most common tree operations may be performed without constantly having to downcast to specific node types. When there is no obvious mapping for one of these queries, it will respond with null. Note that the default behavior is that children are forbidden. To permit them, the subclass ParentNode overrides several methods.
NodeImpl also implements NodeList, so it can return itself in response to the getChildNodes() query. This eliminiates the need for a separate ChildNodeList object. Note that this is an IMPLEMENTATION DETAIL; applications should _never_ assume that this identity exists.
All nodes in a single document must originate in that document. (Note that this is much tighter than "must be same implementation") Nodes are all aware of their ownerDocument, and attempts to mismatch will throw WRONG_DOCUMENT_ERR.
However, to save memory not all nodes always have a direct reference to their ownerDocument. When a node is owned by another node it relies on its owner to store its ownerDocument. Parent nodes always store it though, so there is never more than one level of indirection. And when a node doesn't have an owner, ownerNode refers to its ownerDocument.
This class doesn't directly support mutation events, however, it still implements the EventTarget interface and forward all related calls to the document so that the document class do so.@xerces.internal
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
short | DOCUMENT_POSITION_CONTAINS | ||||||||||
short | DOCUMENT_POSITION_DISCONNECTED | ||||||||||
short | DOCUMENT_POSITION_FOLLOWING | ||||||||||
short | DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC | ||||||||||
short | DOCUMENT_POSITION_IS_CONTAINED | ||||||||||
short | DOCUMENT_POSITION_PRECEDING | ||||||||||
short | ELEMENT_DEFINITION_NODE | Element definition node type. | |||||||||
short | FIRSTCHILD | ||||||||||
short | HASSTRING | ||||||||||
short | ID | ||||||||||
short | IGNORABLEWS | ||||||||||
short | NORMALIZED | ||||||||||
short | OWNED | ||||||||||
short | READONLY | ||||||||||
short | SPECIFIED | ||||||||||
short | SYNCCHILDREN | ||||||||||
short | SYNCDATA | ||||||||||
short | TREE_POSITION_ANCESTOR | The node is an ancestor of the reference node. | |||||||||
short | TREE_POSITION_DESCENDANT | The node is a descendant of the reference node. | |||||||||
short | TREE_POSITION_DISCONNECTED | The two nodes are disconnected, they do not have any common ancestor. | |||||||||
short | TREE_POSITION_EQUIVALENT | The two nodes have an equivalent position. | |||||||||
short | TREE_POSITION_FOLLOWING | The node follows the reference node. | |||||||||
short | TREE_POSITION_PRECEDING | The node precedes the reference node. | |||||||||
short | TREE_POSITION_SAME_NODE | The two nodes are the same. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
org.w3c.dom.Node
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
flags | |||||||||||
ownerNode |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor for serialization.
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
No public constructor; only subclasses of Node should be
instantiated, and those normally via a Document's factory methods
Every Node knows what Document it belongs to. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a child node to the end of the list of children for this node.
| |||||||||||
Returns a duplicate of a given node.
| |||||||||||
Compares a node with this node with regard to their position in the
document.
| |||||||||||
This method is deprecated.
No replacement.
| |||||||||||
Return the collection of attributes associated with this node,
or null if none.
| |||||||||||
The absolute base URI of this node or
null if undefined. | |||||||||||
Obtain a NodeList enumerating all children of this node.
| |||||||||||
The first child of this Node, or null if none.
| |||||||||||
The first child of this Node, or null if none.
| |||||||||||
NodeList method: Count the immediate children of this node
By default we do not have any children, ParentNode overrides this. | |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
The next child of this node's parent, or null if none
| |||||||||||
the name of this node.
| |||||||||||
A short integer indicating what type of node this is.
| |||||||||||
Returns the node value.
| |||||||||||
Find the Document that this Node belongs to (the document in
whose context the Node was created).
| |||||||||||
Obtain the DOM-tree parent of this node, or null if it is not
currently active in the DOM tree (perhaps because it has just been
created or removed).
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
The previous child of this node's parent, or null if none
| |||||||||||
NON-DOM: Returns true if this node is read-only.
| |||||||||||
This attribute returns the text content of this node and its
descendants.
| |||||||||||
NON-DOM:
Returns the user data associated to this node.
| |||||||||||
Retrieves the object associated to a key on a this node.
| |||||||||||
Returns whether this node (if it is an element) has any attributes.
| |||||||||||
Test whether this node has any children.
| |||||||||||
Move one or more node(s) to our list of children.
| |||||||||||
DOM Level 3: Experimental
This method checks if the specified
namespaceURI is the
default namespace or not. | |||||||||||
Tests whether two nodes are equal.
| |||||||||||
Returns whether this node is the same node as the given one.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
NodeList method: Return the Nth immediate child of this node, or
null if the index is out of bounds.
| |||||||||||
DOM Level 3 - Experimental:
Look up the namespace URI associated to the given prefix, starting from this node.
| |||||||||||
DOM Level 3 - Experimental:
Look up the prefix associated to the given namespace URI, starting from this node.
| |||||||||||
Puts all
Text nodes in the full depth of the sub-tree
underneath this Node , including attribute nodes, into a
"normal" form where only markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text nodes, i.e., there are no adjacent Text
nodes. | |||||||||||
Remove a child from this Node.
| |||||||||||
Make newChild occupy the location that oldChild used to
have.
| |||||||||||
Sets the node value.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction
with Entities, but provides no API to support this.
| |||||||||||
This attribute returns the text content of this node and its
descendants.
| |||||||||||
Associate an object to a key on this node.
| |||||||||||
NON-DOM: As an alternative to subclassing the DOM, this implementation
has been extended with the ability to attach an object to each node.
| |||||||||||
NON-DOM method for debugging convenience.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Denotes that this node has changed.
| |||||||||||
Returns the number of changes to this node.
| |||||||||||
For non-child nodes, the node which "points" to this node.
| |||||||||||
Returns the node number
| |||||||||||
NON-DOM
set the ownerDocument of this node
| |||||||||||
Override this method in subclass to hook in efficient
internal data structure.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.w3c.dom.Node
| |||||||||||
From interface
org.w3c.dom.NodeList
| |||||||||||
From interface
org.w3c.dom.events.EventTarget
|
Element definition node type.
The node is an ancestor of the reference node.
The node is a descendant of the reference node.
The two nodes are disconnected, they do not have any common ancestor. This is the case of two nodes that are not in the same document.
The two nodes have an equivalent position. This is the case of two
attributes that have the same ownerElement
, and two
nodes that are the same.
The node follows the reference node.
The node precedes the reference node.
The two nodes are the same. Two nodes that are the same have an equivalent position, though the reverse may not be true.
Constructor for serialization.
No public constructor; only subclasses of Node should be instantiated, and those normally via a Document's factory methods
Every Node knows what Document it belongs to.
Adds a child node to the end of the list of children for this node. Convenience shorthand for insertBefore(newChild,null).
if newChild is of a type that shouldn't be a child of this node. | |
if newChild has a different owner document than we do. | |
if this node is read-only. | |
DOMException |
Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.
Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior.
Compares a node with this node with regard to their position in the document.
other | The node to compare against this node. |
---|
DOMException |
---|
This method is deprecated.
No replacement.
Compares a node with this node with regard to their position in the tree and according to the document order. This order can be extended by module that define additional types of nodes.
other | The node to compare against this node. |
---|
Return the collection of attributes associated with this node, or null if none. At this writing, Element is the only type of node which will ever have attributes.
The absolute base URI of this node or null
if undefined.
This value is computed according to . However, when the
Document
supports the feature "HTML" , the base URI is
computed using first the value of the href attribute of the HTML BASE
element if any, and the value of the documentURI
attribute from the Document
interface otherwise.
When the node is an Element
, a Document
or a a ProcessingInstruction
, this attribute represents
the properties [base URI] defined in . When the node is a
Notation
, an Entity
, or an
EntityReference
, this attribute represents the
properties [declaration base URI] in the . How will this be affected
by resolution of relative namespace URIs issue?It's not.Should this
only be on Document, Element, ProcessingInstruction, Entity, and
Notation nodes, according to the infoset? If not, what is it equal to
on other nodes? Null? An empty string? I think it should be the
parent's.No.Should this be read-only and computed or and actual
read-write attribute?Read-only and computed (F2F 19 Jun 2000 and
teleconference 30 May 2001).If the base HTML element is not yet
attached to a document, does the insert change the Document.baseURI?
Yes. (F2F 26 Sep 2001)
Obtain a NodeList enumerating all children of this node. If there are none, an (initially) empty NodeList is returned.
NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.
In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.
The first child of this Node, or null if none.
By default we do not have any children, ParentNode overrides this.
The first child of this Node, or null if none.
By default we do not have any children, ParentNode overrides this.
NodeList method: Count the immediate children of this node
By default we do not have any children, ParentNode overrides this.
Introduced in DOM Level 2.
Returns the local part of the qualified name of this node. For nodes created with a DOM Level 1 method, such as createElement from the Document interface, and for nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is the same as the nodeName attribute.
Introduced in DOM Level 2.
The namespace URI of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE, this is always null and setting it has no effect.
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 created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
The next child of this node's parent, or null if none
A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.
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.
Obtain the DOM-tree parent of this node, or null if it is not currently active in the DOM tree (perhaps because it has just been created or removed). Note that Document, DocumentFragment, and Attribute will never have parents.
Introduced in DOM Level 2.
The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
The previous child of this node's parent, or null if none
NON-DOM: Returns true if this node is read-only. This is a shallow check.
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 single 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 |
---|
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 nodes |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
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 a DOMString variable on the implementation
platform. |
Retrieves the object associated to a key on a this node. The object
must first have been set to this node by calling
setUserData
with the same key.
key | The key the object is associated to. |
---|
DOMObject
associated to the given key
on this node, or null
if there was none.Returns whether this node (if it is an element) has any attributes.
true
if this node has any attributes,
false
otherwise.Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)
By default we do not have any children, ParentNode overrides this.
Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.
By default we do not accept any children, ParentNode overrides this.
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(). |
if newChild is of a type that shouldn't be a child of this node, or if newChild is an ancestor of this node. | |
if newChild has a different owner document than we do. | |
if refChild is not a child of this node. | |
if this node is read-only. | |
DOMException |
DOM Level 3: Experimental
This method checks if the specified namespaceURI
is the
default namespace or not.
namespaceURI | The namespace URI to look for. |
---|
true
if the specified namespaceURI
is the default namespace, false
otherwise. Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e.,
whether the two nodes are references to the same object) which can be
tested with Node.isSameNode
. All nodes that are the same
will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are
satisfied: The two nodes are of the same type.The following string
attributes are equal: nodeName
, localName
,
namespaceURI
, prefix
, nodeValue
, baseURI
. This is: they are both null
, or
they have the same length and are character for character identical.
The attributes
NamedNodeMaps
are equal.
This is: they are both null
, or they have the same
length and for each node that exists in one map there is a node that
exists in the other map and is equal, although not necessarily at the
same index.The childNodes
NodeLists
are
equal. This is: they are both null
, or they have the
same length and contain equal nodes at the same index. This is true
for Attr
nodes as for any other type of node. Note that
normalization can affect equality; to avoid this, nodes should be
normalized before being compared.
For two DocumentType
nodes to be equal, the following
conditions must also be satisfied: The following string attributes
are equal: publicId
, systemId
,
internalSubset
.The entities
NamedNodeMaps
are equal.The notations
NamedNodeMaps
are equal.
On the other hand, the following do not affect equality: the
ownerDocument
attribute, the specified
attribute for Attr
nodes, the
isWhitespaceInElementContent
attribute for
Text
nodes, as well as any user data or event listeners
registered on the nodes.
arg | The node to compare equality with. |
---|
true
otherwise false
.Returns whether this node is the same node as the given one.
This method provides a way to determine whether two
Node
references returned by the implementation reference
the same object. When two Node
references are references
to the same object, even if through a proxy, the references may be
used completely interchangably, such that all attributes have the
same values and calling the same DOM method on either reference
always has exactly the same effect.
other | The node to test against. |
---|
true
if the nodes are the same,
false
otherwise.Introduced in DOM Level 2.
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
feature | The package name of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation. |
---|---|
version | This is the version number of the package name to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true. |
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
By default we do not have any children, ParentNode overrides this.
index | int |
---|
DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node. Use lookupNamespaceURI(null) to lookup the default namespace
DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.
Puts all Text
nodes in the full depth of the sub-tree
underneath this Node
, including attribute nodes, into a
"normal" form where only markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text
nodes, i.e., there are no adjacent 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.
Note that this implementation simply calls normalize() on this Node's children. It is up to implementors or Node to override normalize() to take action.
Remove a child from this Node. The removed child's subtree remains intact so it may be re-inserted elsewhere.
By default we do not have any children, ParentNode overrides this.
if oldChild is not a child of this node. | |
if this node is read-only. | |
DOMException |
Make newChild occupy the location that oldChild used to have. Note that newChild will first be removed from its previous parent, if any. Equivalent to inserting newChild before oldChild, then removing oldChild.
By default we do not have any children, ParentNode overrides this.
if newChild is of a type that shouldn't be a child of this node, or if newChild is one of our ancestors. | |
if newChild has a different owner document than we do. | |
if oldChild is not a child of this node. | |
if this node is read-only. | |
DOMException |
Introduced in DOM Level 2.
The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
Note that setting this attribute 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.
Raised if the specified prefix contains an invalid character. | |
DOMException |
NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction with Entities, but provides no API to support this.
Most DOM users should not touch this method. Its anticpated use is during construction of EntityRefernces, where it will be used to lock the contents replicated from Entity so they can't be casually altered. It _could_ be published as a DOM extension, if desired.
Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior.
readOnly | True or false as desired. |
---|---|
deep | If true, children are also toggled. Note that this will not change the state of an EntityReference or its children, which are always read-only. |
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 single 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 nodes |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
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 a DOMString variable on the implementation
platform. |
Associate an object to a key on this node. The object can later be
retrieved from this node by calling getUserData
with the
same key.
key | The key to associate the object to. |
---|---|
data | The object to associate to the given key, or
null to remove any existing association to that key. |
handler | The handler to associate to that key, or
null . |
DOMObject
previously associated to
the given key on this node, or null
if there was none.NON-DOM: As an alternative to subclassing the DOM, this implementation has been extended with the ability to attach an object to each node. (If you need multiple objects, you can attach a collection such as a vector or hashtable, then attach your application information to that.)
Important Note: You are responsible for removing references to your data on nodes that are no longer used. Failure to do so will prevent the nodes, your data is attached to, to be garbage collected until the whole document is.
data | the object to store or null to remove any existing reference |
---|
Denotes that this node has changed.
Returns the number of changes to this node.
For non-child nodes, the node which "points" to this node. For example, the owning element for an attribute
Returns the node number
Override this method in subclass to hook in efficient internal data structure.