org.apache.xerces.dom
Class NodeContainer

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.NodeContainer

Direct Known Subclasses:

AttrImpl, DocumentFragmentImpl, DocumentImpl, DocumentTypeImpl, ElementDefinitionImpl, ElementImpl, EntityImpl, EntityReferenceImpl

public abstract class NodeContainer

extends NodeImpl

implements NodeList

NodeContainer inherits from NodeImpl 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.

NodeContainer, 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.

See Also:

Serialized Form

Field Summary

protected NodeImpl	firstChild First child.
protected static int[]	kidOK Table for quick check of child insertion.
protected NodeImpl	lastChild Last child.
protected int	nodeListChanges Last change number for index caching.
protected int	nodeListIndex Last requested node index.
protected int	nodeListLength Cached node list length.
protected NodeImpl	nodeListNode Last requested node.
protected boolean	syncChildren Synchronization of child nodes needed.

Fields inherited from class org.apache.xerces.dom.NodeImpl

ELEMENT_DEFINITION_NODE, fInternalSetNodeValue, MUTATION_AGGREGATE, MUTATION_ALL, MUTATION_LOCAL, MUTATION_NONE, MUTATIONEVENTS, name, nextSibling, ownerDocument, parentNode, previousSibling, readOnly, syncData, userData, value

Constructor Summary

	NodeContainer() Constructor for serialization.
protected	NodeContainer(DocumentImpl ownerDocument, java.lang.String name, java.lang.String value) No public constructor; only subclasses of NodeContainer should be instantiated, and those normally via a Document's factory methods

Method Summary

Node	appendChild(Node newChild) Adds a child node to the end of the list of children for this node.
Node	cloneNode(boolean deep) Returns a duplicate of a given node.
NodeList	getChildNodes() Obtain a NodeList enumerating all children of this node.
Node	getFirstChild() The first child of this Node, or null if none.
Node	getLastChild() The first child of this Node, or null if none.
int	getLength() NodeList method: Count the immediate children of this node
boolean	hasChildNodes() Test whether this node has any children.
Node	insertBefore(Node newChild, Node refChild) Move one or more node(s) to our list of children.
Node	item(int index) NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
void	normalize() Override default behavior to call normalize() on this Node's children.
Node	removeChild(Node oldChild) Remove a child from this Node.
Node	replaceChild(Node newChild, Node oldChild) Make newChild occupy the location that oldChild used to have.
void	setReadOnly(boolean readOnly, boolean deep) Override default behavior so that if deep is true, children are also toggled.
protected void	synchronizeChildren() Override this method in subclass to hook in efficient internal data structure.

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, dispatchEvent, finalize, getAttributes, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getUserData, removeEventListener, setNodeValue, setPrefix, setUserData, supports, synchronizeData, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

firstChild

protected NodeImpl firstChild

First child.

lastChild

protected NodeImpl lastChild

Last child.

nodeListChanges

protected transient int nodeListChanges

Last change number for index caching.

nodeListLength

protected transient int nodeListLength

Cached node list length.

nodeListNode

protected transient NodeImpl nodeListNode

Last requested node.

nodeListIndex

protected transient int nodeListIndex

Last requested node index.

syncChildren

protected transient boolean syncChildren

Synchronization of child nodes needed.

kidOK

protected static int[] kidOK

Table for quick check of child insertion.

Constructor Detail

NodeContainer

protected NodeContainer(DocumentImpl ownerDocument,
                        java.lang.String name,
                        java.lang.String value)

No public constructor; only subclasses of NodeContainer should be instantiated, and those normally via a Document's factory methods

NodeContainer

public NodeContainer()

Constructor for serialization.

Method Detail

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Adds a child node to the end of the list of children for this node. Convenience shorthand for insertBefore(newChild,null).

Overrides:

appendChild in class NodeImpl

Throws:

DOMException(HIERARCHY_REQUEST_ERR) - if newChild is of a type that shouldn't be a child of this node.

DOMException(WRONG_DOCUMENT_ERR) - if newChild has a different owner document than we do.

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if this node is read-only.

See Also:

insertBefore(Node, Node)

cloneNode

public Node cloneNode(boolean deep)

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.

Overrides:

cloneNode in class NodeImpl

Tags copied from class: NodeImpl

See Also:

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.

hasChildNodes

public boolean hasChildNodes()

Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)

Overrides:

hasChildNodes in class NodeImpl

Tags copied from class: NodeImpl

See Also:

NodeContainer

getChildNodes

public NodeList getChildNodes()

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.

Overrides:

getChildNodes in class NodeImpl

getFirstChild

public Node getFirstChild()

The first child of this Node, or null if none.

Overrides:

getFirstChild in class NodeImpl

Tags copied from class: NodeImpl

See Also:

NodeContainer

getLastChild

public Node getLastChild()

The first child of this Node, or null if none.

Overrides:

getLastChild in class NodeImpl

Tags copied from class: NodeImpl

See Also:

NodeContainer

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.

Overrides:

insertBefore in class NodeImpl

Parameters:

newChild - The Node to be moved to our subtree. As a convenience feature, inserting a DocumentNode will instead insert all its children.

refChild - Current child which newChild should be placed immediately before. If refChild is null, the insertion occurs after all existing Nodes, like appendChild().

Throws:

DOMException(HIERARCHY_REQUEST_ERR) - if newChild is of a type that shouldn't be a child of this node, or if newChild is an ancestor of this node.

DOMException(WRONG_DOCUMENT_ERR) - if newChild has a different owner document than we do.

DOMException(NOT_FOUND_ERR) - if refChild is not a child of this node.

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if this node is read-only.

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Remove a child from this Node. The removed child's subtree remains intact so it may be re-inserted elsewhere.

Overrides:

removeChild in class NodeImpl

Returns:

oldChild, in its new state (removed).

Throws:

DOMException(NOT_FOUND_ERR) - if oldChild is not a child of this node.

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if this node is read-only.

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws 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.

Overrides:

replaceChild in class NodeImpl

Throws:

DOMException(HIERARCHY_REQUEST_ERR) - if newChild is of a type that shouldn't be a child of this node, or if newChild is one of our ancestors.

DOMException(WRONG_DOCUMENT_ERR) - if newChild has a different owner document than we do.

DOMException(NOT_FOUND_ERR) - if oldChild is not a child of this node.

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if this node is read-only.

getLength

public int getLength()

NodeList method: Count the immediate children of this node

Specified by:

getLength in interface NodeList

Overrides:

getLength in class NodeImpl

Returns:

int

item

public Node item(int index)

NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.

Specified by:

item in interface NodeList

Overrides:

item in class NodeImpl

Parameters:

Index - int

Returns:

org.w3c.dom.Node

normalize

public void normalize()

Override default behavior to call normalize() on this Node's children. It is up to implementors or Node to override normalize() to take action.

Overrides:

normalize in class NodeImpl

setReadOnly

public void setReadOnly(boolean readOnly,
                        boolean deep)

Override default behavior so that if deep is true, children are also toggled.

Overrides:

setReadOnly in class NodeImpl

See Also:

Note: this will not change the state of an EntityReference or its children, which are always read-only.

synchronizeChildren

protected void synchronizeChildren()

Override this method in subclass to hook in efficient internal data structure.