java.lang.Object | |||
↳ | org.apache.xerces.dom.NodeImpl | ||
↳ | org.apache.xerces.dom.ChildNode | ||
↳ | org.apache.xerces.dom.ParentNode |
Known Direct Subclasses |
ParentNode inherits from ChildNode and adds the capability of having child nodes. Not every node in the DOM can have children, so only nodes that can should inherit from this class and pay the price for it.
ParentNode, just like 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. On the other hand, subclasses may need to override this, in case of conflicting names. This is the case for the classes HTMLSelectElementImpl and HTMLFormElementImpl of the HTML DOM.
While we have a direct reference to the first child, the last child is stored as the previous sibling of the first child. First child nodes are marked as being so, and getNextSibling hides this fact.
Note: Not all parent nodes actually need to also be a child. At some point we used to have ParentNode inheriting from NodeImpl and another class called ChildAndParentNode that inherited from ChildNode. But due to the lack of multiple inheritance a lot of code had to be duplicated which led to a maintenance nightmare. At the same time only a few nodes (Document, DocumentFragment, Entity, and Attribute) cannot be a child so the gain in memory wasn't really worth it. The only type for which this would be the case is Attribute, but we deal with there in another special way, so this is not applicable.
This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.
WARNING: Some of the code here is partially duplicated in AttrImpl, be careful to keep these two classes in sync!@xerces.internal
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From interface
org.w3c.dom.Node
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
fNodeListCache | NodeList cache | ||||||||||
firstChild | First child. | ||||||||||
ownerDocument | Owner document. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor for serialization.
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
No public constructor; only subclasses of ParentNode should be
instantiated, and those normally via a Document's factory methods
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a duplicate of a given node.
| |||||||||||
Obtain a NodeList enumerating all children of this node.
| |||||||||||
The first child of this Node, or null if none.
| |||||||||||
The last child of this Node, or null if none.
| |||||||||||
NodeList method: Count the immediate children of this node
| |||||||||||
Find the Document that this Node belongs to (the document in
whose context the Node was created).
| |||||||||||
This attribute returns the text content of this node and its
descendants.
| |||||||||||
Test whether this node has any children.
| |||||||||||
Move one or more node(s) to our list of children.
| |||||||||||
DOM Level 3 WD- Experimental.
| |||||||||||
NodeList method: Return the Nth immediate child of this node, or
null if the index is out of bounds.
| |||||||||||
Override default behavior to call normalize() on this Node's
children.
| |||||||||||
Remove a child from this Node.
| |||||||||||
Make newChild occupy the location that oldChild used to
have.
| |||||||||||
Override default behavior so that if deep is true, children are also
toggled.
| |||||||||||
This attribute returns the text content of this node and its
descendants.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a NodeList to access children that is use by subclass elements
that have methods named getLength() or item(int).
| |||||||||||
NON-DOM
set the ownerDocument of this node and its children
| |||||||||||
Override this method in subclass to hook in efficient
internal data structure.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.w3c.dom.Node
| |||||||||||
From interface
org.w3c.dom.NodeList
| |||||||||||
From interface
org.w3c.dom.events.EventTarget
|
NodeList cache
Constructor for serialization.
No public constructor; only subclasses of ParentNode should be instantiated, and those normally via a Document's factory methods
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.
Example: Cloning a Text node will copy both the node and the text it contains.
Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree.
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.
The last child of this Node, or null if none.
NodeList method: Count the immediate children of this node
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.
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 |
---|
Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)
Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.
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 WD- Experimental. Override inherited behavior from NodeImpl to support deep equal.
arg | The node to compare equality with. |
---|
true
otherwise false
.NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
index | int |
---|
Override default behavior to call 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.
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.
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 |
Override default behavior so that if deep is true, children are also toggled.
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. |
Note: 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 |
---|
Create a NodeList to access children that is use by subclass elements that have methods named getLength() or item(int). ChildAndParentNode optimizes getChildNodes() by implementing NodeList itself. However if a subclass Element implements methods with the same name as the NodeList methods, they will override the actually methods in this class.
To use this method, the subclass should implement getChildNodes() and have it call this method. The resulting NodeList instance maybe shared and cached in a transient field, but the cached value must be cleared if the node is cloned.
NON-DOM set the ownerDocument of this node and its children
Override this method in subclass to hook in efficient internal data structure.